Interface ICreateAlertWidgetArg
Hierarchy
- Omit<IBaseCreateWidgetArg, "interactionUntil">
- ICreateAlertWidgetArg
Properties
Optional custom
custom
Optional image
image
alert image url, either text or imageUrl is required
Optional interactive
interactive
dateTime in UTC where after this dateTime, widget is not interactable
Optional link
link
optional link label to be shown, requires linkUrl if present
Optional link
link
optional link to add on alert widget, requires linkLabel if present
Optional playback
playback
video playback time in milliseconds for showing widget for video on demand
Optional program
program
program date time that could be used to sync up widget with your live streaming video
program
program
Id of the program in which widget is to be created
Optional sponsor
sponsor
list of sponsor ids
Optional text
text?: string
alert text, either text or imageUrl is required
Optional 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
Optional widget
custom key value widget attributes
Generated using TypeDoc
custom data that could be added to set widget specific data, incase of JSON, stringify the JSON