livelike logo
Product
NPM
Versions

Interface IAlertWidget

Hierarchy

Properties

client_id created_at created_by custom_data earnable_rewards engagement_count engagement_percent id image_url? impression_count impression_url interaction_url interactive_until kind link_label? link_url? playback_time_ms program_date_time program_id publish_delay published_at pubnub_enabled rewards_url schedule_url scheduled_at sponsors status subscribe_channel text? timeout title? unique_impression_count url widget_attributes widget_interactions_url_template

Properties

client_id

client_id: string

created_at

created_at: string

created_by

created_by: {
    id: string;
    image_url: string;
    name: string;
}

widget created-by details

Type declaration

  • id: string
  • image_url: string
  • name: string

custom_data

custom_data: string

custom data added when creating a widget

earnable_rewards

earnable_rewards: IEarnableReward[]

list of earnable rewards tagged against the widget

engagement_count

engagement_count: number

total no. of engagement count

engagement_percent

engagement_percent: string

enagagement percentage in string

id

id: string

Optional image_url

image_url?: string

image url

impression_count

impression_count: number

impression_url

impression_url: string

interaction_url

interaction_url: string

interactive_until

interactive_until: string

dateTime in UTC where after this dateTime, widget is not interactable

kind

kind: ALERT

Optional link_label

link_label?: string

link label to be shown, requires linkUrl if present

Optional link_url

link_url?: string

link url to add on alert widget, requires linkLabel if present

playback_time_ms

playback_time_ms: number

video playback time in milliseconds for showing widget for video on demand

program_date_time

program_date_time: string

program date time that could be used to sync up widget with your live streaming video

program_id

program_id: string

publish_delay

publish_delay: string

publish delay duration of type string in ISO duration format

published_at

published_at: string

pubnub_enabled

pubnub_enabled: boolean

if enabled, widgets real time publish updates and interaction updates could be subscribed

rewards_url

rewards_url: string

schedule_url

schedule_url: string

url to be used to schedule a widget for publishing

scheduled_at

scheduled_at: string

sponsors

sponsors: ISponsorPayload[]

status

status: WidgetStatus

subscribe_channel

subscribe_channel: string

pubnub channel to subscribe for real time widget interaction updates

Optional text

text?: string

optional alert text

timeout

timeout: string

timeout duration for user till when the widget stays interactable in UI after getting rendered, value is in a ISO duration format

Optional title

title?: string

optional alert widget title

unique_impression_count

unique_impression_count: number

url

url: string

widget_attributes

widget_attributes: IAttribute[]

widget_interactions_url_template

widget_interactions_url_template: string

widget interaction url template that can be used to get widgets interaction

Settings

Member Visibility

Generated using TypeDoc