Interface: IViewerService

Entity for managing IViewerCollections

Extends

• IEventEmitter<ViewerServiceEventType>

Properties

count

readonlycount: number

Number of existing IViewerCollections

---

isQueuePrimed

isQueuePrimed: boolean

Whether the queue has been fully primed and is ready to display. False during the window between app bootstrap (empty queue) and loadQueuePointer() completing.

---

mainCollection

mainCollection: IViewerCollection

The main viewer collection

This is the viewer collection that occupies the main slot in the UI. When the Review Interface is bootstrapped, this is the first collection created.

Methods

get()

get(id): IViewerCollection

Retrieves a viewer collection by ID

Parameters

• id: string

Collection ID

Returns

IViewerCollection

Viewer collection with the given ID

---

off()

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

Unregisters an event handler

Parameters

• eventType: ViewerServiceEventType

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: ViewerServiceEventType

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: ViewerServiceEventType

Event to listen for

• handler: EventHandler

Event handler function

Returns

void

Inherited from

IEventEmitter.once

---

remove()

remove(id): boolean

Removes a viewer collection

Parameters

• id: string

Collection ID

Returns

boolean

Boolean indicating whether or not the collection was removed

---

schedulePrimingFallback()

schedulePrimingFallback(delayMs): void

Schedules a fallback that un-gates the toolbar count if the queue is populated but loadQueuePointer() never un-gated it. Only un-gates when the queue actually has items.

Parameters

• delayMs: number

Delay in milliseconds before the fallback fires

Returns

void