家庭管理

更新时间:2024-08-23 09:47:59下载pdf

SDK 致力于为全屋智能业务场景的移动端开发提供全面的模块和组件支持。在这个框架中,家庭 是一个抽象概念,代表用户在以家或者场所为单位的范围内,管理设备、账号和权限等信息的集合。

主要能力

家庭管理模块包括以下主要功能:

  • 管理家庭列表:查询、添加、修改和移除单个家庭。
  • 家庭信息管理:管理家庭名称、地理位置以及天气查询等。
  • 家庭成员管理:查询、添加、删除和邀请成员列表等操作。
  • 设备与群组管理:获取家庭下所有设备和群组,支持设备的排序、添加、信息修改、监听移除以及设备状态变化的监听等。

通过这些功能,SDK 能够帮助您高效地管理和控制家庭下的各类信息和设备,满足全屋智能场景的各种需求。

示例代码

使用 ThingSmartFamilyBizThingSmartRoomBizThingSmartMemberBiz 单例,来管理家庭、房间和成员。

// Register observer
[[ThingSmartFamilyBiz sharedInstance] removeObserver:observer];
[[ThingSmartRoomBiz sharedInstance] removeObserver:observer];

// Get family list
[[ThingSmartFamilyBiz sharedInstance] getFamilyListWithSuccess:^(NSArray<ThingSmartHomeModel *> *homes) {

	} failure:^(NSError *error) {

}];

/// Get room list
[[ThingSmartRoomBiz sharedInstance] getRoomListWithHomeId:homeId success:^(NSArray<ThingSmartRoomModel *> *roomList) {

	} failure:^(NSError *error) {

}];

/// Get member list
[[ThingSmartMemberBiz sharedInstance] getHomeMemberListWithHomeId:homeId success:^(NSArray<ThingSmartHomeMemberModel *> * _Nonnull list) {

    } failure:^(NSError *error) {

}];

错误码

通用错误码

错误码 错误码描述
IS_BLANK 请求参数为空
OVER_LENGTH 请求参数超出长度限制
ILLEGAL 请求参数不合法
PERMISSION_DENIED 无权限
PERMISSION_VALIDATE_FAILED 无权限
GROUP_MANAGEMENT_DISABLED 无家庭管理权限
NUMEN_SERVER_BUSY 服务器繁忙

家庭模块错误码

接口名称 错误码 错误码描述
创建家庭 USER_ROOM_NAME_OUT_LENGTH 房间名称超出长度
解散家庭 GROUP_HAVE_SERVICE 家庭购买了增值服务,无法解散
创建默认家庭 ACQUIRE_LOCK_FAIL 获取默认家庭锁失败,无法同时创建 2 个默认家庭
GROUP_ALREADY_EXISTS 用户已拥有家庭,无法创建默认家庭
修改家庭信息 NOT_EXISTS 家庭不存在
ACQUIRE_LOCK_FAIL 获取家庭锁失败,无法同时修改同一家庭
家庭所有者转移权限 USER_GROUP_MEMBER_IS_DELETE 用户不在家庭中
ALREADY_GROUP_OWNER 该用户已是家庭拥有者
USER_NOT_ACCEPT 该用户未接受家庭邀请
移除家庭成员 REMOVE_ALL_BEFORE_LEAVING 家庭中仅剩 1 个用户,无法删除
添加家庭成员 MEMBER_FOR_ACCOUNT_NOT_EMPTY 添加管理员和自定义用户时,userAccount 不能为空
CAN_NOT_ADD_NOT_SMART_HOME_VERSION_USER 无法添加 App SDK 版本低于 3.0 的用户
USER_IS_IN_FAMILY_GROUP 用户已在家庭中
GROUP_NOT_EXIST 家庭不存在
更新成员信息 USER_NOT_EXISTS 用户不存在
USER_NOT_ACCEPT 该用户未接受家庭邀请
USER_GROUP_MEMBER_IS_DELETE 用户不在家庭中
家庭成员绑定关联账号 CAN_NOT_ADD_NOT_SMART_HOME_VERSION_USER 无法添加 App SDK 版本低于 3.0 的用户
USER_IS_IN_FAMILY_GROUP 用户已在家庭中
GROUP_NOT_EXIST 家庭不存在
邀请成员 INVITATION_CODE_FOR_LOCATION_OVER_LIMIT 达到家庭邀请码创建数量上限
通过邀请码添加成员 REACH_ACCESS_LIMIT 用户达到邀请码创建数量上限
USER_NOT_EXISTS 用户不存在
GROUP_NOT_EXIST 家庭不存在
USER_IS_IN_FAMILY_GROUP 用户已经在家庭中
重新邀请成员 INVITATION_CODE_INVALID_OR_NOT_EXIST 邀请码不存在
添加房间 NOT_EXISTS 家庭不存在
USER_ROOM_NAME_OUT_LENGTH 房间名称超出长度
ROOM_MAX_LIMIT_200 达到家庭下房间数量上限
移动房间设备或群组 INVALID_INPUT 输入参数不合法
更新房间名称 USER_ROOM_NAME_OUT_LENGTH 房间名称超出长度