Hierarchy
- IBaseWidget
- IAlertWidget
Index
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_
created_
created_
Type declaration
id: string
image_
url: string name: string
custom_
custom data added when creating a widget
earnable_
list of earnable rewards tagged against the widget
engagement_
total no. of engagement count
engagement_
enagagement percentage in string
id
Optional image_
image url
impression_
impression_
interaction_
interactive_
dateTime in UTC where after this dateTime, widget is not interactable
kind
Optional link_
link label to be shown, requires linkUrl if present
Optional link_
link url to add on alert widget, requires linkLabel if present
playback_
video playback time in milliseconds for showing widget for video on demand
program_
program date time that could be used to sync up widget with your live streaming video
program_
publish_
publish delay duration of type string in ISO duration format
published_
pubnub_
if enabled, widgets real time publish updates and interaction updates could be subscribed
rewards_
schedule_
url to be used to schedule a widget for publishing
scheduled_
sponsors
status
subscribe_
pubnub channel to subscribe for real time widget interaction updates
Optional text
optional alert text
timeout
timeout duration for user till when the widget stays interactable in UI after getting rendered, value is in a ISO duration format
Optional title
optional alert widget title
unique_
url
widget_
widget_
widget interaction url template that can be used to get widgets interaction
Generated using TypeDoc
widget created-by details