widgets | @livelike/engagementsdk - v2.17.0

API
Elements

Index

Type aliases

PaginationIterator

Functions

Type aliases

PaginationIterator

PaginationIterator: AsyncIterator<Object, Function, Function>

Functions

Const addWidgetListener

addWidgetListener(arg: { programId: string }, callback: WidgetListenerCallback): any

since
2.4.0

Parameters
- arg: { programId: string }
  - programId: string
- callback: WidgetListenerCallback
Returns any

Const getPaginatedUnclaimedRewards

getPaginatedUnclaimedRewards(args: { programId: string }): Promise<AsyncIterator<Object, Function, Function>>

Parameters
- args: { programId: string }
  - programId: string
Returns Promise<AsyncIterator<Object, Function, Function>>

Const getPaginatedWidgets

getPaginatedWidgets(__namedParameters: Object): Promise<PaginationIterator>

Parameters
- __namedParameters: Object
Returns Promise<PaginationIterator>

Const getPostedWidgets

getPostedWidgets(__namedParameters: Object): Promise<IPostedWidgetsPayload>

Get list of widgets that have already been posted.

async
since
1.18.2

Parameters
- __namedParameters: Object
Returns Promise<IPostedWidgetsPayload>

Const getWidget

getWidget(args: IWidgetCreationArgs): Promise<IWidgetPayload>

Gets widget object from passed kind and id

async
since
1.18.0

Parameters
- args: IWidgetCreationArgs
Returns Promise<IWidgetPayload>

Const getWidgetInteractions

getWidgetInteractions(args: IWidgetInteractionArgs): Promise<any>

Parameters
- args: IWidgetInteractionArgs
Returns Promise<any>

Const getWidgets

getWidgets(args: IWidgetArgs): Promise<IPaginatedResponse<IWidgetPayload>>

description
Fetch paginated List of Widgets filtered by widget status and kind

since
2.13.0

example
getWidgets({ programId: "xxxx", status: "pending", widgetKinds: ["text-poll"], ordering: "recent" }).then(res => console.log(res));

Parameters
- args: IWidgetArgs
Returns Promise<IPaginatedResponse<IWidgetPayload>>

Const registerWidgetMode

registerWidgetMode(name: string, mode: WidgetMode): any

Registers a custom widget state transition mode. The name argument is used to pass to one of the widget instantiation methods to choose

since
1.18.0

Parameters
- name: string
- mode: WidgetMode
Returns any

Const removeWidgetListener

removeWidgetListener(arg: { programId: string }, callback: WidgetListenerCallback): void

since
2.4.0

Parameters
- arg: { programId: string }
  - programId: string
- callback: WidgetListenerCallback
Returns void

Generated using TypeDoc