Back to index

lightning-sunbird  0.9+nobinonly
Public Member Functions | Public Attributes
nsIProfileSharingSetup Interface Reference

import "nsIProfileSharingSetup.idl";

Inheritance diagram for nsIProfileSharingSetup:
Inheritance graph
Collaboration diagram for nsIProfileSharingSetup:
Collaboration graph

List of all members.

Public Member Functions

void enableSharing (in AString aClientName)
 enableSharing must be called by the application in order to use profile sharing.

Public Attributes

readonly attribute boolean isSharingEnabled
 sharingEnabled and clientName
readonly attribute AString clientName

Detailed Description

Definition at line 41 of file nsIProfileSharingSetup.idl.

Member Function Documentation

void nsIProfileSharingSetup::enableSharing ( in AString  aClientName)

enableSharing must be called by the application in order to use profile sharing.

It should be called as early as possible in the startup sequence - before any use of profile data. If enabled, sharing is enabled for all modules that support it.

aClientNameA non-versioned identifier of the current application within the suite of applications which share this profile. It is used to separate the client's non-shared data from shared data within the profile directory. Example: "browser" or "mail" - not "ProductX 1.3b5"

Member Data Documentation

Definition at line 64 of file nsIProfileSharingSetup.idl.

sharingEnabled and clientName

Attributes to be used by sharing-enabled components

Definition at line 63 of file nsIProfileSharingSetup.idl.

The documentation for this interface was generated from the following file: