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.

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

mercurial