ComponentFunctions

Index

Methods

• createContent
• destroyContent
• destroyItself
• handleDialogActionTrigger
• hideContent
• hideItself
• pause
• play
• resume
• runQueuedTask
• sequenceEnded
• shouldBlockContentSwitch
• showContent
• showItself
• suspend
• sync

Methods

createContent

• createContent(id: string, spec: ContentSpec<Record<string, unknown>>): void

• Parameters

  • id: string

  • spec: ContentSpec<Record<string, unknown>>

  Returns void

destroyContent

• destroyContent(id: string): void

• Parameters

  • id: string

  Returns void

destroyItself

• destroyItself(): Promise<void>

• Returns Promise<void>

handleDialogActionTrigger

• handleDialogActionTrigger(action: DialogActionTriggerResponse): void

• Parameters

  • action: DialogActionTriggerResponse

  Returns void

hideContent

• hideContent(id: string): void

• Parameters

  • id: string

  Returns void

hideItself

• hideItself(): void

• Returns void

pause

• pause(): void

• Returns void

play

• play(): void

• Returns void

resume

• resume(): void

• Returns void

runQueuedTask

• runQueuedTask(taskId: string): Promise<void>

• Parameters

  • taskId: string

  Returns Promise<void>

sequenceEnded

• sequenceEnded(id: string): void

• Parameters

  • id: string

  Returns void

shouldBlockContentSwitch

• shouldBlockContentSwitch(from: number, to: number): boolean

• will blocks both preload and showing of next asset instance when it returns true see unblockNextContentSetup and unblockContentSwitch on CoreFunctions

  ---

  Parameters

  • from: number

  • to: number

  Returns boolean

showContent

• showContent(id: string): void

• Parameters

  • id: string

  Returns void

showItself

• showItself(): void

• Returns void

suspend

• suspend(): void

• Returns void

sync

• sync(progress: number, time: number): void

• Parameters

  • progress: number

  • time: number

  Returns void