---
name: "getCurrentHomeInfo"
mode: "kit"
versionRequirements:
  - { name: "HomeKit", version: "1.0.4" }
  - { name: "@ray-js/ray", version: "1.2.10" }
platform:
  - "iOS"
  - "Android"
async: true
title: "getCurrentHomeInfo - 获取当前家庭信息"
---

## getCurrentHomeInfo

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

> [PLATFORM] iOS, Android

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

### 描述

获取当前家庭信息

### 参数

| 属性 | 类型 | 必填 | 默认值 | 描述 |
| --- | --- | --- | --- | --- |
| `complete` | `() => void` | 否 | - | 接口调用结束的回调函数（调用成功、失败都会执行） |
| `success` | `(params: Object) => void` ↓见下方 | 否 | - | 接口调用成功的回调函数 |
| `fail` | `(params: Object) => void` ↓见下方 | 否 | - | 接口调用失败的回调函数 |

#### success 回调参数

| 属性 | 类型 | 最低版本 | 描述 |
| --- | --- | --- | --- |
| `homeName` | `string` | `3.0.3` | 家庭名称 |
| `homeId` | `string` | `3.0.3` | 家庭id |
| `longitude` | `string` | `3.0.3` | 经度 |
| `latitude` | `string` | `3.0.3` | 维度 |
| `address` | `string` | `3.0.3` | 详细地址 |
| `admin` | `boolean` | `3.0.3` | 是否是管理员 true 是管理员; false 非管理员 |
| `mode` | `number` | `3.7.8` | 家庭模式，取值自 ThingSmartHomeMode |
| `role` | `number` | `3.7.12` | 家庭角色，取值自 ThingSmartHomeRole |

#### 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.getCurrentHomeInfo({
  success: data => {
    console.log(data);
  },
  fail: error => {
    console.error(error);
  },
});
```