更新时间:2025-09-09 GMT+08:00
设置自定义按钮
接口描述
调用此接口,可以自定义会中按钮。
注意事项
- 请在调用加入会议接口后再调用此接口
- 该接口需在收到入会结果通知事件后才能成功调用。
方法定义
setCustomerButton(customerButtonObj[])::Promise<Result>
参数描述
| 参数 | 是否必须 | 类型 | 描述 |
|---|---|---|---|
| customerButtonObj[] | 是 | array | 自定义按钮列表,数据类型见表2 |
| 参数 | 是否必须 | 类型 | 描述 |
|---|---|---|---|
| buttonId | 是 | string | 按钮的唯一标识符 |
| eventName | 是 | string | 点击按钮后触发的事件名称,通过界面操作事件通知收到该事件 |
| desc | 是 | object | 见表3 |
| icon | 否 | string | 移动端呈现的自定义按钮图标,需要可访问的图片路径 |
| buttonPos | 否 | string | 自定义按钮所在位置,默认为“0”,枚举类型如下: 0:更多按钮中(最多设置六个) 1:会控条呈现(最多设置一个) |
返回值
Result的结构参考9.7.1返回结构参考-表1 Result 对象参数说明,Error结构参考9.7.1返回结构参考-表3 Error对象参数说明
示例代码
/**
* 设置自定义按钮
*/
HWMeeting.setCustomerButton(value).then((data) => {
// TODO 显示结果
}).catch((e) => {
// 显示结果
console.log(e.retCode+":"+e.retMsg);
}); 父主题: 界面定制