livelike logo
Product
NPM
Versions

Interface IWidgetPayload

Hierarchy

Properties

average_magnitude? choices? claim_url? client_id confirmation_message? correct_option_id? created_at created_by custom_data? earnable_rewards engagement_count engagement_percent follow_up_url? follow_ups? id image_number_prediction_id? image_number_prediction_url? image_prediction_id? image_prediction_url? image_url? impression_count impression_url initial_magnitude? interaction_url interactive_until kind link_label? link_url? options? playback_time_ms? program_date_time program_id prompt? publish_delay published_at? pubnub_enabled question? reactions reply_url? rewards_url schedule_url scheduled_at? sponsors status subscribe_channel text? text_number_prediction_id? text_prediction_id? text_prediction_url? timeout timetoken? title? unique_impression_count url vote_url? widget_attributes widget_interactions_url_template

Properties

Optional average_magnitude

average_magnitude?: string

emoji slider attribute

Optional choices

choices?: IWidgetChoiceItem[]

Widget choice array

Optional claim_url

claim_url?: string

claim url that could be invoked to claim prediction rewards

client_id

client_id: string

application Id

Optional confirmation_message

confirmation_message?: string

ask widget confirmation message

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: IWidgetEarnableReward[]

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?: IWidgetPayload[]

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_number_prediction_url

image_number_prediction_url?: string

url to get image number prediction widget details

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

Optional image_url

image_url?: string

alert widget image url if present

impression_count

impression_count: number

impression_url

impression_url: string

Optional initial_magnitude

initial_magnitude?: string

emoji slider attribute

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 link_label

link_label?: string

alert widget link label if present

Optional link_url

link_url?: string

alert widget link url if present

Optional options

options?: IWidgetOptionItem[]

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

Optional prompt

prompt?: string

ask widget prompt

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[]

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

text?: string

alert widget widget text if present

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

Optional title

title?: string

ask widget or alert widget title

unique_impression_count

unique_impression_count: number

url

url: string

Optional vote_url

vote_url?: string

vote_url used in the case of emoji slider and number prediction widget

widget_attributes

widget_attributes: IWidgetAttribute[]

widget_interactions_url_template

widget_interactions_url_template: string

Settings

Member Visibility

Generated using TypeDoc