概述
TXIoTFamilyManager 负责家庭的创建/删除/更新、房间的创建/删除/重命名，以及家庭成员的邀请与管理。TXIoTFamilyManager 通过 TXIoTEngine.getFamilyManager 获取实例，需在登录成功后调用。
说明：
家庭是设备的顶层组织单元，房间是家庭下的二级分组。用户创建家庭后自动成为 ADMIN，可通过
createFamilyInviteToken 生成邀请令牌，其他用户通过 joinFamilyAsMember 加入。方法列表
方法签名 | 描述 |
createFamily | 创建家庭。 |
deleteFamily | 删除家庭。 |
getFamilyList | 获取当前用户的家庭列表。 |
updateFamilyInfo | 更新家庭信息（如名称）。 |
createRoom | 在指定家庭下创建房间。 |
deleteRoom | 删除指定房间。 |
setRoomName | 设置/修改房间名称。 |
getRoomList | 获取指定家庭的房间列表。 |
createFamilyInviteToken | 创建家庭邀请令牌。 |
joinFamilyAsMember | 通过令牌加入家庭。 |
removeMemberFromFamily | 从家庭中移除成员。 |
getMemberList | 获取家庭成员列表。 |
createFamily
createFamily
createFamily | (name: string, callback: TXIoTCallback<TXIoTFamilyInfo>): void |
创建家庭
参数 | 描述 |
name | string；家庭名称。 |
callback | TXIoTCallback<TXIoTFamilyInfo>；异步回调，通过 onSuccess / onError 通知结果。 |
deleteFamily
deleteFamily
deleteFamily | (familyId: string, callback: TXIoTCallback<void>): void |
删除家庭
参数 | 描述 |
familyId | string；家庭 ID。 |
callback | TXIoTCallback<void>；异步回调，通过 onSuccess / onError 通知结果。 |
getFamilyList
getFamilyList
getFamilyList | (callback: TXIoTCallback<TXIoTFamilyInfo[]>): void |
获取当前用户的家庭列表
参数 | 描述 |
callback | TXIoTCallback<TXIoTFamilyInfo[]>；异步回调，通过 onSuccess / onError 通知结果。 |
updateFamilyInfo
updateFamilyInfo
updateFamilyInfo | (newFamilyInfo: TXIoTFamilyInfo, callback: TXIoTCallback<void>): void |
更新家庭信息（如名称）
参数 | 描述 |
newFamilyInfo | |
callback | TXIoTCallback<void>；异步回调，通过 onSuccess / onError 通知结果。 |
createRoom
createRoom
createRoom | (familyId: string, name: string, callback: TXIoTCallback<TXIoTRoomInfo>): void |
在指定家庭下创建房间
参数 | 描述 |
familyId | string；家庭 ID。 |
name | string；房间名称。 |
callback | TXIoTCallback<TXIoTRoomInfo>；异步回调，通过 onSuccess / onError 通知结果。 |
deleteRoom
deleteRoom
deleteRoom | (familyId: string, roomId: string, callback: TXIoTCallback<void>): void |
删除指定房间
参数 | 描述 |
familyId | string；家庭 ID。 |
roomId | string；房间 ID。 |
callback | TXIoTCallback<void>；异步回调，通过 onSuccess / onError 通知结果。 |
setRoomName
setRoomName
setRoomName | (familyId: string, roomId: string, name: string, callback: TXIoTCallback<void>): void |
设置/修改房间名称
参数 | 描述 |
familyId | string；家庭 ID。 |
roomId | string；房间 ID。 |
name | string；房间名称。 |
callback | TXIoTCallback<void>；异步回调，通过 onSuccess / onError 通知结果。 |
getRoomList
getRoomList
getRoomList | (familyId: string, callback: TXIoTCallback<TXIoTRoomInfo[]>): void |
获取指定家庭的房间列表
参数 | 描述 |
familyId | string；家庭 ID。 |
callback | TXIoTCallback<TXIoTRoomInfo[]>；异步回调，通过 onSuccess / onError 通知结果。 |
createFamilyInviteToken
createFamilyInviteToken
createFamilyInviteToken | (familyId: string, callback: TXIoTCallback<string>): void |
创建家庭邀请令牌
参数 | 描述 |
familyId | string；家庭 ID。 |
callback | TXIoTCallback<string>；异步回调，onSuccess 返回邀请令牌字符串。 |
joinFamilyAsMember
joinFamilyAsMember
joinFamilyAsMember | (inviteToken: string, callback: TXIoTCallback<void>): void |
通过令牌加入家庭
参数 | 描述 |
inviteToken | string；邀请令牌。 |
callback | TXIoTCallback<void>；异步回调，通过 onSuccess / onError 通知结果。 |
removeMemberFromFamily
removeMemberFromFamily
removeMemberFromFamily | (familyId: string, userId: string, callback: TXIoTCallback<void>): void |
从家庭中移除成员
参数 | 描述 |
familyId | string；家庭 ID。 |
userId | string；用户 ID，取 getMemberList 返回的 TXIoTUserInfo.userId 原值。 |
callback | TXIoTCallback<void>；异步回调，通过 onSuccess / onError 通知结果。 |
getMemberList
getMemberList
getMemberList | (familyId: string, callback: TXIoTCallback<TXIoTUserInfo[]>): void |
获取家庭成员列表
参数 | 描述 |
familyId | string；家庭 ID。 |
callback | TXIoTCallback<TXIoTUserInfo[]>；异步回调，通过 onSuccess / onError 通知结果。 |
注意：
该接口不支持分页，单次最多返回 50 条成员记录。
