mediatype.update

描述

object mediatype.update(object/array mediaTypes)

此方法允许update现有媒介类型.

此方法仅适用于超级管理员用户类型. 调用该方法的权限可在用户角色设置中撤销. 详见 User roles 获取更多信息.

参数

(object/array) 待更新的媒介类型属性.

每个媒介类型必须定义 mediatypeid 属性,其他所有属性均为可选。仅传递的属性会被更新,其余属性将保持不变。

媒介类型 外,该方法还接受以下参数。

参数 数据类型 描述
parameters array webhook-参数 用于替换当前的webhook参数。
message_templates array 消息模板 用于替换当前的消息模板。

返回值

(object) 返回一个包含更新后媒体类型ID的object,这些ID位于mediatypeids属性下。

示例

启用媒介类型

启用媒体类型,即将其状态设置为"0"。

请求:

{
           "jsonrpc": "2.0",
           "method": "mediatype.update",
           "params": {
               "mediatypeid": "6",
               "status": "0"
           },
           "auth": "038e1d7b1735c6a5436ee9eae095879e",
           "id": 1
       }

响应:

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

来源

CMediaType::update() 位于 ui/include/classes/api/services/CMediaType.php 文件中。