Class LiveLikeWidgets

Element

livelike-widgets

Hierarchy

LitElement
- LiveLikeWidgets

Constructors

constructor

new LiveLikeWidgets(): LiveLikeWidgets
Returns LiveLikeWidgets
Inherited from LitElement.constructor

Properties

authors

authors: boolean = false

Add to element to enabled listing the widget author tag in timeline mode

customTemplateRenderer

customTemplateRenderer: CustomWidgetRenderer

customWidgetRenderer

customWidgetRenderer: CustomWidgetRenderer

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.0
  
  Argument
  object of type {time, format, lang}

hasWidgetAttached

hasWidgetAttached: boolean = false

hide_dismiss_button

hide_dismiss_button: boolean = false

Boolean to toggle displaying the widget's dismiss button

lang

lang: any

Sets language code

loaded

loaded: boolean = false

If the element has loaded

mode

mode: string = 'pop-up'

The mode of the element. Either "pop-up" or "timeline". Default is "pop-up"

programid

programid: any

The id of the program to load the element with

queue

queue: any

reactions

reactions: boolean = false

If true, widget reactions are shown once widget is not longer in 'ready' or 'interactive' phase

syncStrategy

syncStrategy: any

Sets the custom syncStrategy

See

https://docs.livelike.com/docs/web-spoiler-free-sync

timeformat

timeformat: {
    day: string;
    hour: string;
    minute: string;
    month: string;
    year: string;
} = ...

Object containing time formatting properties.

Type declaration

day: string
hour: string
minute: string
month: string
year: string

timestamps

timestamps: boolean = false

Add to element to enabled listing the widget timestamps tag in timeline mode

updating

updating: boolean = false

Methods

afterWidgetsLoaded

afterWidgetsLoaded(__namedParameters): Promise<void>
Parameters
- __namedParameters: {
  interactionUrl: any;
  widgets: any;
  }
  - interactionUrl: any
  - widgets: any
Returns Promise<void>

attach

attach(widgetEl, position): Promise<void>
Parameters
- widgetEl: Widget
- position: "append" | "prepend"
Returns Promise<void>
Async
Attaches widget to DOM. Fires widgetattached events.

Fires
widgetattached

createSyncWidget

createSyncWidget(args): Promise<unknown>
Creates and queues widget from widget id and kind. Displays widget according to syncStrategy.
Parameters
- args: IWidgetCreationArgs
Returns Promise<unknown>
See
https://docs.livelike.com/docs/web-spoiler-free-sync

Since
1.18.0

Example
```
const widgetEl = document.querySelector('livelike-widgets')\n
widgetEl.createSyncWidget({id: c1f6082c-f7b9-4d1e-b64e-9071a3860ffc, kind: 'text-poll'})
```

createWidget

createWidget(args): Promise<any>
Parameters
- args: IWidgetDisplayArgs
Returns Promise<any>

createWidgetElement

createWidgetElement(args): Promise<unknown>

Creates and immediately displays widget.

Parameters

args: IWidgetCreationArgs

Returns Promise<unknown>

Since

1.18.0

Example

const widgetEl = document.querySelector('livelike-widgets')\n
widgetEl.createWidgetElement({id: c1f6082c-f7b9-4d1e-b64e-9071a3860ffc, kind: 'text-poll'})

detach

detach(widgetEl): Promise<void>
Parameters
- widgetEl: Widget
Returns Promise<void>
Async
Removes widget from DOM. Fires beforewidgetdetached and widgetdetached events. Removes listeners.

Fires
beforewidgetdetached

Fires
widgetdetached

disconnectedCallback

disconnectedCallback(): void
Returns void
Overrides LitElement.disconnectedCallback

enqueueWidget

enqueueWidget(args): any
Adds widget to the widgetQueue for spoiler prevention
Parameters
- args: IWidgetDisplayArgs
Returns any
Since
1.18.0

Link
spoilerPrevention

firstUpdated

firstUpdated(): void
Returns void
Overrides LitElement.firstUpdated

getUnclaimedRewards

getUnclaimedRewards(): Promise<any>
Returns Promise<any>

loadNextPage

loadNextPage(): any
Returns any

loadTimeline

loadTimeline(programId): Promise<void>
Parameters
- programId: any
Returns Promise<void>

onInitialWidgetsLoaded

onInitialWidgetsLoaded(__namedParameters): any
Parameters
- __namedParameters: {
  widgets: any;
  }
  - widgets: any
Returns any

onMoreWidgetsLoaded

onMoreWidgetsLoaded(__namedParameters): any
Parameters
- __namedParameters: {
  widgets: any;
  }
  - widgets: any
Returns any

onWidgetReceived

onWidgetReceived(widgetPayload): any
Parameters
- widgetPayload: any
Returns any

overRideTimer

overRideTimer(__namedParameters): number
Parameters
- __namedParameters: {
  widget: any;
  }
  - widget: any
Returns number

registerWidgetMode

registerWidgetMode(name, mode): void
Registers widget mode
Parameters
- name: string
- mode: WidgetMode
Returns void

render

render(): TemplateResult
Returns TemplateResult
Overrides LitElement.render

showWidget

showWidget(args): Promise<unknown>
Immediately begins widget lifecycle and state transitions.
Parameters
- args: IWidgetDisplayArgs
Returns Promise<unknown>
Since
1.18.0

start

start(args): Promise<any>
Parameters
- args: IWidgetDisplayArgs
Returns Promise<any>

updateEl

updateEl(): void
Returns void

updated

updated(changedProps): void
Parameters
- changedProps: any
Returns void
Overrides LitElement.updated

widgetListener

widgetListener(e): void
Parameters
- e: any
Returns void

Generated using TypeDoc

Class LiveLikeWidgets

Element

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns LiveLikeWidgets

Properties

authors

customTemplateRenderer

customWidgetRenderer

dataId

dateTimeFormatter

Type declaration

Parameters

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

format: any

lang: any

time: any

Returns string

Since

Argument

hasWidgetAttached

hide_dismiss_button

lang

loaded

mode

programid

queue

reactions

syncStrategy

See

timeformat

Type declaration

day: string

hour: string

minute: string

month: string

year: string

timestamps

updating

Methods

afterWidgetsLoaded

Parameters

__namedParameters: { interactionUrl: any; widgets: any; }

interactionUrl: any

widgets: any

Returns Promise<void>

attach

Parameters

widgetEl: Widget

position: "append" | "prepend"

Returns Promise<void>

Async

Fires

createSyncWidget

Parameters

args: IWidgetCreationArgs

Returns Promise<unknown>

See

Since

Example

createWidget

Parameters

args: IWidgetDisplayArgs

Returns Promise<any>

createWidgetElement

Parameters

args: IWidgetCreationArgs

Returns Promise<unknown>

Since

Example

detach

Parameters

widgetEl: Widget

Returns Promise<void>

Async

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

__namedParameters: {
interactionUrl: any;
widgets: any;
}

__namedParameters: {
widgets: any;
}

__namedParameters: {
widgets: any;
}

__namedParameters: {
widget: any;
}