Feedback
Interface: IQueueService
Service for managing IQueues
Extends
Properties
queues
readonlyqueues:IQueue[]
Available queues
Methods
createDocumentItem()
createDocumentItem(
artifactId):IDocumentItem
Creates a new Document queue item
Parameters
• artifactId: number
Document artifact ID
Returns
Newly created Document queue item
createQueue()
createQueue(
name,items?, ...rest?):IQueue
Creates a new IQueue
Parameters
• name: string
The name of the Queue that is displayed to the user
• items?: (number | IQueueItem)[]
Items in the queue
• ...rest?: any[]
Returns
Newly created queue
createRdoFileItem()
createRdoFileItem(
fileFieldArtifactId,fileId):IRDOFileItem
Creates a new RDO file queue item
Parameters
• fileFieldArtifactId: number
Artifact ID of the file field on the Relativity Object Type
• fileId: number
File ID of the file uploaded to the field
Returns
Newly created RDO File queue item
deleteQueue()
deleteQueue(
id):boolean
Deletes an IQueue
Parameters
• id: string
ID of the queue to delete
Returns
boolean
Boolean indicating if the queue was successfully deleted
getQueueById()
getQueueById(
id):IQueue
Retrieves an IQueue by ID
Parameters
• id: string
ID of the queue to retrieve
Returns
Queue with the given ID
off()
off(
eventType,handler?,once?):void
Unregisters an event handler
Parameters
• eventType: QueueServiceEventType
Event to unregister from
• handler?: EventHandler
Event handler function. If not passed in, it removes all event handlers.
• once?: boolean
Boolean indicating if the event handler was registered as a one-time event handler (Defaults to false)
Returns
void
Inherited from
on()
on(
eventType,handler):void
Registers an event handler
Parameters
• eventType: QueueServiceEventType
Event to listen for
• handler: EventHandler
Event handler function
Returns
void
Inherited from
once()
once(
eventType,handler):void
Registers an event handler that is only run once
Parameters
• eventType: QueueServiceEventType
Event to listen for
• handler: EventHandler
Event handler function
Returns
void
