---
name: "triggerRule"
mode: "api"
versionRequirements:
  - { name: "@ray-js/ray", version: "1.7.60" }
title: "triggerRule - 一键触发场景联动"
---

## triggerRule

> [VERSION] @ray-js/ray >= 1.7.60

### 描述

一键触发场景联动，由云端执行关联的自动化规则

### 参数

`Params`

| 参数 | 类型 | 必填 | 描述 |
| --- | --- | --- | --- |
| `params` | `IRuleIdParams` | 是 | 触发规则参数 |

### 返回值

类型: `Promise<boolean>`

是否执行成功

### 引用对象

##### `interface` IRuleIdParams

| 属性 | 类型 | 描述 |
| --- | --- | --- |
| `ruleId` | `string` | 规则 ID |


### 示例代码

```typescript
import { triggerRule } from '@ray-js/ray';

const triggerSceneRule = async () => {
  try {
    const success = await triggerRule({
      ruleId: 'rule_001',
    });
    console.log('触发结果:', success);
  } catch (err) {
    console.error('触发失败:', err);
  }
};
```