Interface nsIToolkitProfileType

A interface representing a profile.

Note

THIS INTERFACE SHOULD BE IMPLEMENTED BY THE TOOLKIT CODE ONLY! DON'T EVEN THINK ABOUT IMPLEMENTING THIS IN JAVASCRIPT!

Hierarchy

Properties

localDir name rootDir

Methods

AddRef QueryInterface Release lock remove removeInBackground

Properties

Readonly localDir

localDir: nsIFile

The location of the profile local directory, which may be the same as the root directory. See nsIProfileLock::localDirectory.

name

name: string

The name of the profile.

Readonly rootDir

rootDir: nsIFile

The location of the profile directory.

Methods

AddRef

  • Increases the reference count for this interface. The associated instance will not be deleted unless the reference count is returned to zero.

    Returns

    The resulting reference count.

    Returns number

QueryInterface

  • Parameters

    • aIID: object
    • Optional aInstancePtr: object

    Returns any

  • A run time mechanism for interface discovery.

    Returns

    NS_OK if the interface is supported by the associated instance, NS_NOINTERFACE if it is not.

    aInstancePtr must not be null.

    Parameters

    • aIID: object

      [in] A requested interface IID

    • aInstancePtr: object

      [out] A pointer to an interface pointer to receive the result.

    Returns void

Release

  • Decreases the reference count for this interface. Generally, if the reference count returns to zero, the associated instance is deleted.

    Returns

    The resulting reference count.

    Returns number

lock

  • Lock this profile using platform-specific locking methods.

    Returns

    An interface which holds a profile lock as long as you reference it.

    Throws

    NS_ERROR_FILE_ACCESS_DENIED if the profile was already locked.

    Parameters

    • aUnlocker: nsIProfileUnlocker

    Returns nsIProfileLock

remove

  • Removes the profile from the registry of profiles.

    Parameters

    • removeFiles: boolean

      Indicates whether or not the profile directory should be removed in addition.

    Returns void

removeInBackground

  • Removes the profile from the registry of profiles. The profile directory is removed in the stream transport thread.

    Parameters

    • removeFiles: boolean

      Indicates whether or not the profile directory should be removed in addition.

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc