---
name: "unbindRule"
mode: "api"
versionRequirements:
  - { name: "@ray-js/ray", version: "1.5.15" }
title: "unbindRule - 解绑联动"
---

## unbindRule

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

### 描述

解绑联动，删除按键条件与场景规则的绑定关系

### 参数

`Params`

| 参数 | 类型 | 必填 | 描述 |
| --- | --- | --- | --- |
| `params` | `IUnbindRule` | 是 | 解绑规则参数 |

### 返回值

类型: `Promise<boolean>`

是否解绑成功

### 引用对象

##### `interface` IUnbindRule

| 属性 | 类型 | 描述 |
| --- | --- | --- |
| `bindId` | `string` | 绑定 ID |
| `gid` | `string` | 家庭 ID |


### 示例代码

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

const unbindSceneRule = async () => {
  try {
    const success = await unbindRule({
      bindId: '123456',
      gid: '12345678',
    });
    console.log('解绑结果:', success);
  } catch (err) {
    console.error('解绑失败:', err);
  }
};
```