Packagelc.core
Interfacepublic interface IQueueManager

The IQueueManager interface is implemented to manage Queue objects. Queue objects are used to organize tasks in LiveCycle Workspace ES. Examples of queues in Workspace ES are group queues, draft queues, and user queues, each containing tasks specific to that group.

Implement the IQueueManager interface to get queues and to manage queue access.

See also

lc.domain.Queue


Public Methods
 MethodDefined By
  
Retrieves a list of users that have been granted access to the current user's queue.
IQueueManager
  
Retrieves a list of users that own a queue to which the current user has access.
IQueueManager
  
Returns the collection of queues which the user has access to.
IQueueManager
  
grantDefaultQueueAccess(userToGrantOid:String, queueOwnerUserOid:String = null):Token
Grants a user access to the current user's default queue.
IQueueManager
  
Initiates a process to request access to another user's queue.
IQueueManager
  
revokeDefaultQueueAccess(userToRevokeOid:String, queueOwnerUserOid:String = null):Token
Revokes a user's access to the current user's default queue.
IQueueManager
Method Detail
getGrantedUsersForDefaultQueue()method
public function getGrantedUsersForDefaultQueue():CollectionToken

Retrieves a list of users that have been granted access to the current user's queue.

Returns
CollectionToken — A token containing a collection of User objects when the request completes. It is possible to set result and fault handlers on the token to be called when the invocation is complete and the collection is fully populated.
getOwnersForAccessibleUserQueues()method 
public function getOwnersForAccessibleUserQueues():CollectionToken

Retrieves a list of users that own a queue to which the current user has access.

Returns
CollectionToken — A token containing a collection of User objects when the request completes. It is possible to set result and fault handlers on the token to be called when the invocation is complete and the collection is fully populated.
getQueues()method 
public function getQueues():CollectionToken

Returns the collection of queues which the user has access to.

Returns
CollectionToken — A collection of tokens representing Queue objects when the request completes. You can set result and fault handlers on the token to be called when the invocation is complete and the collection is fully populated.
grantDefaultQueueAccess()method 
public function grantDefaultQueueAccess(userToGrantOid:String, queueOwnerUserOid:String = null):Token

Grants a user access to the current user's default queue.

Parameters

userToGrantOid:String — Specifies the user that will be granted access. The default value is null.
 
queueOwnerUserOid:String (default = null) — Specifies the owner or the default queue.

Returns
Token — A token used to set result and fault handlers to be called when the operation has completed.
requestDefaultQueueAccess()method 
public function requestDefaultQueueAccess(queueOwnerUserOid:String):Token

Initiates a process to request access to another user's queue.

Parameters

queueOwnerUserOid:String — Specifies the owner of the queue being requested for access.

Returns
Token — A token used to set result and fault handlers to be called when the operation has completed.
revokeDefaultQueueAccess()method 
public function revokeDefaultQueueAccess(userToRevokeOid:String, queueOwnerUserOid:String = null):Token

Revokes a user's access to the current user's default queue.

Parameters

userToRevokeOid:String — Specifies the user that access revoked.
 
queueOwnerUserOid:String (default = null) — Specifies the owner of the default queue.

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/IQueueManager.html