getCurrentHomeInfo - 获取当前家庭信息

getCurrentHomeInfo(params: Object)

版本要求:

HomeKit≥1.0.4@ray-js/ray≥1.2.10

支持平台:

iOSAndroid

import { home } from '@ray-js/ray';

const { getCurrentHomeInfo } = home;

// Promise 调用
try {
  const res = await getCurrentHomeInfo();
  console.log(res);
} catch (err) {
  console.log(err.errorMsg);
}

描述

获取当前家庭信息

参数

属性	类型	必填	说明
`complete`	() => void	否	接口调用结束的回调函数（调用成功、失败都会执行）
`success`	(params: Object) => void	否	接口调用成功的回调函数
`fail`	(params: Object) => void	否	接口调用失败的回调函数

success 回调参数

属性	类型	说明	HomeKit 最低版本
`homeName`	string	家庭名称	v3.0.3
`homeId`	string	家庭id	v3.0.3
`longitude`	string	经度	v3.0.3
`latitude`	string	维度	v3.0.3
`address`	string	详细地址	v3.0.3
`admin`	boolean	是否是管理员 true 是管理员; false 非管理员	v3.0.3
`mode`	number	家庭模式，取值自 ThingSmartHomeMode	v3.7.8
`role`	number	家庭角色，取值自 ThingSmartHomeRole	v3.7.12

fail 回调参数

属性	类型	说明
`errorMsg`	string	错误信息
`errorCode`	string \| number	错误码
		错误扩展

返回值

无

示例代码

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

home.getCurrentHomeInfo({
  success: data => {
    console.log(data);
  },
  fail: error => {
    console.error(error);
  },
});