Hierarchy
- LitElement
- Widget
Index
Constructors
Properties
- authors
- changed
- channel
- choices
- data
Id - date
Time Formatter - first
Interaction Time - hide_
dismiss_ button - initial
Load - interacted
- interaction
- interactions
- interactive
Until Timer Timeout - is
Interactable - is
Stock Widget - kind
- lang
- mode
- options
- phase
- programid
- question
- reactions
- reply
- selected
Option - synthetic
Increment - timeformat
- timeout
- timestamps
- vote
- vote
Disable - widget
Payload
Accessors
Methods
- answer
Count Changed - connected
Callback - create
Vote - detach
- disconnected
Callback - dismiss
- expire
- finished
- first
Updated - interaction
Event - interaction
Track - interactive
- localize
- lock
In Vote - on
Results - rank
Changed - ready
- remove
Listener - result
Event - results
- should
Update - start
Interactive Until Timer - submit
Vote - update
Vote - updated
- vote
Base - vote
Count Changed - widget
Dismiss Click
Constructors
constructor
Returns Widget
Properties
authors
changed
channel
choices
Readonly data Id
date Time Formatter
Type declaration
Parameters
__namedParameters: Object
Returns string
first Interaction Time
hide_ dismiss_ button
initial Load
interacted
interaction
interactions
interactive Until Timer Timeout
is Interactable
is Stock Widget
kind
lang
mode
options
phase
Readonly programid
question
reactions
reply
selected Option
synthetic Increment
timeformat
timeout
timestamps
vote
Type declaration
Optional id?: string
url: string
Optional votes?: any
vote Disable
widget Payload
Accessors
disabled
Returns boolean
Parameters
val: boolean
Returns void
Methods
answer Count Changed
Parameters
e: any
Returns void
connected Callback
Returns void
create Vote
Parameters
url: any
Optional data: Object
Returns Promise<any>
detach
Returns void
disconnected Callback
Returns void
dismiss
Returns Promise<void>
expire
Returns Promise<void>
finished
Parameters
Optional args: IWidgetTimeoutArgs
Returns Promise<void>
first Updated
Returns void
interaction Event
Parameters
Optional voteCount: number
Returns void
interaction Track
Returns void
interactive
Optional timeout argument. If no timeout arg passed, widget.widgetPayload.timeout is used. Initiates timer countdown, allows interaction/voting. Resolves when timer duration elapses. widget.phase = 'interactive'
Parameters
Optional args: IWidgetTimeoutArgs
Returns Promise<void>
localize
Parameters
key: string
Optional variables: Object
Returns any
lock In Vote
Returns void
on Results
Parameters
e: any
Returns void
rank Changed
Fires rankchange event when user profile's rank updates
Parameters
widget: any
rewards: IReward[]
Returns void
ready
Widget ready state. widget.phase = 'ready'.
Parameters
Optional args: IWidgetTimeoutArgs
Returns Promise<void>
remove Listener
Parameters
Optional evt: string
Returns Promise<void>
result Event
Returns void
results
Timer is removed, widget is disabled, widget vote/answers are shown. Resolves when timer duration elapses. If program rewards_type is either 'points' or 'badges' and user has interacted with widget, user points received are displayed. If program rewards_type is 'badges' and user has interacted with widget and user has received a new badge, the new badge is displayed. widget.phase = 'results' widget.disabled = true
Parameters
Optional args: IWidgetTimeoutArgs
Returns Promise<void>
should Update
Returns boolean
start Interactive Until Timer
Returns void
submit Vote
Parameters
option: any
Returns void
update Vote
Parameters
url: any
data: any
Returns Promise<any>
updated
Parameters
changedProps: any
Returns void
vote Base
Parameters
url: string
type: "post" | "patch"
Optional data: Object
Returns Promise<any>
vote Count Changed
Parameters
e: any
Returns void
widget Dismiss Click
Returns Promise<void>
Generated using TypeDoc
Formats timestamp
2.43.1
object of type {time, format, lang}