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

TXIoTFamilyManager

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

我的收藏

本页目录：

概述

TXIoTFamilyManager 负责家庭的创建/删除/更新、房间的创建/删除/重命名，以及家庭成员的邀请与管理。TXIoTFamilyManager 通过 TXIoTEngine.getFamilyManager 获取实例，需在 TXIoTEngine 登录成功后调用。
说明：
回调模型：通过 TXIoTCallback / TXIoTVoidCallback 回调返回结果的接口，回调在主线程触发。

方法列表

方法签名
描述
创建家庭。
删除家庭。
获取家庭列表。
更新家庭信息。
在家庭下创建房间。
删除房间。
设置房间名称。
获取家庭下的房间列表。
创建家庭邀请令牌。
通过邀请令牌以成员身份加入家庭。
将成员移出家庭。
获取家庭成员列表。

createFamily:callback:

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

deleteFamily:callback:

deleteFamily:callback:
void deleteFamily:callback:
(NSString* familyId, TXIoTVoidCallback* callback)
删除家庭
参数
描述
familyId
NSString*；家庭 ID。
callback
TXIoTVoidCallback*；异步回调，通过 onSuccess / onError 通知结果。

getFamilyList:

getFamilyList:
void getFamilyList:
(TXIoTCallback<NSArray<TXIoTFamilyInfo*>> callback)
获取家庭列表
参数
描述
callback
TXIoTCallback<NSArray<TXIoTFamilyInfo*>>；异步回调，通过 onSuccess / onError 通知结果。

updateFamilyInfo:callback:

updateFamilyInfo:callback:
void updateFamilyInfo:callback:
(TXIoTFamilyInfo* newFamilyInfo, TXIoTVoidCallback* callback)
更新家庭信息
参数
描述
newFamilyInfo
TXIoTFamilyInfo*；新的家庭信息对象。
callback
TXIoTVoidCallback*；异步回调，通过 onSuccess / onError 通知结果。

createRoom:name:callback:

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

deleteRoom:roomId:callback:

deleteRoom:roomId:callback:
void deleteRoom:roomId:callback:
(NSString* familyId, NSString* roomId, TXIoTVoidCallback* callback)
删除房间
参数
描述
familyId
NSString*；家庭 ID。
roomId
NSString*；房间 ID。
callback
TXIoTVoidCallback*；异步回调，通过 onSuccess / onError 通知结果。

setRoomName:roomId:name:callback:

setRoomName:roomId:name:callback:
void setRoomName:roomId:name:callback:
(NSString* familyId, NSString* roomId, NSString* name, TXIoTVoidCallback* callback)
设置房间名称
参数
描述
familyId
NSString*；家庭 ID。
roomId
NSString*；房间 ID。
name
NSString*；新名称。
callback
TXIoTVoidCallback*；异步回调，通过 onSuccess / onError 通知结果。

getRoomList:callback:

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

createFamilyInviteToken:callback:

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

joinFamilyAsMember:callback:

joinFamilyAsMember:callback:
void joinFamilyAsMember:callback:
(NSString* inviteToken, TXIoTVoidCallback* callback)
通过邀请令牌以成员身份加入家庭
参数
描述
inviteToken
NSString*；邀请令牌。
callback
TXIoTVoidCallback*；异步回调，通过 onSuccess / onError 通知结果。

removeMemberFromFamily:userId:callback:

removeMemberFromFamily:userId:callback:
void removeMemberFromFamily:userId:callback:
(NSString* familyId, NSString* userId, TXIoTVoidCallback* callback)
将成员移出家庭
参数
描述
familyId
NSString*；家庭 ID。
userId
NSString*；用户 ID。
callback
TXIoTVoidCallback*；异步回调，通过 onSuccess / onError 通知结果。

getMemberList:callback:

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