Class FireworkSDK

Entry class of Firework SDK, which supports the sdk initialization and global configuration.

Hierarchy

FireworkSDK

Index

Properties

onSDKInit? onVideoFeedClick?

Accessors

adBadgeConfiguration appComponentName appLanguage customCTALinkContentPageRouteName debugLogsEnabled liveStream navigator onCustomCTAClick onVideoPlayback shareBaseURL shopping

Methods

changeAppLanguage init openVideoPlayer trackPurchase getInstance

Properties

`Optional` onSDKInit

onSDKInit?: SDKInitCallback

The callback of SDK initialization.

`Optional` onVideoFeedClick

onVideoFeedClick?: VideoFeedClickCallback

the callback of clicking Video Feed.

Accessors

adBadgeConfiguration

get adBadgeConfiguration(): undefined | AdBadgeConfiguration
The configuration for ad badges. The set accessor is async.

Returns undefined | AdBadgeConfiguration
set adBadgeConfiguration(value: undefined | AdBadgeConfiguration): void
Parameters
- value: undefined | AdBadgeConfiguration
Returns void

appComponentName

get appComponentName(): undefined | string
The app component name.

Deprecated
The get accessor will be deprecated since RN SDK V2.0.

Returns undefined | string
set appComponentName(value: undefined | string): void
Deprecated
The set accessor will be deprecated since RN SDK V2.0.
Parameters
- value: undefined | string
Returns void

appLanguage

get appLanguage(): undefined | null | string
Returns undefined | null | string

customCTALinkContentPageRouteName

get customCTALinkContentPageRouteName(): undefined | string
The custom CTA link content page route name.

Deprecated
The get accessor will be deprecated since RN SDK V2.0.

Returns undefined | string
set customCTALinkContentPageRouteName(value: undefined | string): void
Deprecated
The set accessor will be deprecated since RN SDK V2.0.
Parameters
- value: undefined | string
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

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

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

shareBaseURL

get shareBaseURL(): undefined | string
The share base URL of videos. The set accessor is async.

Returns undefined | string
set shareBaseURL(value: undefined | string): void
Parameters
- value: undefined | string
Returns void

shopping

get shopping(): VideoShopping
Get VideoShopping object.

Returns VideoShopping

Methods

changeAppLanguage

changeAppLanguage(language?: null | string): Promise<boolean>
Change App level language.

Returns
Parameters
- Optional language: null | string
  
  Such as en, ar and en-US If language is null or undefined or empty string, we will use system language.
Returns Promise<boolean>

init

init(userId?: string): void
Initializes Firework SDK.
Parameters
- Optional userId: string
  
  An id to uniquely identify device or user.
Returns void

openVideoPlayer

openVideoPlayer(url: string, config?: VideoPlayerConfiguration): void
Open Video URL.
Parameters
- url: string
- Optional config: VideoPlayerConfiguration
Returns void

trackPurchase

trackPurchase(parameters: TrackPurchaseParameters): void
Records the user purchase. Only supported on iOS.
Parameters
- parameters: TrackPurchaseParameters
Returns void

`Static` getInstance

getInstance(): FireworkSDK
Get global single instance of FireworkSDK class.

Returns
FireworkSDK

Returns FireworkSDK

Generated using TypeDoc