Class FireworkSDK

OptionalonSDKInit

adBadgeConfiguration

• get adBadgeConfiguration(): undefined | AdBadgeConfiguration

  The configuration for ad badges.

  Returns undefined | AdBadgeConfiguration
• set adBadgeConfiguration(value: undefined | AdBadgeConfiguration): void

  Parameters

  • value: undefined | AdBadgeConfiguration

  Returns void

appLanguage

• get appLanguage(): undefined | null | string

  Returns undefined | null | string

dataTrackingLevel

• get dataTrackingLevel(): DataTrackingLevel

  The configuration for data tracking level.

  Returns DataTrackingLevel
• set dataTrackingLevel(value: DataTrackingLevel): void

  Parameters

  • value: DataTrackingLevel

  Returns void

debugLogsEnabled

• get debugLogsEnabled(): boolean

  Defaults to false. You can enable debug logs by setting this property to true.

  Returns boolean
• set debugLogsEnabled(value: boolean): void

  Parameters

  • value: boolean

  Returns void

liveStream

• get liveStream(): LiveStream

  Get LiveStream object.

  Returns LiveStream

livestreamPlayerDesignVersion

• get livestreamPlayerDesignVersion(): LivestreamPlayerDesignVersion

  The version of the livestream player design.

  Returns LivestreamPlayerDesignVersion
• set livestreamPlayerDesignVersion(value: LivestreamPlayerDesignVersion): void

  Parameters

  • value: LivestreamPlayerDesignVersion

  Returns void

navigator

• get navigator(): FWNavigator

  Get FWNavigator object.

  Returns FWNavigator

onCustomCTAClick

• get onCustomCTAClick(): undefined | CustomCTAClickCallback

  The callback of clicking custom CTA.

  Returns undefined | CustomCTAClickCallback
• set onCustomCTAClick(value: undefined | CustomCTAClickCallback): void

  Parameters

  • value: undefined | CustomCTAClickCallback

  Returns void

onVideoFeedClick

• get onVideoFeedClick(): undefined | VideoFeedClickCallback

  the callback of clicking Video Feed.

  Returns undefined | VideoFeedClickCallback
• set onVideoFeedClick(value: undefined | VideoFeedClickCallback): void

  Parameters

  • value: undefined | VideoFeedClickCallback

  Returns void

onVideoPlayback

• get onVideoPlayback(): undefined | VideoPlaybackCallback

  The callback of video playback.

  Returns undefined | VideoPlaybackCallback
• set onVideoPlayback(value: undefined | VideoPlaybackCallback): void

  Parameters

  • value: undefined | VideoPlaybackCallback

  Returns void

preventPipOnLeave

• get preventPipOnLeave(): boolean

  Returns boolean

• set preventPipOnLeave(prevent: boolean): void

  When enabled, prevents auto-entering PiP when the user leaves the fullscreen player (e.g. presses Home or switches to another app). The player activity stays in the background stack instead of entering PiP mode. Defaults to false. Only supported on Android.

  Parameters

  • prevent: boolean

  Returns void

shareBaseURL

• get shareBaseURL(): undefined | string

  The global share base URL of the video. The VideoPlayerConfiguration.shareBaseURL in VideoPlayerConfiguration will override this.

  Returns undefined | string
• set shareBaseURL(value: undefined | string): void

  Parameters

  • value: undefined | string

  Returns void

shopping

• get shopping(): VideoShopping

  Get VideoShopping object.

  Returns VideoShopping

shortVideoPlayerDesignVersion

• get shortVideoPlayerDesignVersion(): ShortVideoPlayerDesignVersion

  The version of the short video player design.

  Returns ShortVideoPlayerDesignVersion
• set shortVideoPlayerDesignVersion(value: ShortVideoPlayerDesignVersion): void

  Parameters

  • value: ShortVideoPlayerDesignVersion

  Returns void

videoLaunchBehavior

• get videoLaunchBehavior(): undefined | VideoLaunchBehavior

  Get video launch behavior.

  Returns undefined | VideoLaunchBehavior

changeAppLanguage

• changeAppLanguage(language?: null | string): Promise<boolean>

  Change App level language.

  Parameters

  • Optionallanguage: null | string

    Such as en, ar and en-US. If language is undefined or null or empty string, SDK will use system language.

  Returns Promise<boolean>

  The result of changing app language.

getComponentType

• getComponentType(feedId: string): undefined | FWComponentType

  Get the component type based on feedId.

  Parameters

  • feedId: string

  Returns undefined | FWComponentType

  The component type based on feedId.

markInitCalled

• markInitCalled(options?: MarkInitCalledOptions): Promise<void>

  Mark the initialization method as being called on the JS side.

  Parameters

  • options: MarkInitCalledOptions = ...

  Returns Promise<void>

openVideoPlayer

• openVideoPlayer(
      url: string,
      config?: OpenVideoPlayerConfiguration,
  ): Promise<void>

  Open Video URL.

  Parameters

  • url: string
  • Optionalconfig: OpenVideoPlayerConfiguration

  Returns Promise<void>

trackPurchase

• trackPurchase(parameters: TrackPurchaseParameters): Promise<void>

  Records the user purchase. Only supported on iOS.

  Parameters

  • parameters: TrackPurchaseParameters

  Returns Promise<void>

StaticgetInstance

• getInstance(): FireworkSDK

  Get global single instance of FireworkSDK class.

  Returns FireworkSDK

  FireworkSDK