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

TXIoTDeviceManager

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

我的收藏

概述

TXIoTDeviceManager 负责设备的绑定/解绑、房间归属、设备分享、指令下发、属性查询与别名修改等。TXIoTDeviceManager 通过 TXIoTEngine.getDeviceManager 获取实例,需在 TXIoTEngine 登录成功后调用。
说明:
回调模型:所有接口为异步操作,通过 TXIoTCallback / TXIoTVoidCallback 回调返回结果,回调在主线程触发。公共类型定义见 TXIoTEngineDef。

方法列表

方法签名
描述
绑定设备到指定家庭。
从家庭解绑设备。
将设备加入房间。
将设备移出房间。
获取家庭下的设备列表(支持分页)。
创建设备分享令牌。
绑定他人分享给我的设备。
解绑他人分享给我的设备。
获取设备被分享的用户列表。
移除设备的某个被分享用户。
获取分享给我的设备列表(支持分页)。
向设备下发控制指令。
获取设备属性。
修改设备别名。

bindDevice:deviceBindSignature:callback:

bindDevice:deviceBindSignature:callback:
void bindDevice:deviceBindSignature:callback:
(NSString* familyId, NSString* deviceBindSignature, TXIoTCallback<TXIoTDeviceInfo> callback)
绑定设备到指定家庭
参数
描述
familyId
NSString*;家庭 ID。
deviceBindSignature
NSString*;设备绑定签名。
callback
TXIoTCallback<TXIoTDeviceInfo>;异步回调,通过 onSuccess / onError 通知结果,成功时返回设备信息。

unbindDevice:deviceId:callback:

unbindDevice:deviceId:callback:
void unbindDevice:deviceId:callback:
(NSString* familyId, TXIoTDeviceId* deviceId, TXIoTVoidCallback* callback)
从家庭解绑设备
参数
描述
familyId
NSString*;家庭 ID。
deviceId
TXIoTDeviceId*;设备 ID。
callback
TXIoTVoidCallback*;异步回调,通过 onSuccess / onError 通知结果。

addDeviceToRoom:familyId:roomId:callback:

addDeviceToRoom:familyId:roomId:callback:
void addDeviceToRoom:familyId:roomId:callback:
(TXIoTDeviceId* deviceId, NSString* familyId, NSString* roomId, TXIoTVoidCallback* callback)
将设备加入房间
参数
描述
deviceId
TXIoTDeviceId*;设备 ID。
familyId
NSString*;家庭 ID。
roomId
NSString*;房间 ID。
callback
TXIoTVoidCallback*;异步回调,通过 onSuccess / onError 通知结果。

removeDeviceFromRoom:familyId:callback:

removeDeviceFromRoom:familyId:callback:
void removeDeviceFromRoom:familyId:callback:
(TXIoTDeviceId* deviceId, NSString* familyId, TXIoTVoidCallback* callback)
将设备移出房间
参数
描述
deviceId
TXIoTDeviceId*;设备 ID。
familyId
NSString*;家庭 ID。
callback
TXIoTVoidCallback*;异步回调,通过 onSuccess / onError 通知结果。

getDeviceList:nextPageToken:callback:

getDeviceList:nextPageToken:callback:
void getDeviceList:nextPageToken:callback:
(NSString* familyId, NSString* _Nullable nextPageToken, TXIoTCallback<TXIoTPageResult<TXIoTDeviceInfo>>* callback)
获取家庭下的设备列表(支持分页)
参数
描述
familyId
NSString*;家庭 ID。
nextPageToken
NSString* _Nullable;分页标记,首页传空字符串。
callback
TXIoTCallback<TXIoTPageResult<TXIoTDeviceInfo>>*;异步回调,通过 onSuccess / onError 通知结果。

createDeviceSharingToken:deviceId:callback:

createDeviceSharingToken:deviceId:callback:
void createDeviceSharingToken:deviceId:callback:
(NSString* familyId, TXIoTDeviceId* deviceId, TXIoTCallback<NSString*>* callback)
创建设备分享令牌
参数
描述
familyId
NSString*;家庭 ID。
deviceId
TXIoTDeviceId*;设备 ID。
callback
TXIoTCallback<NSString*>*;异步回调,通过 onSuccess / onError 通知结果,成功时返回分享令牌字符串。

bindDeviceSharedWithMe:shareToken:callback:

bindDeviceSharedWithMe:shareToken:callback:
void bindDeviceSharedWithMe:shareToken:callback:
(TXIoTDeviceId* deviceId, NSString* shareToken, TXIoTVoidCallback* callback)
绑定他人分享给我的设备
参数
描述
deviceId
TXIoTDeviceId*;设备 ID。
shareToken
NSString*;分享令牌。
callback
TXIoTVoidCallback*;异步回调,通过 onSuccess / onError 通知结果。

unbindDeviceSharedWithMe:callback:

unbindDeviceSharedWithMe:callback:
void unbindDeviceSharedWithMe:callback:
(TXIoTDeviceId* deviceId, TXIoTVoidCallback* callback)
解绑他人分享给我的设备
参数
描述
deviceId
TXIoTDeviceId*;设备 ID。
callback
TXIoTVoidCallback*;异步回调,通过 onSuccess / onError 通知结果。

getDeviceSharedUsers:callback:

getDeviceSharedUsers:callback:
void getDeviceSharedUsers:callback:
(TXIoTDeviceId* deviceId, TXIoTCallback<NSArray<TXIoTUserInfo*>> callback)
获取设备被分享的用户列表
参数
描述
deviceId
TXIoTDeviceId*;设备 ID。
callback
TXIoTCallback<NSArray<TXIoTUserInfo*>>;异步回调,通过 onSuccess / onError 通知结果,成功时返回用户列表。

removeDeviceSharedUser:userId:callback:

removeDeviceSharedUser:userId:callback:
void removeDeviceSharedUser:userId:callback:
(TXIoTDeviceId* deviceId, NSString* userId, TXIoTVoidCallback* callback)
移除设备的某个被分享用户
参数
描述
deviceId
TXIoTDeviceId*;设备 ID。
userId
NSString\\*;用户 ID。
callback
TXIoTVoidCallback*;异步回调,通过 onSuccess / onError 通知结果。

getDeviceListSharedWithMe:callback:

getDeviceListSharedWithMe:callback:
void getDeviceListSharedWithMe:callback:
(NSString* _Nullable nextPageToken, TXIoTCallback<TXIoTPageResult<TXIoTDeviceInfo>>* callback)
获取分享给我的设备列表(支持分页)
参数
描述
nextPageToken
NSString\\* _Nullable;分页标记,首页传 nil。
callback
TXIoTCallback<TXIoTPageResult<TXIoTDeviceInfo>>*;异步回调,通过 onSuccess / onError 通知结果,成功时返回分页结果。

sendCommand:jsonData:callback:

sendCommand:jsonData:callback:
void sendCommand:jsonData:callback:
(TXIoTDeviceId* deviceId, NSString* jsonData, TXIoTCallback<NSString*>* callback)
向设备下发控制指令
参数
描述
deviceId
TXIoTDeviceId*;设备 ID。
jsonData
NSString*;JSON 格式的控制指令数据。
callback
TXIoTCallback<NSString*>*;异步回调,通过 onSuccess / onError 通知结果,成功时返回设备响应数据。

getProperties:callback:

getProperties:callback:
void getProperties:callback:
(TXIoTDeviceId* deviceId, TXIoTCallback<NSString*>* callback)
获取设备属性
参数
描述
deviceId
TXIoTDeviceId*;设备 ID。
callback
TXIoTCallback<NSString*>*;异步回调,通过 onSuccess / onError 通知结果,成功时返回 JSON 格式的设备属性。

modifyAliasName:aliasName:callback:

modifyAliasName:aliasName:callback:
void modifyAliasName:aliasName:callback:
(TXIoTDeviceId* deviceId, NSString* aliasName, TXIoTVoidCallback* callback)
修改设备别名
参数
描述
deviceId
TXIoTDeviceId*;设备 ID。
aliasName
NSString*;新的别名。
callback
TXIoTVoidCallback*;异步回调,通过 onSuccess / onError 通知结果。