Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IQueuePointer

Class for managing a position in an IQueue

This entity is used by IViewerCollections, {@link IViewerInstance}s, and other entities to determine when to navigate and which IQueueItem is active

Hierarchy

Index

Properties

activationStatus

Whether the pointer has been activated yet

The pointer must be activated before it can be used by other components.

id

id: string

ID

index

index: number

Current position in the queue

The queue is 0-indexed.

item

Current queue item

This is based on the items in the queue and the index

longTextArtifactId

longTextArtifactId: number

Current long text field artifact ID

productionArtifactId

productionArtifactId: number

Current production artifact ID

queue

queue: IQueue

Queue the pointer belongs to

type

Current viewer type

Methods

activate

  • activate(...rest: any[]): Promise<void>
  • Activates the queue pointer

    This is required to initialize data on the queue pointer.

    Parameters

    • Rest ...rest: any[]

    Returns Promise<void>

    Promise that resolves when activation is complete

copy

  • Create a copy of the pointer

    Returns IQueuePointer

    Copy of the current queue pointer

navigate

  • navigate(index: number, type: ViewerType, productionArtifactId?: number, ...rest: any[]): Promise<boolean>
  • Navigates to a specific index and viewer type in the queue

    Parameters

    • index: number

      Index to navigate to

    • type: ViewerType

      Viewer type to load the item in

    • Optional productionArtifactId: number
    • Rest ...rest: any[]

    Returns Promise<boolean>

    Promise that resolves to a boolean indicating if navigation occurred

navigateBy

  • navigateBy(count: number, ...rest: any[]): 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 ...rest: any[]

    Returns Promise<boolean>

    Promise that resolves to a boolean indicating if navigation occurred

navigateToFirst

  • navigateToFirst(...rest: any[]): Promise<boolean>
  • Navigates to the first IQueueItem in the queue

    Parameters

    • Rest ...rest: any[]

    Returns Promise<boolean>

    Promise that resolves to a boolean indicating if navigation occurred

navigateToIndex

  • navigateToIndex(index: number, ...rest: any[]): Promise<boolean>
  • Navigates to a specific index in the queue

    Parameters

    • index: number

      Index to navigate to

    • Rest ...rest: any[]

    Returns Promise<boolean>

    Promise that resolves to a boolean indicating if navigation occurred

navigateToLast

  • navigateToLast(...rest: any[]): Promise<boolean>
  • Navigates to the last IQueueItem in the queue

    Parameters

    • Rest ...rest: any[]

    Returns Promise<boolean>

    Promise that resolves to a boolean indicating if navigation occurred

navigateToNext

  • navigateToNext(...rest: any[]): Promise<boolean>
  • Navigates to the next IQueueItem in the queue

    Parameters

    • Rest ...rest: any[]

    Returns Promise<boolean>

    Promise that resolves to a boolean indicating if navigation occurred

navigateToPrevious

  • navigateToPrevious(...rest: any[]): Promise<boolean>
  • Navigates to the previous IQueueItem in the queue

    Parameters

    • Rest ...rest: any[]

    Returns Promise<boolean>

    Promise that resolves to a boolean indicating if navigation occurred

off

  • Unregisters an event handler

    Parameters

    • eventType: QueuePointerEventType

      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

requestUpdate

  • requestUpdate(changePointer?: boolean, ...rest: any[]): boolean
  • Submits a request seeking approval for navigation

    memberof

    IQueuePointer

    Parameters

    • Optional changePointer: boolean

      Optional - Specifies a request to switch to a new pointer

    • Rest ...rest: any[]

    Returns boolean

    Boolean indicating if navigation was approved

switchViewer

  • switchViewer(type: ViewerType, productionArtifactId?: number, longTextFieldArtifactId?: number, ...rest: any[]): Promise<boolean>
  • Changes the viewer type being used to view a given IQueueItem

    Parameters

    • type: ViewerType

      Viewer type to switch to

    • Optional productionArtifactId: number
    • Optional longTextFieldArtifactId: number
    • Rest ...rest: any[]

    Returns Promise<boolean>

    Promise that resolves to a boolean indicating if the navigation occurred