Interface: IQueue

Service for managing a set of IQueueItems to work with

Extends

• IEventEmitter<QueueEventType>

Properties

customData

readonlycustomData: ICustomData

Custom Data used for adding context to the queue

---

id

readonlyid: string

ID

---

length

readonlylength: number

Number of IQueueItems in the queue

---

name

name: string

Name displayed to users

---

pointers

readonlypointers: IQueuePointer[]

Queue pointers that belong to this queue

Methods

addItemAtEnd()

addItemAtEnd(item): void

Adds an IQueueItem to the end of the queue

Parameters

• item: IQueueItem

Item to add to the queue

Returns

void

---

addItemAtIndex()

addItemAtIndex(item, index): void

Adds an IQueueItem to the queue at the specified index

Parameters

• item: IQueueItem

Item to add to the queue

• index: number

Index to add the item at

Returns

void

---

addItemsAtEnd()

addItemsAtEnd(items): void

Adds an array of IQueueItems to the end of the queue

Parameters

• items: IQueueItem[]

Items to add to the queue

Returns

void

---

addItemsAtIndex()

addItemsAtIndex(items, index): void

Adds an array of IQueueItems to the queue at the specified index

Parameters

• items: IQueueItem[]

Items to add to the queue

• index: number

Index to add the items at

Returns

void

---

createPointer()

createPointer(index?, type?, productionArtifactId?, longTextArtifactId?, productionType?, ...rest?): IQueuePointer

Creates a new IQueuePointer for the queue

Parameters

• index?: number

Initial index for the pointer

• type?: string

Initial viewer type for the pointer

• productionArtifactId?: number

Initial Production Set artifact ID for the pointer

• longTextArtifactId?: number

Initial Long Text Field artifact ID for the pointer

• productionType?: ProductionType

The type of production for the document data

• ...rest?: any[]

Returns

IQueuePointer

Newly created queue pointer

---

deleteItemAtIndex()

deleteItemAtIndex(index): boolean

Deletes a single IQueueItem from the queue

Parameters

• index: number

Index of the item to delete

Returns

boolean

---

deleteItemsAtIndex()

deleteItemsAtIndex(index, count): boolean

Deletes IQueueItems from queue starting at specified index

Parameters

• index: number

Index to start deleting items

• count: number

Number of items to delete

Returns

boolean

---

getDocumentIds()

getDocumentIds(): number[]

Retrieves the document IDs for all objects in the queue.

Returns

number[]

Array of document IDs

---

getDocumentItemIndex()

getDocumentItemIndex(documentId): number

Retrieves the index of the IDocumentItem with the specified artifact id

Parameters

• documentId: number

Artifact id of the document

Returns

number

Index of the document item

---

getItem()

getItem(index): IQueueItem

Retrieves the IQueueItem at the specified index

Parameters

• index: number

Index to get item at

Returns

IQueueItem

Item at the specified index

---

getItems()

getItems(index, count): IQueueItem[]

Retrieves a specified number of IQueueItems at the specified index

If the number of available items is less than the specified count, only the available items will be returned

Parameters

• index: number

Index to begin getting items at

• count: number

Maximum number of items to retrieve

Returns

IQueueItem[]

Array of queue items

---

getQueueItemIdentifiers()

getQueueItemIdentifiers(): IQueueItemIdentifier[]

Retrieves the queue item identifiers for all objects in the queue

Returns

IQueueItemIdentifier[]

Array of queue item identifiers

---

getQueueItemIndex()

getQueueItemIndex(queueItem): number

Retrieves the index of the specified IQueueItem, or -1 if not found

Parameters

• queueItem: IQueueItem

Queue item

Returns

number

Index of the queue item

---

itemsEquivalent()

itemsEquivalent(other): boolean

Returns true if the items in each queue have the same ids in the same order

Parameters

• other: IQueue

IQueue to compare against

Returns

boolean

---

moveItemsToIndex()

moveItemsToIndex(fromIndex, toIndex, count): boolean

Moves IQueueItems to a new index in the queue

Parameters

• fromIndex: number

Starting index of items to move

• toIndex: number

Target index of items to move

• count: number

Number of items to move

Returns

boolean

---

moveItemToIndex()

moveItemToIndex(fromIndex, toIndex): boolean

Moves a single IQueueItem to a new index in the queue

Parameters

• fromIndex: number

Index that item is currently

• toIndex: number

Target index

Returns

boolean

---

off()

off(eventType, handler?, once?): void

Unregisters an event handler

Parameters

• eventType: QueueEventType

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

IEventEmitter.off

---

on()

on(eventType, handler): void

Registers an event handler

Parameters

• eventType: QueueEventType

Event to listen for

• handler: EventHandler

Event handler function

Returns

void

Inherited from

IEventEmitter.on

---

once()

once(eventType, handler): void

Registers an event handler that is only run once

Parameters

• eventType: QueueEventType

Event to listen for

• handler: EventHandler

Event handler function

Returns

void

Inherited from

IEventEmitter.once

---

setCustomData()

setCustomData(key, val, ...rest): void

Sets the custom data key, value pair

Parameters

• key: string

Entry identifier

• val: CustomData

Entry value IQueue

• ...rest: any[]

Returns

void