lc.procmgmt

# IQueueManager - AS3 ADEP Workspace

Package | lc.procmgmt
Interface | public interface IQueueManager extends IManager , IEventDispatcher

Language Version: | ActionScript 3.0

Product Version: | Adobe Digital Enterprise Platform Document Services - Workspace 9

Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10

The `IQueueManager` interface is implemented to manage `Queue` objects. `Queue` objects are used to organize tasks in Workspace. Examples of queues in Workspace 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.

Related API Elements

lc.procmgmt.domain.Queue

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined By
--- | --- | ---
|  | faultHandler : Function The default fault handler function. | IManager

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event. | IEventDispatcher
|  | dispatchEvent(event:Event):Boolean Dispatches an event into the event flow. | IEventDispatcher
|  | getGrantedUsersForDefaultQueue():lc.foundation.util:CollectionToken Retrieves a list of users that have been granted access to the current user's queue. | IQueueManager
|  | getOwnersForAccessibleUserQueues():lc.foundation.util:CollectionToken Retrieves a list of users that own a queue to which the current user has access. | IQueueManager
|  | getQueues():lc.foundation.util:CollectionToken Returns the collection of queues which the user has access to. | IQueueManager
|  | grantDefaultQueueAccess(userToGrantOid:String, queueOwnerUserOid:String = null):lc.foundation.util:Token Grants a user access to the current user's default queue. | IQueueManager
|  | handleEvent(token:lc.foundation.util:Token, event:LiveCycleEvent):void Determines whether the default operation is prevented. | IManager
|  | handleFault(token:lc.foundation.util:Token, event:LiveCycleFaultEvent):void Determines whether the default operation is prevented. | IManager
|  | hasEventListener(type:String):Boolean Checks whether the EventDispatcher object has any listeners registered for a specific type of event. | IEventDispatcher
|  | removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Removes a listener from the EventDispatcher object. | IEventDispatcher
|  | requestDefaultQueueAccess(queueOwnerUserOid:String):lc.foundation.util:Token Initiates a process to request access to another user's queue. | IQueueManager
|  | revokeDefaultQueueAccess(userToRevokeOid:String, queueOwnerUserOid:String = null):lc.foundation.util:Token Revokes a user's access to the current user's default queue. | IQueueManager
|  | willTrigger(type:String):Boolean Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type. | IEventDispatcher

Method Detail

### getGrantedUsersForDefaultQueue

()
method

`public function getGrantedUsersForDefaultQueue():lc.foundation.util:CollectionToken`

Language Version: | ActionScript 3.0

Product Version: | Adobe Digital Enterprise Platform Document Services - Workspace 9

Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10

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

Returns

| `lc.foundation.util: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():lc.foundation.util:CollectionToken`

Language Version: | ActionScript 3.0

Product Version: | Adobe Digital Enterprise Platform Document Services - Workspace 9

Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10

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

Returns

| `lc.foundation.util: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():lc.foundation.util:CollectionToken`

Language Version: | ActionScript 3.0

Product Version: | Adobe Digital Enterprise Platform Document Services - Workspace 9

Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10

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

Returns

| `lc.foundation.util: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):lc.foundation.util:Token`

Language Version: | ActionScript 3.0

Product Version: | Adobe Digital Enterprise Platform Document Services - Workspace 9

Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10

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

| `lc.foundation.util: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):lc.foundation.util:Token`

Language Version: | ActionScript 3.0

Product Version: | Adobe Digital Enterprise Platform Document Services - Workspace 9

Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10

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

| `lc.foundation.util: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):lc.foundation.util:Token`

Language Version: | ActionScript 3.0

Product Version: | Adobe Digital Enterprise Platform Document Services - Workspace 9

Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10

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

| `lc.foundation.util:Token` — A token used to set result and fault handlers to be called when the operation has completed.

© 2015 Adobe Systems Incorporated. All rights reserved.
Mon Apr 10 2017, 12:28 PM -07:00