Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IQueue

Service for managing a set of IQueueItems to work with

Hierarchy

Index

Properties

Methods

Properties

customData

customData: ICustomData

Custom Data used for adding context to the queue

id

id: string

ID

length

length: number

Number of IQueueItems in the queue

name

name: string

Name displayed to users

pointers

pointers: IQueuePointer[]

Queue pointers that belong to this queue

Methods

addItemAtEnd

addItemAtIndex

  • addItemAtIndex(item: IQueueItem, index: number): 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

  • Adds an array of IQueueItems to the end of the queue

    Parameters

    Returns void

addItemsAtIndex

  • addItemsAtIndex(items: IQueueItem[], index: number): 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?: number, type?: ViewerType, productionArtifactId?: number, longTextArtifactId?: number, ...rest: any[]): IQueuePointer

  • Creates a new IQueuePointer for the queue

    Parameters

    • Optional index: number
    • Optional type: ViewerType
    • Optional productionArtifactId: number
    • Optional longTextArtifactId: number
    • Rest ...rest: any[]

    Returns IQueuePointer

    Newly created queue pointer

deleteItemAtIndex

  • deleteItemAtIndex(index: number): boolean

  • Deletes a single IQueueItem from the queue

    Parameters

    • index: number

      Index of the item to delete

    Returns boolean

deleteItemsAtIndex

  • deleteItemsAtIndex(index: number, count: number): 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): 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

  • 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: number, count: number): 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

  • Retrieves the queue item identifiers for all objects in the queue

    Returns IQueueItemIdentifier[]

    Array of queue item identifiers

getQueueItemIndex

  • getQueueItemIndex(queueItem: IQueueItem): number

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

    Parameters

    Returns number

    Index of the queue item

moveItemToIndex

  • moveItemToIndex(fromIndex: number, toIndex: number): 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

moveItemsToIndex

  • moveItemsToIndex(fromIndex: number, toIndex: number, count: number): 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

off

  • Unregisters an event handler

    Parameters

    • eventType: QueueEventType

      Event to unregister from

    • Optional handler: EventHandler

      Event handler function. If not passed in, it removes all event handlers.

    • Optional once: boolean

      Boolean indicating if the event handler was registered as a one-time event handler (Defaults to false)

    Returns void

on

once

setCustomData

  • setCustomData(key: string, val: CustomData, ...rest: any[]): void

  • Sets the custom data key, value pair

    memberof

    IQueue

    Parameters

    • key: string

      Entry identifier

    • val: CustomData

      Entry value

    • Rest ...rest: any[]

    Returns void