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

Hierarchy

  • IWidgetPayload

Index

Properties

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

Optional confirmation_message

confirmation_message?: string

ask widget confirmation message

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

engagement_percent

engagement_percent: string

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_prediction_id

image_prediction_id?: string

Follow Up Widget Image Prediction Id

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

kind

kind: WidgetKind

Optional options

options?: IWidgetOptionItem[]

Widget options array

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

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

timeout

timeout: string

Widget duration

Optional timetoken

timetoken?: string

Optional title

title?: string

ask 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

Legend

  • Property

Generated using TypeDoc