---
name: "updateUnlockMethod"
mode: "api"
versionRequirements:
  - { name: "@ray-js/lock-sdk", version: "1.0.0" }
title: "updateUnlockMethod - 更新开锁方式。"
summary: "更新开锁方式。仅支持更新开锁方式名称和特殊开锁方式的通知信息。"
---

## updateUnlockMethod

> [VERSION] @ray-js/lock-sdk >= 1.0.0

### 描述

更新开锁方式

### 参数

| 参数 | 类型 | 必填 | 描述 |
| --- | --- | --- | --- |
| `id` | `number` | 是 | 开锁方式 id |
| `name` | `string` | 是 | 开锁方式名称 |
| `isSpecial` | `boolean` | 否 | 是否特殊 |
| `specialInfo` | `SpecialUnlockMethodInfo` | 否 | 特殊附加信息 |

##### SpecialUnlockMethodInfo 的属性

| 属性 | 类型 | 必填 | 默认值 | 描述 |
| --- | --- | --- | --- | --- |
| `appSend` | `boolean` | 否 | - | 是否支持 App 消息通知 |
| `msgSend` | `boolean` | 否 | - | 是否支持短信通知 |
| `msgPhone` | `string` | 否 | - | 短信通知手机号 |
| `verifyCode` | `string` | 否 | - | 手机验证码 |
| `countryCode` | `string` | 否 | - | 短信通知国家码 |


### 返回值

类型: `Promise<void>`

无（更新成功后 resolve）

### 错误码

| 错误码 | 错误信息 |
| --- | --- |
| `1057` | 不支持特殊密码且未开启 App 推送 |
| `1058` | 支持短信但未开启 App 推送且未开启短信 |
| `1066` | 短信号码为空 |
| `1056` | 国家码为空 |
| `1055` | 验证码为空 |

### 示例代码

#### 示例

```ts
import { updateUnlockMethod } from '@ray-js/lock-sdk';
await updateUnlockMethod({ id: 'method_001', name: '主人指纹' });
```