RawUserImplementedFunctions

Index

Properties

• gotoEpisode

Methods

• customizedActionRequest
• disableAppFullScreenMode
• enableAppFullScreenMode
• exit
• finishEpisode
• getSavedData
• gotoSeries
• logDebugMessage
• requestPayment
• setSavedData
• showVideoModal
• unlockAsset
• unlockEpisode

Properties

gotoEpisode

gotoEpisode: RawGoToEpisode

Methods

customizedActionRequest

• customizedActionRequest(request: CustomizedActionRequest): unknown

• Customized action for third party extension

  ---

  Parameters

  • request: CustomizedActionRequest

  Returns unknown

disableAppFullScreenMode

• disableAppFullScreenMode(): void

• Leave fullscreen mode

  ---

  Returns void

enableAppFullScreenMode

• enableAppFullScreenMode(): void

• Enter fullscreen mode

  ---

  Returns void

exit

• exit(): void

• User choose to quit the app, mainly used in Electron platform

  ---

  Returns void

finishEpisode

• finishEpisode(): void

• Finish the current episode

  ---

  Returns void

getSavedData

• getSavedData(slot: string): unknown

• Get persistent data for cloud service

  ---

  Parameters

  • slot: string

  Returns unknown

gotoSeries

• gotoSeries(series: string): void

• Jump to another series

  ---

  Parameters

  • series: string

  Returns void

logDebugMessage

• logDebugMessage(message: ToastMessage): void

• show a debug message

  ---

  Parameters

  • message: ToastMessage

  Returns void

requestPayment

• requestPayment(request: PaymentRequest): void

• Request payment from user

  ---

  Parameters

  • request: PaymentRequest

  Returns void

setSavedData

• setSavedData(slot: string, data: unknown): void

• Set persistent data for cloud service

  ---

  Parameters

  • slot: string

  • data: unknown

  Returns void

showVideoModal

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

• Open a video Modal, should returns after it was closed

  ---

  Parameters

  • request: ShowVideoModalUrlRequest | ShowVideoModalIdRequest | ShowVideoModalLabelRequest

  Returns void

unlockAsset

• unlockAsset(asset: string): void

• Unlock another interaction

  ---

  Parameters

  • asset: string

  Returns void

unlockEpisode

• unlockEpisode(episode?: string): void

• Unlock another episode, if episode not provided, current episode will be unlocked

  ---

  Parameters

  • optionalepisode: string

  Returns void