窗口事件订阅

窗口事件订阅,主要涉及窗口相关的事件通知,通过订阅事件,您可以实现接收显示弹窗通知/处理弹窗结果通知/更新弹窗信息通知 等功能。

1. 显示控制器弹窗通知 (AlertShow)

事件说明

1)事件解释:当用户收到该事件时,代表出现了窗口

2)引入版本: 3.8.10

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

4)事件名(sub_event):AlertShow

5)触发条件: 在控制器上显示某个弹窗

事件参数

参数名称

参数类型

参数描述

alert_info

object

窗口信息,详见窗口信息表

窗口信息列表(alert_info)

参数名称

参数类型

参数描述

id

string

窗口id

content

string

窗口内容

title

string

窗口标题

checkbox_state

bool

复选框是否选中:
true:选中
false:未选中

按钮信息表(buttons)

参数名称

参数类型

参数描述

negative

string

取消状态按钮文案

negative_id

int

取消状态按钮id

neutral

string

忽略状态按钮文案

neutral_id

int

忽略状态按钮id

positive

string

确定状态按钮文案

positive_id

int

确定状态按钮id

示例

{
    "jsonrpc": "2.0",
    "method": "Event/Dialog",
    "result": {
        "error_code": 0,
        "message": "成功",
        "data": {
            "alert_info": {
                "id": "",
                "content": "",
                "title": "",
                "checkbox_state": true,
                "buttons": {
                    "negative": "",
                    "negative_id": 0,
                    "neutral": "",
                    "neutral_id": 0,
                    "positive": "",
                    "positive_id": 0
                }
            }
        }
    },
    "sub_event": "AlertShow"
}

2. 处理控制器弹窗结果通知 (HandleAlert)

事件说明

1)事件解释:当用户收到该事件时,代表处理控制器弹窗成功

2)引入版本: 3.8.10

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

4)事件名(sub_event):HandleAlert

5)触发条件: 调用2. 处理控制器弹窗 (HandleAlert) 成功时

事件参数

参数名称

参数类型

参数描述

alert

object

窗口信息,详见窗口信息表

窗口信息列表(alert_info)

参数名称

参数类型

参数描述

id

string

窗口id

select_button_id

int

按钮id

示例

{
    "jsonrpc": "2.0",
    "method": "Event/Dialog",
    "result": {
        "error_code": 0,
        "message": "",
        "data": {
            "alert": {
                "id": 0,
                "select_button_id": 0
            }
        }
    },
    "sub_event": "HandleAlert"
}

3. 更新控制器弹窗信息通知 (UpdateAlert)

事件说明

1)事件解释:当用户收到该事件时,代表弹窗状态更新

2)引入版本: 3.9.150

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

4)事件名(sub_event):UpdateAlert

5)触发条件: Rooms某个弹窗状态更新时,会收到这个事件通知

事件参数

参数名称

参数类型

参数描述

alert

object

窗口信息,详见窗口信息表

窗口信息列表(alert)

参数名称

参数类型

参数描述

id

string

窗口id

update_content

string

更新按钮状态的文案

update_content

string

更新的按钮点击项状态:
"positive":确定
"neutral":忽略
"negative":取消
"loading":正在加载

示例

{
    "jsonrpc": "2.0",
    "method": "Event/Dialog",
    "result": {
        "error_code": 0,
        "message": "",
        "data": {
            "alert": {
                "id": "",
                "update_content": "xxx",
                "update_item": "xxx"
            }
        }
    },
    "sub_event": "UpdateAlert"
}

4. 显示Rooms弹窗通知 (RoomsAlertShow)

事件说明

1)事件解释:当用户收到该事件时,代表出现了窗口

2)引入版本: 3.20.240

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

4)事件名(sub_event):RoomsAlertShow

5)触发条件: 在Rooms上显示某个弹窗

事件参数

参数名称

参数类型

参数描述

alert_info

object

窗口信息,详见窗口信息表

窗口信息列表(alert_info)

参数名称

参数类型

参数描述

id

string

窗口id

content

string

窗口内容

title

string

窗口标题

checkbox_state

bool

复选框是否选中:
true:选中
false:未选中

按钮信息表(buttons)

参数名称

参数类型

参数描述

negative

string

取消状态按钮文案

negative_id

int

取消状态按钮id

neutral

string

忽略状态按钮文案

neutral_id

int

忽略状态按钮id

positive

string

确定状态按钮文案

positive_id

int

确定状态按钮id

示例

{
    "jsonrpc": "2.0",
    "method": "Event/Dialog",
    "result": {
        "error_code": 0,
        "message": "成功",
        "data": {
            "alert_info": {
                "id": "",
                "content": "",
                "title": "",
                "checkbox_state": true,
                "buttons": {
                    "negative": "",
                    "negative_id": 0,
                    "neutral": "",
                    "neutral_id": 0,
                    "positive": "",
                    "positive_id": 0
                }
            }
        }
    },
    "sub_event": "RoomsAlertShow"
}

5. 处理Rooms弹窗结果通知 (RoomsHandleAlert)

事件说明

1)事件解释:当用户收到该事件时,代表处理Rooms弹窗成功

2)引入版本: 3.20.240

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

4)事件名(sub_event):RoomsHandleAlert

5)触发条件: 调用3. 处理Rooms弹窗 (HandleRoomsAlert) 成功时

事件参数

参数名称

参数类型

参数描述

alert

object

窗口信息,详见窗口信息表

窗口信息列表(alert_info)

参数名称

参数类型

参数描述

id

int

窗口id

select_button_id

int

按钮id

示例

{
    "jsonrpc": "2.0",
    "method": "Event/Dialog",
    "result": {
        "error_code": 0,
        "message": "",
        "data": {
            "alert": {
                "id": 0,
                "select_button_id": 0
            }
        }
    },
    "sub_event": "RoomsHandleAlert"
}

6. 更新Rooms弹窗信息通知 (RoomsUpdateAlert)

事件说明

1)事件解释:当用户收到该事件时,代表弹窗状态更新

2)引入版本: 3.20.240

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

4)事件名(sub_event):RoomsUpdateAlert

5)触发条件: Rooms某个弹窗状态更新时,会收到这个事件通知

事件参数

参数名称

参数类型

参数描述

alert

object

窗口信息,详见窗口信息表

窗口信息列表(alert)

参数名称

参数类型

参数描述

id

string

窗口id

update_content

string

更新按钮状态的文案

update_item

string

更新的按钮点击项状态:
"positive":确定
"neutral":忽略
"negative":取消
"loading":正在加载

示例

{
    "jsonrpc": "2.0",
    "method": "Event/Dialog",
    "result": {
        "error_code": 0,
        "message": "",
        "data": {
            "alert": {
                "id": "",
                "update_content": "xxx",
                "update_item": "xxx"
            }
        }
    },
    "sub_event": "RoomsUpdateAlert"
}

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