---
name: "getDeviceIdList"
mode: "kit"
versionRequirements:
  - { name: "HomeKit", version: "3.1.0" }
  - { name: "@ray-js/ray", version: "1.2.10" }
platform:
  - "iOS"
  - "Android"
async: true
title: "getDeviceIdList - 获取当前家庭下的设备 id 列表"
question:
  - "如何获取家庭下设备列表？"
---

## getDeviceIdList

> [VERSION] HomeKit >= 3.1.0 | @ray-js/ray >= 1.2.10

> [PLATFORM] iOS, Android

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

### 描述

从本地缓存中获取当前家庭下的设备id列表

### 参数

| 属性 | 类型 | 必填 | 默认值 | 最低版本 | 描述 |
| --- | --- | --- | --- | --- | --- |
| `ownerId` | `number` | 是 | - | `3.1.0` | 家庭id |
| `roomId` | `number` | 是 | - | `3.7.10` | 房间ID |
| `devId` | `string` | 是 | - | `3.8.0` | 设备id |
| `complete` | `() => void` | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） |
| `success` | `(params: Object) => void` ↓见下方 | 否 | - | - | 接口调用成功的回调函数 |
| `fail` | `(params: Object) => void` ↓见下方 | 否 | - | - | 接口调用失败的回调函数 |

#### success 回调参数

| 属性 | 类型 | 最低版本 | 描述 |
| --- | --- | --- | --- |
| `devIds` | `string[]` | `3.1.0` | 设备id列表 |

#### fail 回调参数

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

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

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


### 示例代码

#### Demo

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

home.getDeviceIdList({
  ownerId: 8069808,
  roomId: 57426831,
  devId: "6c2a2eiadnrgt0wd",
  success: data => {
    console.log(data);
  },
  fail: error => {
    console.error(error);
  },
});
```