Packagelc.core
Interfacepublic interface IPreferencesManager

The IPreferencesManagerinterface is implemented to determine the various preferences properties that the user has set.

Implement the IPreferencesManager interface to retrieve a list of preferences that a user can set or change.



Public Properties
 PropertyDefined By
  preferences : Object
[read-only] The preferences for this user.
IPreferencesManager
  preferencesCommitRequired : Boolean
[read-only] A flag that indicates whether outstanding preference changes exist that need to be committed.
IPreferencesManager
Public Methods
 MethodDefined By
  
Commits any preference changes that have been made.
IPreferencesManager
Property Detail
preferencesproperty
preferences:Object  [read-only]

The preferences for this user. Properties that start with "/" are system properties and cannot be modified; properties that do not start with "/" are user properties and can be modified.

Although this property is read-only, it is possible to modify the object, and changes will automatically be written back to the LiveCycle ES server when the preferencesCommit() method is called.


Implementation
    public function get preferences():Object
preferencesCommitRequiredproperty 
preferencesCommitRequired:Boolean  [read-only]

A flag that indicates whether outstanding preference changes exist that need to be committed. A value of true indicates that a commit is required.


Implementation
    public function get preferencesCommitRequired():Boolean
Method Detail
preferencesCommit()method
public function preferencesCommit():Token

Commits any preference changes that have been made.

Returns
Token — A token used to set result and fault handlers to be called when the operation has completed.




 

Send me an e-mail when comments are added to this page | Comment Report

Current page: http://livedocs.adobe.com/livecycle/es/sdkHelp/common/langref/lc/core/IPreferencesManager.html