Interface IPostedWidgetsPayload

Hierarchy

IPostedWidgetsPayload

Index

Properties

count done? iterator next? previous? widget_interactions_url_template widgets

Properties

count

count: number

`Optional` done

done?: boolean

whether there's any more widgets

iterator

iterator: (() => IterableIterator<IWidgetPayload[]>)

Type declaration

- (): IterableIterator<IWidgetPayload[]>
- Iterable iterator to fetch next/prev pages
  
  Returns IterableIterator<IWidgetPayload[]>

`Optional` next

next?: (() => Promise<IteratorResult<IWidgetPayload[], any>>)

Type declaration

- (): Promise<IteratorResult<IWidgetPayload[], any>>
- Function to get next page
  
  Returns Promise<IteratorResult<IWidgetPayload[], any>>

`Optional` previous

previous?: (() => Promise<IteratorResult<IWidgetPayload[], any>>)

Type declaration

- (): Promise<IteratorResult<IWidgetPayload[], any>>
- Function to get previous page
  
  Returns Promise<IteratorResult<IWidgetPayload[], any>>

widget_interactions_url_template

widget_interactions_url_template: string

url to fetch interactions for the returned widgets

widgets

widgets: IWidgetPayload[]

List of widgets

Generated using TypeDoc