iconmap.update

Описание

объект iconmap.update(объект/массив СоответствияИконок)

Этот метод позволяет обновлять существующие соответствия иконок.

Параметры

(объект/массив) Свойства соответствия иконок, которые будут обновлены.

Свойство iconmapid должно быть указано по каждому соответствию иконок, все остальные свойства опциональны. Будут обновлены только переданные свойства, все остальные останутся неизменными.

В дополнение к стандартным свойствам соответствия иконок, этот метод принимает следующие параметры.

Параметр Тип Описание
mappings массив Карты иконок, которые заменят существующие карты иконок.

Возвращаемые значения

(объект) Возвращает объект, который содержит ID обновленных соответствий иконок под свойством iconmapids.

Примеры

Переименование соответствия иконок

Переименование соответствия иконок на "OS icons".

Запрос:

{
           "jsonrpc": "2.0",
           "method": "iconmap.update",
           "params": {
               "iconmapid": "1",
               "name": "OS icons"
           },
           "auth": "038e1d7b1735c6a5436ee9eae095879e",
           "id": 1
       }

Ответ:

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

Смотрите также

Исходный код

CIconMap::update() в frontends/php/api/classes/CIconMap.php.