Back to index

lightning-sunbird  0.9+nobinonly
Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes
nsProfileSharingSetup Class Reference

#include <nsProfileSharingSetup.h>

Inheritance diagram for nsProfileSharingSetup:
Inheritance graph
Collaboration diagram for nsProfileSharingSetup:
Collaboration graph

List of all members.

Public Member Functions

 nsProfileSharingSetup ()
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

Protected Member Functions

virtual ~nsProfileSharingSetup ()

Protected Attributes

PRPackedBool mSharingGloballyEnabled
nsString mClientName

Detailed Description

Definition at line 57 of file nsProfileSharingSetup.h.

Constructor & Destructor Documentation

Definition at line 45 of file nsProfileSharingSetup.cpp.

Definition at line 50 of file nsProfileSharingSetup.cpp.


Member Function Documentation

void nsIProfileSharingSetup::enableSharing ( in AString  aClientName) [inherited]

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

readonly attribute AString nsIProfileSharingSetup::clientName [inherited]

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.

Definition at line 70 of file nsProfileSharingSetup.h.

Definition at line 69 of file nsProfileSharingSetup.h.

The documentation for this class was generated from the following files: