白板事件订阅

白板事件订阅,主要涉及白板相关的事件通知,通过订阅事件,您可以实现接收白板开启、关闭更新通知/白板保存回包通知 等功能。

1. 白板开启、关闭更新通知 (WhiteboardStateChanged)

事件说明

1)事件解释:当用户收到该事件时,代表白板已开启或关闭

2)引入版本: 3.10.160

3)所属模块(method):Event/Whiteboard

4)事件名(sub_event):WhiteboardStateChanged

5)触发条件: 用户通过Rooms或CSAPI开启或关闭白板,都会收到这个事件通知

事件参数

参数名称

参数类型

参数描述

is_open

bool

白板是否打开:
true:开启
false:关闭

is_joining_meeting

bool

是否在会中:
true:是
false:否

whiteboard_info

object

白板信息,详见白板信息表

白板信息表(whiteboard_info)

参数名称

参数类型

参数描述

is_local_saved

bool

是否已本地保存:
true:是
false:否

is_has_content

bool

白本是否有内容:
true:是
false:否

is_support_save

bool

是否支持保存:
true:是
false:否

is_open

bool

是否已打开白板:
true:是
false:否

示例

{
    "jsonrpc": "2.0",
    "method": "Event/Whiteboard",
    "result": {
        "error_code": 0,
        "message": "成功",
        "data": {
            "is_open": false,
            "is_joining_meeting": false, 
            "whiteboard_info": {
                "is_open": false,
                "is_support_save": true,
                "is_local_saved": true, 
                "is_has_content": false 
            }
        }
    },
    "sub_event": "WhiteboardStateChanged"
}

2. 白板保存回包通知 (SaveWhiteboard)

事件说明

1)事件解释:当用户收到该事件时,代表完成了保存白板的操作

2)引入版本: 3.10.160

3)所属模块(method):Event/Whiteboard

4)事件名(sub_event):SaveWhiteboard

5)触发条件: 用户通过Rooms或CSAPI保存白板,都会收到这个事件通知

事件参数

无事件参数,失败返回错误消息

示例

{
    "jsonrpc": "2.0",
    "method": "Event/Whiteboard",
    "result": {
        "error_code": 0,
        "message": "成功",
        "data": null
    },
    "sub_event": "SaveWhiteboard"
}

下载 白板事件订阅.pdf
文章内容是否对您有帮助?
有帮助
无帮助