窗口（Dialog）API接口
窗口API，主要涉及窗口哦相关的控制，通过API，您可以实现处理Rooms弹窗/查询窗口信息 等功能。
1. 查询窗口信息 (Query Dialog)
1.1 查询窗口所有信息
接口说明
1）接口解释：用于查询窗口模块的相关信息
2）引入版本： 3.8.10
3）调用方式（method）：Query
4）调用结果：同步返回调用结果
输入参数（params）
参数名称 | 是否必选 | 参数类型 | 参数描述 |
|---|---|---|---|
path | 是 | array | 模块名 |
输出参数（data）
参数名称 | 参数类型 | 参数描述 |
|---|---|---|
alert_info | array | 窗口信息，详见窗口信息列表 |
buttons | object | 按钮信息，详见按钮信息表 |
窗口信息列表（alert_info）
参数名称 | 参数类型 | 参数描述 |
|---|---|---|
id | string | 窗口id |
content | string | 窗口内容 |
title | string | 窗口标题 |
checkbox_state | bool | 复选框是否选中： |
按钮信息表（buttons）
参数名称 | 参数类型 | 参数描述 |
|---|---|---|
negative | string | 取消状态按钮文案 |
negative_id | int | 取消状态按钮id |
neutral | string | 忽略状态按钮文案 |
neutral_id | int | 忽略状态按钮id |
positive | string | 确定状态按钮文案 |
positive_id | int | 确定状态按钮id |
请求示例
request
{
"jsonrpc": "2.0",
"id": "xxx",
"method": "Query",
"params": {
"path": ["Dialog"]
}
}response
{
"jsonrpc": "2.0",
"id":"xxx",
"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
}
}
]
}
}
}2. 处理控制器弹窗 (HandleAlert)
接口说明
1）接口解释：用于操控控制器窗口
2）引入版本： 3.8.10
3）调用方式（method）：Call/Dialog
4）调用名（action）：HandleAlert
5）调用结果：异步返回调用结果，HandleAlert，需要订阅 Dialog 事件，详见 2. 处理控制器弹窗结果通知 (HandleAlert)
6）前置依赖：
a. 出现已知的Rooms窗口
输入参数（action_params）
参数名称 | 是否必选 | 参数类型 | 参数描述 |
|---|---|---|---|
alert_id | 是 | string | 1. 显示控制器弹窗通知 (AlertShow) 事件返回的弹窗id |
select_button_id | 是 | string | 1. 显示控制器弹窗通知 (AlertShow) 事件返回的按钮id |
输出参数（data）
成功返回空消息，失败返回错误信息，错误码详见 错误码定义
请求示例
request
{
"jsonrpc":"2.0",
"id":"xxx",
"method":"Call/Dialog",
"params":{
"action":"HandleAlert",
"action_params":{
"alert_id":"",
"select_button_id": 0
}
}
}response
{
"jsonrpc":"2.0",
"method":"Call/Dialog",
"id":"xxx",
"result":{
"error_code": 0,
"message":"",
"action":"HandleAlert"
}
}3. 处理Rooms弹窗 (HandleRoomsAlert)
接口说明
1）接口解释：用于操控Rooms窗口
2）引入版本： 3.20.240
3）调用方式（method）：Call/Dialog
4）调用名（action）：HandleRoomsAlert
5）调用结果：异步返回调用结果，RoomsHandleAlert，需要订阅 Dialog 事件，详见 5. 处理Rooms弹窗结果通知 (RoomsHandleAlert)
6）前置依赖：
a.出现已知的窗口
输入参数（action_params）
参数名称 | 是否必选 | 参数类型 | 参数描述 |
|---|---|---|---|
alert_id | 是 | string | 4. 显示Rooms弹窗通知 (RoomsAlertShow) 事件返回的弹窗id |
select_button_id | 是 | int | 4. 显示Rooms弹窗通知 (RoomsAlertShow) 事件返回的按钮id |
输出参数（data）
成功返回空消息，失败返回错误信息，错误码详见 错误码定义
请求示例
request
{
"jsonrpc":"2.0",
"id":"xxx",
"method":"Call/Dialog",
"params":{
"action":"HandleRoomsAlert",
"action_params":{
"alert_id":"",
"select_button_id": 0
}
}
}response
{
"jsonrpc":"2.0",
"method":"Call/Dialog",
"id":"xxx",
"result":{
"error_code": 0,
"message":"",
"action":"HandleRoomsAlert"
}
}