---
name: "updateTimer"
mode: "kit"
versionRequirements:
  - { name: "DeviceKit", version: "1.2.6" }
  - { name: "@ray-js/ray", version: "0.6.23" }
platform:
  - "iOS"
  - "Android"
async: true
title: "updateTimer - 更新定时"
---

## updateTimer

> [VERSION] DeviceKit >= 1.2.6 | @ray-js/ray >= 0.6.23

> [PLATFORM] iOS, Android

> ⚡ **支持 Promise 调用** — 不传 success / fail / complete 回调时，该方法返回 Promise。

### 描述

更新定时

### 参数

| 属性 | 类型 | 必填 | 默认值 | 最低版本 | 描述 |
| --- | --- | --- | --- | --- | --- |
| `deviceId` | `string` | 否 | - | `1.2.6` | deviceId 设备 id，deviceId 和 groupId 至少传一个 |
| `groupId` | `string` | 否 | - | `1.2.6` | groupId 群组 id，deviceId 和 groupId 至少传一个 |
| `timer` | `UpdateTimerModel` | 是 | - | `1.2.6` | timer 更新定时模型 |
| `complete` | `() => void` | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） |
| `success` | `() => void` | 否 | - | - | 接口调用成功的回调函数 |
| `fail` | `(params: Object) => void` ↓见下方 | 否 | - | - | 接口调用失败的回调函数 |

#### fail 回调参数

| 属性 | 类型 | 描述 |
| --- | --- | --- |
| `errorMsg` | `string` | 错误信息 |
| `errorCode` | `string \| number` | 错误码 |
| `innerError` | `Object` | 错误扩展 |

##### fail(params).innerError 的属性

| 属性 | 类型 | 描述 |
| --- | --- | --- |
| `errorCode` | `string \| number` | 错误扩展码 |
| `errorMsg` | `string` | 错误扩展信息 |


### 引用对象

##### `interface` UpdateTimerModel

| 属性 | 类型 | 最低版本 | 描述 |
| --- | --- | --- | --- |
| `timerId` | `string` | `1.2.6` | timerId 定时器 id |
| `time` | `string` | `1.2.6` | time 定时器运行的时间 |
| `loops` | `string` | `1.2.6` | loops 七位数字字符串，"1000000" 代表周日，"0100000" 代表周一 |
| `dps` | `Record<string, Record<string, any>>` | `1.2.6` | dps dp 点数据，示例： {     "1": true,     "2": false } |
| `aliasName` | `string` | `1.2.6` | aliasName 别名 |
| `isAppPush` | `boolean` | `1.2.6` | isAppPush 是否发送执行通知 |


### 示例代码

#### 基础调用

```tsx
import { device } from '@ray-js/ray'

const { updateTimer } = device;

updateTimer({
  timer: { timerId: 'example', time: 'example', loops: 'example', dps: {} },
  success: () => {
    console.log('updateTimer success');
  },
  fail: (error) => {
    console.log('updateTimer fail', error.errorMsg);
  },
});
```