---
name: "SmartAlarmAbility.setBuiltInAlarmStatus"
mode: "api"
versionRequirements:
  - { name: "@ray-js/panel-sdk", version: "1.8.0" }
title: "setBuiltInAlarmStatus - 根据设备 id 启用或禁用该产品内置的告警。"
summary: "根据设备 ID 和规则 ID 启用或禁用产品内置的告警消息推送。"
---

## SmartAlarmAbility.setBuiltInAlarmStatus

> [VERSION] @ray-js/panel-sdk >= 1.8.0

> 💡 仅支持单设备，不支持群组环境。
> 注意，返回示例仅供参考，其包含字段大于返回参数定义范围，请勿使用除本文返回参数定义以外的返回数据，否则可能会导致程序异常。

### 描述

启用或禁用设备内置的告警规则

### 参数

`Params`

| 参数 | 类型 | 必填 | 描述 |
| --- | --- | --- | --- |
| `options` | `SetBuiltInAlarmStatusParams` | 是 | 操作参数 |

### 返回值

类型: `Promise<SetBuiltInAlarmStatusResult>`

元组 [是否操作成功, 更新后的内置告警列表]

### 引用对象

##### `type` SetBuiltInAlarmStatusParams

| 属性 | 类型 | 描述 |
| --- | --- | --- |
| `devId` | `string` | 设备 ID，不传则使用当前设备 |
| `disabled` | `boolean` | true 为禁用，false 为启用 |
| `ruleIds` | `string` | 要操作的告警规则 ID，多个用逗号分隔 |

##### `type` SetBuiltInAlarmStatusResult

```typescript
[boolean, BuiltInAlarmList]
```

##### `type` BuiltInAlarmList

```typescript
export type BuiltInAlarmList = BuiltInAlarmRule[];
```

##### `type` BuiltInAlarmRule

| 属性 | 类型 | 描述 |
| --- | --- | --- |
| `auditStatus` | `number` | 审核状态 |
| `boundForPanel` | `boolean` | 是否被场景面板绑定 |
| `boundForWiFiPanel` | `boolean` | 是否被 WiFi 场景面板绑定 |
| `enabled` | `boolean` | 是否启用 |
| `i18nData` | `BuiltInAlarmI18nData` | 多语言数据体 |
| `id` | `string` | 规则 ID |
| `localLinkage` | `boolean` | 是否为本地联动 |
| `name` | `string` | 规则名称 |
| `newLocalScene` | `boolean` | 是否为 App 管控本地联动 |
| `stickyOnTop` | `boolean` | 场景是否显示在首页 |

##### `type` BuiltInAlarmI18nData

| 属性 | 类型 | 描述 |
| --- | --- | --- |
| `name` | `AlarmLocaleText` | 名称多语言 |
| `content` | `AlarmLocaleText` | 内容多语言 |

##### `type` AlarmLocaleText

| 属性 | 类型 | 描述 |
| --- | --- | --- |
| `en` | `string` | 英文文案 |
| `zh` | `string` | 中文文案 |


### 示例代码

#### 示例

```typescript
const [success, updatedList] = await sdm.alarm.setBuiltInAlarmStatus({
  disabled: false,
  ruleIds: 'rule_001,rule_002',
});
console.log('操作结果:', success, '更新后列表:', updatedList);
```