TargetNavigatorProvider

TargetNavigatorProvider High-level API for providing a target navigator server implementation.

​

Constructors

​

new TargetNavigatorProvider()

new TargetNavigatorProvider(): TargetNavigatorProvider

​

Returns

TargetNavigatorProvider

​

Methods

​

registerTargetNavigatorHandler()

static registerTargetNavigatorHandler(handler: TargetNavigatorHandler, componentInstance: IComponentInstance): void

Register a handler for target navigator callbacks. While this can be called for multiple components, only the component specified in the application manifest will receive requests.

​

Parameters

handler

TargetNavigatorHandler The object implementing target navigator callbacks.

componentInstance

IComponentInstance The component instance object received from the onStart callback.

---

​

updateAvailableTargets()

static updateAvailableTargets(availableTargets: TargetInfo[]): void

Update the available targets for this server.

​

Parameters

availableTargets

TargetInfo[] A list of targets that are now available for navigation. This list must not contain more than 256 elements. Note: Providers should call this upon startup and whenever the list of available targets changes.

​

Throws

• Error if availableTargets contains more than 256 elements.

---

​

updateCurrentTarget()

static updateCurrentTarget(currentTarget?: TargetInfo | undefined): void

Update the current target for this server.

​

Parameters

currentTarget?

TargetInfo | undefined Optional info for the new current target. This can be set to null to indicate that there is not a current target which could be navigated to using the target navigator interface. Note: Providers should call this upon startup and whenever the current target changes.