帮你快速理解、总结文档立即下载
文档中心>物联网开发平台>客户端 API>Android>TXIoTFamilyManager

TXIoTFamilyManager

最近更新时间：2026-07-30 12:00:38

我的收藏

本页目录：

概述

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

方法列表

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

createFamily

createFamily
void createFamily
(String name, TXIoTCallback<TXIoTFamilyInfo> callback)
创建家庭
参数
描述
name
String；名称。
callback
TXIoTCallback<TXIoTFamilyInfo>；异步回调，通过 onSuccess / onError 回调通知结果。

deleteFamily

deleteFamily
void deleteFamily
(String familyId, TXIoTCallback<Void> callback)
删除家庭
参数
描述
familyId
String；家庭 ID。
callback
TXIoTCallback<Void>；异步回调，通过 onSuccess / onError 通知结果。

getFamilyList

getFamilyList
void getFamilyList
(TXIoTCallback<List<TXIoTFamilyInfo>> callback)
获取当前用户的家庭列表
参数
描述
callback
TXIoTCallback<List<TXIoTFamilyInfo>>；异步回调，通过 onSuccess / onError 通知结果。

updateFamilyInfo

updateFamilyInfo
void updateFamilyInfo
(TXIoTFamilyInfo newFamilyInfo, TXIoTCallback<Void> callback)
更新家庭信息（如名称）
参数
描述
newFamilyInfo
TXIoTFamilyInfo；TXIoTFamilyInfo 类型对象。
callback
TXIoTCallback<Void>；异步回调，通过 onSuccess / onError 通知结果。

createRoom

createRoom
void createRoom
(String familyId, String name, TXIoTCallback<TXIoTRoomInfo> callback)
在指定家庭下创建房间
参数
描述
familyId
String；家庭 ID。
name
String；家庭名称。
callback
TXIoTCallback<TXIoTRoomInfo>；异步回调，通过 onSuccess / onError 通知结果。

deleteRoom

deleteRoom
void deleteRoom
(String familyId, String roomId, TXIoTCallback<Void> callback)
删除指定房间
参数
描述
familyId
String；家庭 ID。
roomId
String；房间 ID。
callback
TXIoTCallback<Void>；异步回调，通过 onSuccess / onError 通知结果。

setRoomName

setRoomName
void setRoomName
(String familyId, String roomId, String name, TXIoTCallback<Void> callback)
设置/修改房间名称
参数
描述
familyId
String；家庭 ID。
roomId
String；房间 ID。
name
String；房间名称。
callback
TXIoTCallback<Void>；异步回调，通过 onSuccess / onError 通知结果。

getRoomList

getRoomList
void getRoomList
(String familyId, TXIoTCallback<List<TXIoTRoomInfo>> callback)
获取指定家庭的房间列表
参数
描述
familyId
String；家庭 ID。
callback
TXIoTCallback<List<TXIoTRoomInfo>>；异步回调，通过 onSuccess / onError 通知结果。

createFamilyInviteToken

createFamilyInviteToken
void createFamilyInviteToken
(String familyId, TXIoTCallback<String> callback)
创建家庭邀请令牌
参数
描述
familyId
String；家庭 ID。
callback
TXIoTCallback<String>；异步回调，通过 onSuccess / onError 通知结果。

joinFamilyAsMember

joinFamilyAsMember
void joinFamilyAsMember
(String inviteToken, TXIoTCallback<Void> callback)
通过令牌加入家庭
参数
描述
inviteToken
String；邀请令牌。
callback
TXIoTCallback<Void>；异步回调，通过 onSuccess / onError 通知结果。

removeMemberFromFamily

removeMemberFromFamily
void removeMemberFromFamily
(String familyId, String userId, TXIoTCallback<Void> callback)
从家庭中移除成员
参数
描述
familyId
String；家庭 ID。
userId
String；用户 ID。
callback
TXIoTCallback<Void>；异步回调，通过 onSuccess / onError 通知结果。

getMemberList

getMemberList
void getMemberList
(String familyId, TXIoTCallback<List<TXIoTUserInfo>> callback)
获取家庭成员列表
参数
描述
familyId
String；家庭 ID。
callback
TXIoTCallback<List<TXIoTUserInfo>>；异步回调，通过 onSuccess / onError 通知结果。
中国站