Arrange window browser

Request method and path

POST http://localhost:[post]/openapi/app/arrange/window-browser?ticket=[OpenApiToken]

Interface function description

Arrange all open browser Windows in the APP.

Request parameter

Header Request Data

name	value	required	type	Explanation
Content-Type	application/json	Y	String	application/json

Body Request parameter

name	Required	type	Explanation
screen_id	Y	number	Specify display ID-1: indicates that the renderer user setting is used
arrange_type	Y	string	Window arrangement: null: Use user Settings on the rendering side. advance : Advanced custom, stacking : Stacking, nineSquareGrid : nine grid
advance_params	N	null || object	The value can be null or not. If the value is null or not, advanced configurations in the client system Settings are used View configuration items

Parameter detail

advance_params Description of key values of configuration parameter objects

name	Required	type	Explanation
x	Y	number	The lateral distance of the arranged window position from the left
y	Y	number	The longitudinal distance of the arranged window position from the top side
width	Y	number	Width of window >=500
height	Y	number	Height of window >=375
horizontalSpacing	Y	number	Horizontal spacing between two Windows
verticalSpacing	Y	number	Vertical spacing between two Windows
windowNum	Y	number	A row shows the number of Windows arranged

Request parameter example

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

Example of Interface Response Result

Successful Response Example

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

Example of failed response

Failed to call interface

When the interface response status code is not '00000', the interface call fails.
The specific interface call Reason for error can be queried by viewing the Interface Response Status Code Information Comparison Table.

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

This operation failed

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

Operation failure errorCode error code information comparison table

Error code	Reason for error
E002	arrange_type Must be a value in advance、stacking、nineSquareGrid
E003	Unknown exception! Please feedback to the official customer service.
E011	No browsers are currently open