ContentFunctions

Index

Methods

• destroy
• dialogActionTriggered
• dialogAreaClosed
• dialogAreaOpened
• dialogMessage
• finishPayment
• hide
• pause
• play
• requestHeartbeat
• runQueuedTask
• seek
• sequenceEnded
• show
• updateEnvironment
• updateResolution
• updateTextField
• videoModalClosed

Methods

destroy

• destroy(): void

• Should be called when the content will be destroyed

  ---

  Returns void

dialogActionTriggered

• dialogActionTriggered(action: DialogActionTriggerResponse): void

• User clicked dialog active

  ---

  Parameters

  • action: DialogActionTriggerResponse

  Returns void

dialogAreaClosed

• dialogAreaClosed(): void

• Should be called when the dialog area was closed by user

  ---

  Returns void

dialogAreaOpened

• dialogAreaOpened(): void

• Should be called when the dialog area was opened by user

  ---

  Returns void

dialogMessage

• dialogMessage(text: string): void

• Send a user input message to the content

  ---

  Parameters

  • text: string

  Returns void

finishPayment

• finishPayment(type: string): void

• User finished payment action

  ---

  Parameters

  • type: string

  Returns void

hide

• hide(): void

• Should be called when the content will be hidden

  ---

  Returns void

pause

• pause(): void

• Should be called when the content will be paused

  ---

  Returns void

play

• play(): void

• Should be called when the content will be playing

  ---

  Returns void

requestHeartbeat

• requestHeartbeat(): void

• Get a heartbeat signal from the content to check that the content is alive

  ---

  Returns void

runQueuedTask

• runQueuedTask(taskId: string): void

• Trigger the queued task

  ---

  Parameters

  • taskId: string

  Returns void

seek

• seek(time: number): void

• Should be called when the content will be seeked to a specific time

  ---

  Parameters

  • time: number

  Returns void

sequenceEnded

• sequenceEnded(id: string): void

• Parameters

  • id: string

  Returns void

show

• show(): void

• Should be called when the content will be visible

  ---

  Returns void

updateEnvironment

• updateEnvironment(env: Record<string, unknown>): void

• Update environment variables for content

  ---

  Parameters

  • env: Record<string, unknown>

  Returns void

updateResolution

• updateResolution(x: number, y: number): void

• Update Resolution for content

  ---

  Parameters

  • x: number

  • y: number

  Returns void

updateTextField

• updateTextField(id: string, content: string): void

• Parameters

  • id: string

  • content: string

  Returns void

videoModalClosed

• videoModalClosed(request: ShowVideoModalUrlRequest | ShowVideoModalIdRequest | ShowVideoModalLabelRequest): void

• User closed the video modal

  ---

  Parameters

  • request: ShowVideoModalUrlRequest | ShowVideoModalIdRequest | ShowVideoModalLabelRequest

  Returns void