Class VeronaPlayerApiService

Verona Player Interface Handles communication between player and host application

Index

Constructors

Properties

messageHandlers sessionId debug allowedOrigin targetWindow messageListener

Methods

sendReady sendStateChanged sendUnitNavigationRequest sendRuntimeError sendWidgetCall sendWindowFocusChanged onStartCommand onPageNavigationCommand onNavigationDenied onPlayerConfigChanged onWidgetReturn destroy

Constructors

constructor

new VeronaPlayerApiService(options?): VeronaPlayerApiService
Parameters
- options: VeronaPlayerOptions = {}
Returns VeronaPlayerApiService
- Defined in player/src/services/VeronaPlayerApiService.ts:79

Properties

`Private`messageHandlers

messageHandlers: Map<string, Set<Function>> = ...

`Private`sessionId

sessionId: null | string = null

`Private`debug

debug: boolean

`Private`allowedOrigin

allowedOrigin: string

`Private`targetWindow

targetWindow: Window

`Private`messageListener

messageListener: ((event: MessageEvent<any>) => void)

Methods

sendReady

sendReady(data): void
Send ready notification to host
Parameters
- data: PayloadInterfacesProperties.PlayerSend.ReadyNotification
Returns void
- Defined in player/src/services/VeronaPlayerApiService.ts:102

sendStateChanged

sendStateChanged(unitState?, playerState?, log?): void
Send state changed notification to host
Parameters
- OptionalunitState: MainSchema.UnitState
- OptionalplayerState: MainSchema.PlayerState
- Optionallog: MainSchema.LogEntry[]
Returns void
- Defined in player/src/services/VeronaPlayerApiService.ts:110

sendUnitNavigationRequest

sendUnitNavigationRequest(target): void
Send unit navigation request to host
Parameters
- target: AllowedPropertiesValues.NavigationTarget
Returns void
- Defined in player/src/services/VeronaPlayerApiService.ts:135

sendRuntimeError

sendRuntimeError(code, message?): void
Send runtime error notification to host
Parameters
- code: string
- Optionalmessage: string
Returns void
- Defined in player/src/services/VeronaPlayerApiService.ts:153

sendWidgetCall

sendWidgetCall(widgetType, parameters?, state?, callId?): void
Send widget call to host
Parameters
- widgetType: string
- Optionalparameters: MainSchema.WidgetParameter[]
- Optionalstate: Record<string, string>
- OptionalcallId: string
Returns void
- Defined in player/src/services/VeronaPlayerApiService.ts:172

sendWindowFocusChanged

sendWindowFocusChanged(hasFocus): void
Send window focus changed notification
Parameters
- hasFocus: boolean
Returns void
- Defined in player/src/services/VeronaPlayerApiService.ts:198

onStartCommand

onStartCommand(callback): void
Register handler for start command
Parameters
- callback: ((data: StartCommandData) => void)
  - - (data): void
    - Parameters
      data: StartCommandData
      Returns void
Returns void
- Defined in player/src/services/VeronaPlayerApiService.ts:215

onPageNavigationCommand

onPageNavigationCommand(callback): void
Register handler for page navigation command
Parameters
- callback: ((data: PageNavigationCommandData) => void)
  - - (data): void
    - Parameters
      data: PageNavigationCommandData
      Returns void
Returns void
- Defined in player/src/services/VeronaPlayerApiService.ts:230

onNavigationDenied

onNavigationDenied(callback): void
Register handler for navigation denied notification
Parameters
- callback: ((data: NavigationDeniedNotificationData) => void)
  - - (data): void
    - Parameters
      data: NavigationDeniedNotificationData
      Returns void
Returns void
- Defined in player/src/services/VeronaPlayerApiService.ts:238

onPlayerConfigChanged

onPlayerConfigChanged(callback): void
Register handler for player config changed notification
Parameters
- callback: ((data: PlayerConfigChangedNotificationData) => void)
  - - (data): void
    - Parameters
      data: PlayerConfigChangedNotificationData
      Returns void
Returns void
- Defined in player/src/services/VeronaPlayerApiService.ts:246

onWidgetReturn

onWidgetReturn(callback): void
Register handler for widget return
Parameters
- callback: ((data: WidgetReturnData) => void)
  - - (data): void
    - Parameters
      data: WidgetReturnData
      Returns void
Returns void
- Defined in player/src/services/VeronaPlayerApiService.ts:254

destroy

destroy(): void
Optional: Clean up resources and remove event listeners. Call this when the player is no longer needed (e.g., in ngOnDestroy).

Returns void
- Defined in player/src/services/VeronaPlayerApiService.ts:342

Class VeronaPlayerApiService

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns VeronaPlayerApiService

Properties

PrivatemessageHandlers

PrivatesessionId

Privatedebug

PrivateallowedOrigin

PrivatetargetWindow

PrivatemessageListener

Methods

sendReady

Parameters

Returns void

sendStateChanged

Parameters

Returns void

sendUnitNavigationRequest

Parameters

Returns void

sendRuntimeError

Parameters

Returns void

sendWidgetCall

Parameters

Returns void

sendWindowFocusChanged

Parameters

Returns void

onStartCommand

Parameters

Parameters

Returns void

Returns void

onPageNavigationCommand

Parameters

Parameters

Returns void

Returns void

onNavigationDenied

Parameters

Parameters

Returns void

Returns void

onPlayerConfigChanged

Parameters

Parameters

Returns void

Returns void

onWidgetReturn

Parameters

Parameters

Returns void

Returns void

destroy

Returns void

Settings

On This Page

`Private`messageHandlers

`Private`sessionId

`Private`debug

`Private`allowedOrigin

`Private`targetWindow

`Private`messageListener