文档中心 > TVS文档

Settings接口

更新时间:2019/01/29 访问次数:951

SettingsUpdated事件

SettingsUpdated 事件必须在用户使用设备控件或是其companion app调整精灵服务的配置时上报。例如,你的用户可能会使用你的companion app将他们的地区设定从美国 (en-US) 改为德国 (de-DE),此时,客户端就应该使用 SettingsUpdated 事件将此调整告知精灵服务。

注意:如果事件中包含格式错误或不支持的值的话,精灵服务将会回传例外信息。

Sample Message

{
    "event": {
        "header": {
            "namespace": "Settings",
            "name": "SettingsUpdated",
            "messageId": "{{STRING}}"
        },
        "payload": {
            "settings": [
                {
                    "key": "{{STRING}}",
                    "value": "{{STRING}}"
                }
            ]
        }    
    }
}

Header参数

参数 描述 型态
messageId 用以代表一个特定报文的唯一ID。 字串

Payload参数

参数 描述 型态
settings 对于某产品的精灵配置项串列。在此串列中每个item都是个具有键值对的对象。 串列
key 用以识别设定键名。允许的设定键名请参照下表。 字串
value 用以识别设定键的值。对于每个允许的设定键的值请参照下表。 字串

允许的键值对

允许的键 允许的值
locale zh-CN

FAQ

关于此文档暂时还没有FAQ
返回
顶部