Class WidgetStore

WidgetStore 提供活跃插件的数据和状态的访问；提供 WidgetController 实例的直接访问；提供插件相关 API，用于激活、停用和更新插件的状态。

Accessors

widgetController

get widgetController(): undefined | AgoraWidgetController

Methods

addWidgetStateListener

addWidgetStateListener(listener: AgoraWidgetStateListener): void

deprecated

since v2.9.0, please use AgoraWidgetController.addWidgetStateListener 添加一个组件状态监听器

参数

参数名	描述
listener: AgoraWidgetStateListener

返回值

void

deleteWidget

deleteWidget(widgetId: string): undefined | Promise<{ data: any }>

删除当前房间中的此组件实例

参数

参数名	描述
widgetId: string	widget ID

返回值

undefined | Promise<{ data: any }>

onDestroy

onDestroy(): void

返回值

void

onInstall

onInstall(): void

返回值

void

removeWidgetExtra

removeWidgetExtra(widgetId: string, keys?: string[]): undefined | Promise<{ data: any }>

删除组件扩展属性

参数

参数名	描述
widgetId: string
keys: string[]

返回值

undefined | Promise<{ data: any }>

removeWidgetStateListener

removeWidgetStateListener(listener: AgoraWidgetStateListener): void

deprecated

since v2.9.0, please use AgoraWidgetController.removeWidgetStateListener 移除一个组件状态监听器

参数

参数名	描述
listener: AgoraWidgetStateListener

返回值

void

removeWidgetUserProperties

removeWidgetUserProperties(widgetId: string, keys?: string[]): undefined | Promise<{ data: any }>

删除组件用户属性

参数

参数名	描述
widgetId: string
keys: string[]

返回值

undefined | Promise<{ data: any }>

setActive

setActive(widgetId: string, widgetProps?: any, ownerUserUuid?: string): void

设置组件为可用状态

参数

参数名	描述
widgetId: string	widget ID
widgetProps: any	widget 属性
ownerUserUuid: string

返回值

void

setInactive

setInactive(widgetId: string, widgetProps?: any): void

设置组件为不可用状态

参数

参数名	描述
widgetId: string	widget ID
widgetProps: any	widget 属性

返回值

void

updateWidgetProperties

updateWidgetProperties(widgetId: string, widgetProps?: any): undefined | Promise<{ data: any }>

更新组件全局属性，属性更新将同步至该组件在所有客户端上的实例

参数

参数名	描述
widgetId: string
widgetProps: any

返回值

undefined | Promise<{ data: any }>

updateWidgetUserProperties

updateWidgetUserProperties(widgetId: string, widgetProps?: any): undefined | void

更新组件用户属性，属性更新将同步至当前用户私有属性中

参数

参数名	描述
widgetId: string
widgetProps: any

返回值

undefined | void