widgets | @livelike/engagementsdk

Index

Type aliases

PaginationIterator

Functions

Type aliases

PaginationIterator

PaginationIterator: AsyncIterator<Object, Function, Function>

Functions

Const addWidgetListener

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

Add a widget listener

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(args: IGetPostedWidgetsArgs): Promise<PaginationIterator>

Parameters
- args: IGetPostedWidgetsArgs
Returns Promise<PaginationIterator>

Const getPostedWidgets

getPostedWidgets(args: IGetPostedWidgetsArgs): Promise<IPostedWidgetsPayload>

Get list of widgets that have already been posted.

async
since
1.18.2

Parameters
- args: IGetPostedWidgetsArgs
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<IWidgetKindInteractionsMap>

Get list of widget interactions based on interaction url or an array of widget id or an array of widget kinds

async

example

getWidgetInteractions({
   interactionUrl: "<url>"
}).then(interactions => console.log(interactions))

// OR
getWidgetInteractions({
   programId: "<program-id>",
   widgets: [{
     kind: WidgetKind.TEXT_POLL,
     id: "<widget-id>"
  }]
}).then(interactions => console.log(interactions))

// OR
getWidgetInteractions({
   programId: "<program-id>",
   widgetKinds: [ WidgetKind.TEXT_POLL, WidgetKind.TEXT_PREDICTION ]
}).then(interactions => console.log(interactions))

Parameters

args: IWidgetInteractionArgs

Returns Promise<IWidgetKindInteractionsMap>

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",
  interactive: true,
  since: "2022-05-26T12:41:27.463Z"
}).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

Remove widget listener

since
2.4.0

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

Generated using TypeDoc

Index

Type aliases

Functions

Type aliases

PaginationIterator

Functions

Const addWidgetListener

Parameters

arg: { programId: string }

programId: string

callback: WidgetListenerCallback

Returns any

Const getPaginatedUnclaimedRewards

Parameters

args: { programId: string }

programId: string

Returns Promise<AsyncIterator<Object, Function, Function>>

Const getPaginatedWidgets

Parameters

args: IGetPostedWidgetsArgs

Returns Promise<PaginationIterator>

Const getPostedWidgets

Parameters

args: IGetPostedWidgetsArgs

Returns Promise<IPostedWidgetsPayload>

Const getWidget

Parameters

args: IWidgetCreationArgs

Returns Promise<IWidgetPayload>

Const getWidgetInteractions

Parameters

args: IWidgetInteractionArgs

Returns Promise<IWidgetKindInteractionsMap>

Const getWidgets

Parameters

args: IWidgetArgs

Returns Promise<IPaginatedResponse<IWidgetPayload>>

Const registerWidgetMode

Parameters

name: string

mode: WidgetMode

Returns any

Const removeWidgetListener

Parameters

arg: { programId: string }

programId: string

callback: WidgetListenerCallback

Returns void