概述
TXIoTFamilyManager 负责家庭的创建/删除/更新、房间的创建/删除/重命名，以及家庭成员的邀请与管理。TXIoTFamilyManager 通过 TXIoTEngine.getFamilyManager 获取实例，需在登录成功后调用。
说明：
家庭是设备的顶层组织单元，房间是家庭下的二级分组。可通过
createFamilyInviteToken 生成邀请令牌，其他用户通过 joinFamilyAsMember 加入。方法列表
方法签名 | 描述 |
创建家庭。 | |
删除家庭。 | |
获取当前用户的家庭列表。 | |
更新家庭信息（如名称）。 | |
在指定家庭下创建房间。 | |
删除指定房间。 | |
设置/修改房间名称。 | |
获取指定家庭的房间列表。 | |
创建家庭邀请令牌。 | |
通过令牌加入家庭。 | |
从家庭中移除成员。 | |
获取家庭成员列表。 |
createFamily
deleteFamily
deleteFamily
deleteFamily | (familyId) |
删除家庭
参数 | 描述 |
familyId | string；家庭 ID。 |
返回值 | 描述 |
Promise<void> | 操作结果。 |
getFamilyList
updateFamilyInfo
updateFamilyInfo
updateFamilyInfo | (familyInfo) |
createRoom
createRoom
createRoom | (familyId, name) |
deleteRoom
deleteRoom
deleteRoom | (familyId, roomId) |
删除指定房间
参数 | 描述 |
familyId | string；家庭 ID。 |
roomId | string；房间 ID。 |
返回值 | 描述 |
Promise<void> | 操作结果。 |
setRoomName
setRoomName
setRoomName | (familyId, roomId, name) |
设置/修改房间名称
参数 | 描述 |
familyId | string；家庭 ID。 |
roomId | string；房间 ID。 |
name | string；房间名称。 |
返回值 | 描述 |
Promise<void> | 操作结果。 |
getRoomList
getRoomList
getRoomList | (familyId) |
createFamilyInviteToken
createFamilyInviteToken
createFamilyInviteToken | (familyId) |
创建家庭邀请令牌
参数 | 描述 |
familyId | string；家庭 ID。 |
返回值 | 描述 |
Promise<String> | 邀请令牌。 |
joinFamilyAsMember
joinFamilyAsMember
joinFamilyAsMember | (inviteToken) |
通过令牌加入家庭
参数 | 描述 |
inviteToken | string；邀请令牌。 |
返回值 | 描述 |
Promise<void> | 操作结果。 |
removeMemberFromFamily
removeMemberFromFamily
removeMemberFromFamily | (familyId, userId) |
从家庭中移除成员
参数 | 描述 |
familyId | string；家庭 ID。 |
userId | string；用户 ID。 |
返回值 | 描述 |
Promise<void> | 操作结果。 |
getMemberList
getMemberList
getMemberList | (familyId) |
