livelike logo
Product
NPM
Versions
Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Properties

Properties

Optional choices

choices?: IChoiceItem[]

Widget choice array

claim_url

claim_url: string

client_id

client_id: string

application Id

Optional content

content?: string

HTML string to be rendered

Optional correct_option_id

correct_option_id?: string

correct option id for prediction widget

created_at

created_at: string

When widget was created

created_by

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

User that created the widget

Type declaration

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

Optional custom_data

custom_data?: string

Widget custom data

earnable_rewards

earnable_rewards: IEarnableReward[]

engagement_count

engagement_count: number

total users engaged on the widget

engagement_percent

engagement_percent: string

Optional follow_up_url

follow_up_url?: string

follow up url used to create followUp widget

Optional follow_ups

follow_ups?: any

Follow up widget payload for prediction widgets

id

id: string

Optional image_number_prediction_id

image_number_prediction_id?: string

Follow Up Widget Image Number Prediction Id

Optional image_prediction_id

image_prediction_id?: string

Follow Up Widget Image Prediction Id

Optional image_prediction_url

image_prediction_url?: string

url to get image prediction widget details

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: WidgetKind

Optional options

options?: IOptionItem[]

Widget options array

Optional playback_time_ms

playback_time_ms?: number

video on demand playback time in milliseconds

program_date_time

program_date_time: string

Sync time

program_id

program_id: string

Id of program the widget was created in

publish_delay

publish_delay: string

Delay for when widget is published

Optional published_at

published_at?: string

Time widget was published

pubnub_enabled

pubnub_enabled: boolean

Optional question

question?: string

Widget question

reactions

reactions: IWidgetReaction[]
deprecated

Widget reactions

Optional reply_url

reply_url?: string

rewards_url

rewards_url: string

schedule_url

schedule_url: string

url to be used to schedule a widget for publishing

Optional scheduled_at

scheduled_at?: string

Time widget was scheduled

sponsors

sponsors: ISponsorPayload[]

status

status: "pending" | "published" | "in-flight"

subscribe_channel

subscribe_channel: string

Optional text_number_prediction_id

text_number_prediction_id?: string

Follow Up Widget Text Number Prediction Id

Optional text_prediction_id

text_prediction_id?: string

Follow Up Widget Text Prediction Id

Optional text_prediction_url

text_prediction_url?: string

url to get text prediction widget details

timeout

timeout: string

Widget duration

Optional timetoken

timetoken?: string

unique_impression_count

unique_impression_count: number

url

url: string

widget_attributes

widget_attributes: IAttribute[]

Optional widget_interactions_url_template

widget_interactions_url_template?: string

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

Legend

  • Namespace
  • Variable
  • Function
  • Function with type parameter
  • Type alias
  • Interface
  • Interface with type parameter
  • Property
  • Enumeration

Generated using TypeDoc