Interface: IInternalApi

Properties

queuePointer?

readonlyoptionalqueuePointer: IQueuePointer

Gets the internal queue pointer used for preloading, can be used to get the queue

Methods

loadQueuePointer()

loadQueuePointer(startTime, documentId, reviewMode?): Promise<void>

Sets the internal queue pointer as the current queue pointer for the main collection. It also cleans up the old queue.

Parameters

• startTime: number

The start time of the navigation to the Review Interface

• documentId: number

The document to load in the Review Inteface

• reviewMode?: ReviewMode

the mode to start the coding card in

Returns

Promise<void>

A promise that resolves when the document has been shown to the user

---

prepareQueue()

prepareQueue(name, items, viewerType?): Promise<void>

Sets an internal queue/queue pointer for preloading.

Parameters

• name: string

The name of the Queue that is displayed to the user

• items: (number | IQueueItem)[]

The items to add to the queue

• viewerType?: string

the initial viewer type of the queue. if not passed in, it uses viewer type from existing queue piinter.

Returns

Promise<void>

A promise that resolves when the queue had been created, activated and preloaded.