livelike logo
Product
NPM
Versions

Class Widget

Hierarchy

  • LitElement
    • Widget

Constructors

constructor

Properties

authors changed channel choices dataId dateTimeFormatter firstInteractionTime hide_dismiss_button initialLoad interacted interaction interactions interactiveUntilTimerTimeout isInteractable isStockWidget kind lang mode options phase programid question reactions reply selectedOption syntheticIncrement timeformat timeout timestamps vote voteDisable widgetPayload

Accessors

disabled

Methods

answerCountChanged connectedCallback createVote detach disconnectedCallback dismiss expire finished firstUpdated interactionEvent interactionTrack interactive localize lockInVote onResults rankChanged ready removeListener resultEvent results shouldUpdate startInteractiveUntilTimer submitVote updateVote updated voteBase voteCountChanged widgetDismissClick

Constructors

constructor

  • Returns Widget

Properties

authors

authors: boolean

changed

changed: boolean = false

channel

channel: string

choices

choices: IChoiceItem[]

Readonly dataId

dataId: string

dateTimeFormatter

dateTimeFormatter: ((__namedParameters) => string) = formatDateTime

Type declaration

    • (__namedParameters): string

    • Formats timestamp

      Parameters

      • __namedParameters: {
            format: any;
            lang: any;
            time: any;
        }
        • format: any
        • lang: any
        • time: any

      Returns string

      Since

      2.43.1

      Argument

      object of type {time, format, lang}

firstInteractionTime

firstInteractionTime: Date = null

hide_dismiss_button

hide_dismiss_button: boolean = false

initialLoad

initialLoad: boolean = false

interacted

interacted: boolean = false

interaction

interaction: IWidgetInteraction = null

interactions

interactions: IWidgetInteraction[] = null

interactiveUntilTimerTimeout

interactiveUntilTimerTimeout: any

isInteractable

isInteractable: boolean = true

isStockWidget

isStockWidget: boolean

kind

kind: any

lang

lang: any

mode

mode: any

options

options: IOptionItem[]

phase

phase: Phase = Phase.READY

Readonly programid

programid: string

question

question: string

reactions

reactions: any

reply

reply: string

selectedOption

selectedOption: any = {}

syntheticIncrement

syntheticIncrement: boolean = false

timeformat

timeformat: any

timeout

timeout: any

timestamps

timestamps: boolean

vote

vote: {
    id?: string;
    url: string;
    votes?: any;
} = null

Type declaration

  • Optional id?: string
  • url: string
  • Optional votes?: any

voteDisable

voteDisable: any

widgetPayload

widgetPayload: IWidgetPayload

Accessors

disabled

  • get disabled(): boolean

  • Returns boolean

  • set disabled(val): void

  • 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

    Returns Promise<void>

    Since

    1.18.0

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

    Returns Promise<void>

    Since

    1.18.0

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

    Returns void

    Fires

    rankchange

ready

  • Widget ready state. widget.phase = 'ready'.

    Parameters

    Returns Promise<void>

    Since

    1.18.0

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

    Returns Promise<void>

    Since

    1.18.0

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>

Settings

Member Visibility

Generated using TypeDoc