帮你快速理解、总结文档立即下载

TXIoTFamilyManager

最近更新时间:2026-09-20 16:47:03
我的收藏

概述

TXIoTFamilyManager 负责家庭的创建/删除/更新、房间的创建/删除/重命名,以及家庭成员的邀请与管理。TXIoTFamilyManager 通过 TXIoTEngine.getFamilyManager 获取实例,需在登录成功后调用。
说明:
家庭是设备的顶层组织单元,房间是家庭下的二级分组。用户创建家庭后自动成为 ADMIN,可通过 createFamilyInviteToken 生成邀请令牌,其他用户通过 joinFamilyAsMember 加入。

方法列表

方法签名
描述
创建家庭。
删除家庭。
获取当前用户的家庭列表。
更新家庭信息(如名称)。
在指定家庭下创建房间。
删除指定房间。
设置/修改房间名称。
获取指定家庭的房间列表。
创建家庭邀请令牌。
通过令牌加入家庭。
从家庭中移除成员。
获取家庭成员列表。

createFamily

createFamily
createFamily
(String name)
创建家庭
参数
描述
name
String;名称。
返回值
描述
家庭信息。

deleteFamily

deleteFamily
deleteFamily
(String familyId)
删除家庭
参数
描述
familyId
String;家庭 ID。
返回值
描述
Promise<Void>
操作结果。

getFamilyList

getFamilyList
getFamilyList
()
获取当前用户的家庭列表
返回值
描述
Promise<TXIoTPageResult<TXIoTFamilyInfo>>
家庭信息列表。

updateFamilyInfo

updateFamilyInfo
updateFamilyInfo
(TXIoTFamilyInfo familyInfo)
更新家庭信息(如名称)
参数
描述
familyInfo
TXIoTFamilyInfo;新的家庭信息对象。
返回值
描述
Promise<Void>
操作结果。

createRoom

createRoom
createRoom
(String familyId, String name)
在指定家庭下创建房间
参数
描述
familyId
String;家庭 ID。
name
String;家庭名称。
返回值
描述
Promise<TXIoTRoomInfo>
房间信息。

deleteRoom

deleteRoom
deleteRoom
(String familyId, String roomId)
删除指定房间
参数
描述
familyId
String;家庭 ID。
roomId
String;房间 ID。
返回值
描述
Promise<Void>
操作结果。

setRoomName

setRoomName
setRoomName
(String familyId, String roomId, String name)
设置/修改房间名称
参数
描述
familyId
String;家庭 ID。
roomId
String;房间 ID。
name
String;房间名称。
返回值
描述
Promise<Void>
操作结果。

getRoomList

getRoomList
getRoomList
(String familyId)
获取指定家庭的房间列表
参数
描述
familyId
String;家庭 ID。
返回值
描述
Promise<TXIoTPageResult<TXIoTRoomInfo>>
房间信息列表。

createFamilyInviteToken

createFamilyInviteToken
createFamilyInviteToken
(String familyId)
创建家庭邀请令牌
参数
描述
familyId
String;家庭 ID。
返回值
描述
Promise<String>
邀请令牌。

joinFamilyAsMember

joinFamilyAsMember
joinFamilyAsMember
(String inviteToken)
通过令牌加入家庭
参数
描述
inviteToken
String;邀请令牌。
返回值
描述
Promise<Void>
操作结果。

removeMemberFromFamily

removeMemberFromFamily
removeMemberFromFamily
(String familyId, String userId)
从家庭中移除成员
参数
描述
familyId
String;家庭 ID。
userId
String;用户 ID。
返回值
描述
Promise<Void>
操作结果。

getMemberList

getMemberList
getMemberList
(String familyId)
获取家庭成员列表
参数
描述
familyId
String;家庭 ID。
返回值
描述
Promise<List<TXIoTUserInfo>>
家庭成员列表。