Hierarchy
- LitElement
- Widget
Index
Constructors
Properties
- authors
- changed
- channel
- choices
- data
Id - 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 dataId
firstInteractionTime
hide_dismiss_button
initialLoad
interacted
interaction
interactions
interactiveUntilTimerTimeout
isInteractable
isStockWidget
kind
lang
mode
options
phase
Readonly programid
question
reactions
reply
selectedOption
syntheticIncrement
timeformat
timeout
timestamps
vote
Type declaration
Optional id?: string
url: string
Optional votes?: any
voteDisable
widgetPayload
Accessors
disabled
Returns boolean
Parameters
val: boolean
Returns void
Methods
answerCountChanged
Parameters
e: any
Returns void
connectedCallback
Returns void
createVote
Parameters
url: any
Optional data: Object
Returns Promise<any>
detach
Returns void
disconnectedCallback
Returns void
dismiss
Returns Promise<void>
expire
Returns Promise<void>
finished
Parameters
Optional args: IWidgetTimeoutArgs
Returns Promise<void>
firstUpdated
Returns void
interactionEvent
Parameters
Optional voteCount: number
Returns void
interactionTrack
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
lockInVote
Returns void
onResults
Parameters
e: any
Returns void
rankChanged
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>
removeListener
Parameters
Optional evt: string
Returns Promise<void>
resultEvent
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>
shouldUpdate
Returns boolean
startInteractiveUntilTimer
Returns void
submitVote
Parameters
option: any
Returns void
updateVote
Parameters
url: any
data: any
Returns Promise<any>
updated
Parameters
changedProps: any
Returns void
voteBase
Parameters
url: string
type: "post" | "patch"
Optional data: Object
Returns Promise<any>
voteCountChanged
Parameters
e: any
Returns void
widgetDismissClick
Returns Promise<void>
Generated using TypeDoc
1.18.0