screen.update

说明

object screen.update(object/array screens)

此方法允许更新现有screen。

参数

(object/array) 要更新的screen属性。

必须为每个屏幕定义“屏幕ID”属性，所有其他属性都是可选的。 只有通过的属性将被更新，所有其他属性将保持不变。

除了标准screen属性之外, 该方法接受以下参数。

属性 类 说明
screenitems array 替代现有Screen items的screen items.

screen items通过坐标更新，因此每个screen items必须定义“x”和“y”属性。
users array Screen用户共享替换现有元素。
userGroups array Screen用户组共享以替换现有元素。

返回值

(object)返回一个包含“screenid”属性下更新屏幕的ID的对象。

示例

Renaming a screen

Rename a screen to "CPU Graphs".

Request:

{
    "jsonrpc": "2.0",
    "method": "screen.update",
    "params": {
        "screenid": "26",
        "name": "CPU Graphs"
    },
    "auth": "038e1d7b1735c6a5436ee9eae095879e",
    "id": 1
}

Response:

{
    "jsonrpc": "2.0",
    "result": {
        "screenids": [
            "26"
        ]
    },
    "id": 1
}

Change screen owner

Available only for admins and super admins.

Request:

{
    "jsonrpc": "2.0",
    "method": "screen.update",
    "params": {
        "screenid": "83",
        "userid": "1"
    },
    "auth": "038e1d7b1735c6a5436ee9eae095879e",
    "id": 2
}

Response:

{
    "jsonrpc": "2.0",
    "result": {
        "screenids": [
            "83"
        ]
    },
    "id": 2
}

参见

来源

CScreen::update() in frontends/php/include/classes/api/services/CScreen.php.