Class com.gContactSync.Preferences
Defined in: Preferences.js.
Constructor Attributes | Constructor Name and Description |
---|---|
Stores information on Preferences related to gContactSync.
|
Field Attributes | Field Name and Description |
---|---|
<static> |
com.gContactSync.Preferences.mExtendedProperties
An array of the extended properties to use with Google contacts
|
<static> |
com.gContactSync.Preferences.mRegistered
Stores whether the preference observer has been registered
|
<static> |
com.gContactSync.Preferences.mService
The preferences service
|
<static> |
com.gContactSync.Preferences.mSyncBranch
The Preferences branch used by gContactSync
|
<static> |
com.gContactSync.Preferences.mSyncPrefs
Preferences related to gContactSync
verboseLog is first since it is used when logging preferences
|
<static> |
com.gContactSync.Preferences.mTypes
Different types of preferences (bool, int, and char)
|
Method Attributes | Method Name and Description |
---|---|
<static> |
com.gContactSync.Preferences.getPref(aBranch, aName, aType)
Gets a preference given its branch, name, and type
|
<static> |
com.gContactSync.Preferences.getSyncPrefs()
Tries to get each preference in mSyncPrefs and creates the preference and
sets its default value if it is not present.
|
<static> |
com.gContactSync.Preferences.observe(aSubject, aTopic, aData)
Called when a preference changes on the extensions.gContactSync.
|
<static> |
com.gContactSync.Preferences.register()
Registers the pref observer and gets the initial preference values.
|
<static> |
com.gContactSync.Preferences.setPref(aBranch, aName, aType, aValue)
Sets a preference given its branch, name, type and value.
|
<static> |
com.gContactSync.Preferences.setSyncPref(aPrefName, aValue)
A convienient method of saving a sync preference.
|
<static> |
com.gContactSync.Preferences.unregister()
Unregisters the pref observer.
|
Class Detail
com.gContactSync.Preferences()
Stores information on Preferences related to gContactSync.
Field Detail
<static>
com.gContactSync.Preferences.mExtendedProperties
An array of the extended properties to use with Google contacts
<static>
com.gContactSync.Preferences.mRegistered
Stores whether the preference observer has been registered
<static>
com.gContactSync.Preferences.mService
The preferences service
<static>
com.gContactSync.Preferences.mSyncBranch
The Preferences branch used by gContactSync
<static>
com.gContactSync.Preferences.mSyncPrefs
Preferences related to gContactSync
verboseLog is first since it is used when logging preferences
<static>
com.gContactSync.Preferences.mTypes
Different types of preferences (bool, int, and char)
Method Detail
<static>
com.gContactSync.Preferences.getPref(aBranch, aName, aType)
Gets a preference given its branch, name, and type
- Parameters:
- aBranch
- {nsIPrefBranch} The branch where the preference is stored.
- aName
- {string} The name of the preference
- aType
- {string} The type of preference. Must be in Preferences.mTypes.
<static>
com.gContactSync.Preferences.getSyncPrefs()
Tries to get each preference in mSyncPrefs and creates the preference and
sets its default value if it is not present.
<static>
com.gContactSync.Preferences.observe(aSubject, aTopic, aData)
Called when a preference changes on the extensions.gContactSync. branch.
- Parameters:
- aSubject
- {nsIPrefBranch} The branch.
- aTopic
- {string} A description of what happened.
- aData
- {string} The name of the pref that was changed.
<static>
com.gContactSync.Preferences.register()
Registers the pref observer and gets the initial preference values.
<static>
com.gContactSync.Preferences.setPref(aBranch, aName, aType, aValue)
Sets a preference given its branch, name, type and value.
- Parameters:
- aBranch
- {nsIBranch} The branch where the preference is stored.
- aName
- {string} The name of the preference.
- aType
- {string} The type of preference. Must be in Preferences.mTypes.
- aValue
- {string} The value to set the preference.
<static>
com.gContactSync.Preferences.setSyncPref(aPrefName, aValue)
A convienient method of saving a sync preference.
- Parameters:
- aPrefName
- {string} The preference on the gContactSync branch to save.
- aValue
- {string} The new value for the given preference.
<static>
com.gContactSync.Preferences.unregister()
Unregisters the pref observer.