Warning

Nous commençons tout juste à traduire la documentation pour cette langue, désolé !

Nous affichons des pages traduites partiellement afin de suivre l’avancement.

Cette page n’est pas encore traduite. Mais la bonne nouvelle est que vous pouvez rejoindre la communauté de traduction pour nous aider 👋.

Interface: WidgetAPI#

API to manage Custom Widget state.

Table of contents#

▸ clearOptions(): Promise<void>

Clears all the options.

Promise<void>

▸ getOption(key): Promise<any>

Get single value from Widget options object.

Name	Type
`key`	`string`

Promise<any>

▸ getOptions(): Promise<null | object>

Gets all options stored by the widget. Options are stored as plain JSON object.

Promise<null | object>

▸ setOption(key, value): Promise<void>

Store single value in the Widget options object (and create it if necessary).

Name	Type
`key`	`string`
`value`	`any`

Promise<void>

▸ setOptions(options): Promise<void>

Replaces all options stored by the widget.

Name	Type
`options`	`Object`

Promise<void>