browser/components/migration/public/nsIBrowserProfileMigrator.idl@8bccb770b82d (annotated)
browser/components/migration/public/nsIBrowserProfileMigrator.idl
Wed, 31 Dec 2014 13:27:57 +0100
- author
- Michael Schloh von Bennewitz <michael@schloh.com>
- date
- Wed, 31 Dec 2014 13:27:57 +0100
- branch
- TOR_BUG_3246
- changeset 6
- 8bccb770b82d
- permissions
- -rw-r--r--
Ignore runtime configuration files generated during quality assurance.
| michael@0 | 1 | /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */ |
| michael@0 | 2 | /* This Source Code Form is subject to the terms of the Mozilla Public |
| michael@0 | 3 | * License, v. 2.0. If a copy of the MPL was not distributed with this |
| michael@0 | 4 | * file, You can obtain one at http://mozilla.org/MPL/2.0/. */ |
| michael@0 | 5 | |
| michael@0 | 6 | #include "nsISupports.idl" |
| michael@0 | 7 | |
| michael@0 | 8 | interface nsIArray; |
| michael@0 | 9 | interface nsIProfileStartup; |
| michael@0 | 10 | |
| michael@0 | 11 | [scriptable, uuid(44993E0E-74E8-4BEC-9D66-AD8156E0A274)] |
| michael@0 | 12 | interface nsIBrowserProfileMigrator : nsISupports |
| michael@0 | 13 | { |
| michael@0 | 14 | /** |
| michael@0 | 15 | * profile items to migrate. use with migrate(). |
| michael@0 | 16 | */ |
| michael@0 | 17 | const unsigned short ALL = 0x0000; |
| michael@0 | 18 | const unsigned short SETTINGS = 0x0001; |
| michael@0 | 19 | const unsigned short COOKIES = 0x0002; |
| michael@0 | 20 | const unsigned short HISTORY = 0x0004; |
| michael@0 | 21 | const unsigned short FORMDATA = 0x0008; |
| michael@0 | 22 | const unsigned short PASSWORDS = 0x0010; |
| michael@0 | 23 | const unsigned short BOOKMARKS = 0x0020; |
| michael@0 | 24 | const unsigned short OTHERDATA = 0x0040; |
| michael@0 | 25 | const unsigned short SESSION = 0x0080; |
| michael@0 | 26 | |
| michael@0 | 27 | /** |
| michael@0 | 28 | * Copy user profile information to the current active profile. |
| michael@0 | 29 | * @param aItems list of data items to migrate. see above for values. |
| michael@0 | 30 | * @param aStartup helper interface which is non-null if called during startup. |
| michael@0 | 31 | * @param aProfile profile to migrate from, if there is more than one. |
| michael@0 | 32 | */ |
| michael@0 | 33 | void migrate(in unsigned short aItems, in nsIProfileStartup aStartup, in wstring aProfile); |
| michael@0 | 34 | |
| michael@0 | 35 | /** |
| michael@0 | 36 | * A bit field containing profile items that this migrator |
| michael@0 | 37 | * offers for import. |
| michael@0 | 38 | * @param aProfile the profile that we are looking for available data |
| michael@0 | 39 | * to import |
| michael@0 | 40 | * @param aDoingStartup "true" if the profile is not currently being used. |
| michael@0 | 41 | * @return bit field containing profile items (see above) |
| michael@0 | 42 | * @note a return value of 0 represents no items rather than ALL. |
| michael@0 | 43 | */ |
| michael@0 | 44 | unsigned short getMigrateData(in wstring aProfile, in boolean aDoingStartup); |
| michael@0 | 45 | |
| michael@0 | 46 | /** |
| michael@0 | 47 | * Whether or not there is any data that can be imported from this |
| michael@0 | 48 | * browser (i.e. whether or not it is installed, and there exists |
| michael@0 | 49 | * a user profile) |
| michael@0 | 50 | */ |
| michael@0 | 51 | readonly attribute boolean sourceExists; |
| michael@0 | 52 | |
| michael@0 | 53 | |
| michael@0 | 54 | /** |
| michael@0 | 55 | * An enumeration of available profiles. If the import source does |
| michael@0 | 56 | * not support profiles, this attribute is null. |
| michael@0 | 57 | */ |
| michael@0 | 58 | readonly attribute jsval sourceProfiles; |
| michael@0 | 59 | |
| michael@0 | 60 | /** |
| michael@0 | 61 | * The import source homepage. Returns null if not present/available |
| michael@0 | 62 | */ |
| michael@0 | 63 | readonly attribute AUTF8String sourceHomePageURL; |
| michael@0 | 64 | }; |
