Class InvisiblePlugin<A>

不可见插件的描述。

since

2.10.0
Agora 支持的自定义插件包括组件插件和不可见插件。二者的主要区别有：

• 不可见插件全局唯一，只能建立一个对象。

• 不可见插件不会显示在白板界面上，但它的 attributes 状态会在全房间自动同步。

Constructors

constructor

new InvisiblePlugin(context: InvisiblePluginContext): InvisiblePlugin

不可见插件的构造函数。

参数

参数名	描述
context: InvisiblePluginContext	不可见插件的上下文。

返回值

InvisiblePlugin

Properties

attributes

attributes: A

不可见插件的属性。

callbacks

callbacks: Callbacks<InvisibleCallbacks<A>>

不可见插件的事件回调。

displayer

displayer: Displayer

不可见插件的 Displayer 对象。

Methods

destroy

destroy(): void

删除不可见插件。

返回值

void

getAttributesValue

getAttributesValue(key: string[] | string): any

获取不可见插件属性的值。

since

2.13.7

参数

参数名	描述
key: string[] | string	属性对应的 key。

返回值

any

onAttributesUpdate

onAttributesUpdate(attributes: A): void

不可见插件属性更新的回调。

参数

参数名	描述
attributes: A	更新的 attributes。

返回值

void

onDestroy

onDestroy(): void

不可见插件删除的回调。

返回值

void

setAttributes

setAttributes(modifyAttributes: Partial<A>): void

设置不可见插件的属性。

参数

参数名	描述
modifyAttributes: Partial<A>	不可见插件的属性。

返回值

void

updateAttributes

updateAttributes(keys: string | string[], value: any): void

更新不可见插件的属性。

since

2.13.7

参数

参数名	描述
keys: string | string[]	单个或多个属性对应的 key。
value: any	属性的值。

返回值

void