Interface: IQueuePointer
Class for managing a position in an IQueue
This entity is used by IViewerCollections, IViewerCardInstances, and other entities to determine when to navigate and which IQueueItem is active
Extends
Properties
activationStatus
readonly
activationStatus: QueuePointerActivationStatus
Whether the pointer has been activated yet
The pointer must be activated before it can be used by other components.
id
readonly
id: string
ID
index
readonly
index: number
Current position in the queue
The queue is 0-indexed.
item
readonly
item: IQueueItem
Current queue item
This is based on the items in the queue and the index
longTextArtifactId
readonly
longTextArtifactId: number
Current long text field artifact ID
productionArtifactId
readonly
productionArtifactId: number
Current production artifact ID
productionType
readonly
productionType: ProductionType
Current production type
queue
readonly
queue: IQueue
Queue the pointer belongs to
type
readonly
type: string
Current viewer type
Methods
activate()
activate(...rest
): Promise
<void
>
Activates the queue pointer
This is required to initialize data on the queue pointer.
Parameters
• ...rest: any
[]
Returns
Promise
<void
>
Promise that resolves when activation is complete
copy()
copy(): IQueuePointer
Create a copy of the pointer
Returns
IQueuePointer
Copy of the current queue pointer
navigate()
navigate(index
, type
, productionArtifactId
?, longTextArtifactId
?, productionType
?, ...rest
?): Promise
<boolean
>
Navigates to a specific index and viewer type in the queue
Parameters
• index: number
Index to navigate to
• type: string
Viewer type to load the item in
• productionArtifactId?: number
Optional - Production Set Artifact ID to load in a production viewer type
• longTextArtifactId?: number
Initial Long Text Field artifact ID for the pointer
• productionType?: ProductionType
The type of production for the document data
• ...rest?: any
[]
Returns
Promise
<boolean
>
Promise that resolves to a boolean indicating if navigation to the requested destination item occurred
navigateBy()
navigateBy(count
, ...rest
): Promise
<boolean
>
Navigates by a specific count
Positive count values will navigate forwards and negative values will navigate backwards.
Parameters
• count: number
Number of positions to move by
• ...rest: any
[]
Returns
Promise
<boolean
>
Promise that resolves to a boolean indicating if navigation to the requested destination item occurred
navigateToFirst()
navigateToFirst(...rest
): Promise
<boolean
>
Navigates to the first IQueueItem in the queue
Parameters
• ...rest: any
[]
Returns
Promise
<boolean
>
Promise that resolves to a boolean indicating if navigation to the requested destination item occurred
navigateToIndex()
navigateToIndex(index
, ...rest
): Promise
<boolean
>
Navigates to a specific index in the queue
Parameters
• index: number
Index to navigate to
• ...rest: any
[]
Returns
Promise
<boolean
>
Promise that resolves to a boolean indicating if navigation to the requested destination item occurred
navigateToLast()
navigateToLast(...rest
): Promise
<boolean
>
Navigates to the last IQueueItem in the queue
Parameters
• ...rest: any
[]
Returns
Promise
<boolean
>
Promise that resolves to a boolean indicating if navigation to the requested destination item occurred
navigateToNext()
navigateToNext(...rest
): Promise
<boolean
>
Navigates to the next IQueueItem in the queue
Parameters
• ...rest: any
[]
Returns
Promise
<boolean
>
Promise that resolves to a boolean indicating if navigation to the requested destination item occurred
navigateToPrevious()
navigateToPrevious(...rest
): Promise
<boolean
>
Navigates to the previous IQueueItem in the queue
Parameters
• ...rest: any
[]
Returns
Promise
<boolean
>
Promise that resolves to a boolean indicating if navigation to the requested destination item occurred
off()
off(eventType
, handler
?, once
?): void
Unregisters an event handler
Parameters
• eventType: QueuePointerEventType
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: QueuePointerEventType
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: QueuePointerEventType
Event to listen for
• handler: EventHandler
Event handler function
Returns
void
Inherited from
IEventEmitter
.once
requestUpdate()
requestUpdate(changePointer
?, ...rest
?): boolean
Submits a request seeking approval for navigation
Parameters
• changePointer?: boolean
Optional - Specifies a request to switch to a new pointer
• ...rest?: any
[]
Returns
boolean
Boolean indicating if navigation was approved
IQueuePointer
switchViewer()
switchViewer(type
, productionArtifactId
?, longTextFieldArtifactId
?, productionType
?, ...rest
?): Promise
<boolean
>
Changes the viewer type being used to view a given IQueueItem
Parameters
• type: string
Viewer type to switch to
• productionArtifactId?: number
Optional - Production Set Artifact ID to load in a production viewer type
• longTextFieldArtifactId?: number
Optional - Long Text Field Artifact ID to load in a text viewer type
• productionType?: ProductionType
The type of production for the document data
• ...rest?: any
[]
Returns
Promise
<boolean
>
Promise that resolves to a boolean indicating if the navigation occurred