Skip to content

排列窗口浏览器

请求方法以及路径

html
POST http://localhost:[端口号]/openapi/app/arrange/window-browser?ticket=[OpenApi票据]

接口功能描述

排列 APP 中已经打开了的所有浏览器窗口。

请求参数

Header 请求参数

参数名参数值必填类型描述
Content-Typeapplication/jsonStringapplication/json

Body 请求参数

参数名是否必须类型说明
screen_idnumber指定显示器 ID -1:表示使用渲染端用户设置
arrange_typestring窗口排列方式:null: 使用渲染端的用户设置,advance: 高级自定义、stacking: 堆叠 、nineSquareGrid: 九宫格
advance_paramsnull || object可以不传,也可以为null ,不传或者为 null 时,表示使用客户端系统设置中的高级配置 配置项查看

参数详解

advance_params 配置参数对象键值详解

参数名是否必须类型说明
xnumber排列的窗口位置横向距离左侧的距离
ynumber排列的窗口位置纵向距离顶侧的距离
widthnumber窗口的宽度 >=500
heightnumber窗口的高度 >=375
horizontalSpacingnumber两个窗口之间的横向间距
verticalSpacingnumber两个窗口之间的纵向间距
windowNumnumber一行显示排列的窗口数量

请求参数示例

json
{
  "screen_id": 2,
  "arrange_type": "advance",
  "advance_params": {
    "x": 110,
    "y": 0,
    "width": 500,
    "height": 375,
    "horizontalSpacing": 0,
    "verticalSpacing": 0,
    "windowNum": 3
  }
}

接口响应结果示例

成功响应示例

json
{
  "code": "00000",
  "message": "Success",
  "data": {
    "status": "success",
    "errorCode": "",
    "errorMsg": "",
    "result": {}
  }
}

失败响应示例



调用接口失败

接口响应状态码,不为00000时,接口调用失败。
具体接口调用错误原因可查看接口响应状态码信息对照表进行查询。

json
{
  "code": "00001",
  "message": "产生未知错误,请反馈给官方客服!",
  "data": {}
}

本次修改操作失败

json
{
  "code": "00000",
  "message": "Success",
  "data": {
    "status": "failed",
    "errorCode": "E011",
    "errorMsg": "当前尚未打开任何浏览器",
    "result": {}
  }
}

操作失败 errorCode 错误码信息对照表

错误码错误原因
E002arrange_type 必须是 advancestackingnineSquareGrid 中的一个值
E003未知异常!请反馈给官方客服。
E011当前尚未打开任何浏览器