智能小程序 Ray 开发面板 SDK —— 智能设备模型通用能力告警推送 SDK 汇总（二）

setBuiltInAlarmStatus

描述

根据设备 id 启用或禁用该产品内置的告警。

类型

type AlarmList = {
  auditStatus: number; // 审核状态
  boundForPanel: boolean; // 是否被场景面板绑定
  boundForWiFiPanel: boolean; // 是否被 WiFi 场景面板绑定
  enabled: Enabled; // 是否启用
  i18nData: {
    name: {
      en: string;
      zh: string;
    };
    content: {
      en: string;
      zh: string;
    };
  };
  id: string; // 规则 ID
  localLinkage: boolean; // 是否为本地联动
  name: string; // 规则名称
  newLocalScene: boolean; // 是否为 App 管控本地联动
  stickyOnTop: boolean; // 场景是否显示在首页
};
 
export declare class SmartAlarmAbility implements SmartDeviceAbility {
  getBuiltInAlarmList = (options: {
    devId?: string;
    disabled: boolean;
    ruleIds: string;
  }) => Promise<[boolean, AlarmList[]]>;
}

请求参数

参数	数据类型	说明	是否必填
options.devId	string	设备 ID，不填则默认自动读取当前环境下的设备 ID	否
options.disabled	boolean	是否禁用告警	是
options.ruleIds	string	告警规则 ID 数组，用逗号分隔，如：'ruleId1,ruleId2'。	否

👉 立即免费领取开发资源，体验涂鸦 MiniApp 小程序开发。  

返回参数

参数	数据类型	说明
result[0]	boolean	启用或禁用告警结果
result[1]	AlarmList[]	修改后的告警列表数据

AlarmList

参数	数据类型	说明
auditStatus	number	审核状态
boundForPanel	boolean	是否被场景面板绑定
boundForWiFiPanel	boolean	是否被 WiFi 场景面板绑定
enabled	boolean	是否启用
i18nData	{ name: { en: string; zh: string }, content: { en: string; zh: string }	多语言数据体
id	string	规则 ID
localLinkage	boolean	是否为本地联动
name	string	规则名称
newLocalScene	boolean	是否为 App 管控本地联动
stickyOnTop	boolean	场景是否显示在首页

请求示例

import { SmartAlarmAbility } from '@ray-js/panel-sdk';
 
const Alarm = new SmartAlarmAbility();
const [result, newAlarmList] = await Alarm.setBuiltInAlarmStatus({ disabled: true, ruleIds: 'mNBt0sUGf2JldzCM' });
 
console.log('=== newAlarmList: ', newAlarmList);

返回示例

[
  true,
  [
    {
      "offGwSync": false,
      "outOfWork": 0,
      "offGwSyncSuccess": false,
      "id": "mNBt0sUGf2JldzCM",
      "newLocalScene": false,
      "name": "防拆报警",
      "containDeviceDelete": false,
      "i18nData": {
        "name": {
          "zh-hans": "防拆报警",
          "en": "Tamper Alarm",
          "zh": "防拆报警"
        },
        "content": {
          "zh-hans": "${device}发生防拆报警，请及时检查！",
          "en": "${device} Tamper alarm, please check in time!",
          "zh": "${device}发生防拆报警，请及时检查！"
        }
      },
      "needCleanGidSid": false,
      "enabled": false,
      "isLogicRule": false,
      "boundForPanel": false,
      "isAlarmIssue": false,
      "stickyOnTop": false,
      "boundForWiFiPanel": false,
      "needValidOutOfWork": false,
      "iotAutoAlarm": false,
      "localLinkage": false,
      "auditStatus": 1,
      "forceCloudTrigger": false
    },
    {
      "offGwSync": false,
      "outOfWork": 0,
      "offGwSyncSuccess": false,
      "id": "3U8YLoWIeBVgOmBo",
      "newLocalScene": false,
      "name": "温度过低",
      "containDeviceDelete": false,
      "i18nData": {
        "name": {
          "zh-hans": "温度过低",
          "en": "Low temperature",
          "zh": "温度过低"
        },
        "content": {
          "zh-hans": "${device} 温度过低",
          "en": "${device} Low temperature",
          "zh": "${device} 温度过低"
        }
      },
      "needCleanGidSid": false,
      "enabled": false,
      "isLogicRule": false,
      "boundForPanel": false,
      "isAlarmIssue": false,
      "stickyOnTop": false,
      "boundForWiFiPanel": false,
      "needValidOutOfWork": false,
      "iotAutoAlarm": false,
      "localLinkage": false,
      "auditStatus": 1,
      "forceCloudTrigger": false
    }
  ]
]

👉 立即免费领取开发资源，体验涂鸦 MiniApp 小程序开发。