---
name: "toggleDeviceOfflineReminder"
mode: "kit"
versionRequirements:
  - { name: "DeviceKit", version: "2.2.0" }
  - { name: "@ray-js/ray", version: "0.6.23" }
platform:
  - "iOS"
  - "Android"
async: true
---

## toggleDeviceOfflineReminder

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

> [PLATFORM] iOS, Android

> ⚡ **Supports Promise** — Returns a Promise when success / fail / complete callbacks are omitted.

### Method signature

```typescript
toggleDeviceOfflineReminder(params: Object)
```

### Description

Offline alert switch

### Parameters

| Property | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `deviceId` | `string` | Yes | - | deviceId Device ID |
| `state` | `number` | Yes | - | state Switch state for the device's offline alert: 0=Off, 1=On |
| `complete` | `() => void` | No | - | Completion callback (executed on both success and failure) |
| `success` | `() => void` | No | - | Callback on successful API call |
| `fail` | `(params: Object) => void` ↓see below | No | - | Failure callback |

#### fail callback parameters

| Property | Type | Description |
| --- | --- | --- |
| `errorMsg` | `string` | Error message |
| `errorCode` | `string \| number` | Error code |
| `innerError` | `Object` | Error extension |

##### fail(params).innerError properties

| Property | Type | Description |
| --- | --- | --- |
| `errorCode` | `string \| number` | Error extension code |
| `errorMsg` | `string` | Error extension message |


### Examples

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

device.toggleDeviceOfflineReminder({
  deviceId: "6ca3910474f71f05e1x9bv",
  state: 1,
  success: data => {
    console.log(data);
  },
  fail: error => {
    console.error(error);
  },
});
```
