概述
本文档描述 IoT App SDK 在 iOS 端的公共类型与枚举定义，包含错误码、通用枚举、公共数据结构与通用回调等，定义于
TXIoTEngineDef.h。说明：
TXIoTEngineDef.h 是各模块共用的基础类型定义头文件，各模块文档见：TXIoTEngine：引擎管理。
TXIoTFamilyManager：家庭与房间管理。
TXIoTDeviceManager：设备管理。
TXIoTCallSession：音视频通话。
TXIoTMonitorSession：实时监控。
错误码 — TXIoTErrorCode
TXIoTErrorCode
错误码 | 取值 | |
TXIoTErrorCodeSuccess | 0 | 成功。 |
TXIoTErrorCodeFailed | -1 | 通用失败。 |
TXIoTErrorCodeInvalidParameter | -2 | 参数非法。 |
TXIoTErrorCodeInvalidAccessToken | -3 | Access Token 无效。 |
TXIoTErrorCodeRateLimited | -4 | 请求频率超限。 |
TXIoTErrorCodeUnauthorizedOperation | -5 | 未授权操作。 |
TXIoTErrorCodeDeviceBound | -1000 | 设备已绑定。 |
TXIoTErrorCodeBindTokenNotExist | -1001 | 绑定令牌不存在。 |
TXIoTErrorCodeBindTokenIsExpired | -1002 | 绑定令牌已过期。 |
TXIoTErrorCodeBindTokenNoPairWithDevice | -1003 | 绑定令牌与设备不匹配。 |
TXIoTErrorCodeInvalidMessageId | -1004 | 消息 ID 无效。 |
TXIoTErrorCodeFamilyDeviceLimitExceeded | -1005 | 家庭设备数量超限。 |
TXIoTErrorCodeCanNotBindSameFamily | -1006 | 不能绑定到同一家庭。 |
TXIoTErrorCodeFamilyNotExist | -1007 | 家庭不存在。 |
TXIoTErrorCodeProductNotExist | -1008 | 产品不存在。 |
TXIoTErrorCodeDeviceNotExist | -1009 | 设备不存在。 |
TXIoTErrorCodeDeviceOffline | -1010 | 设备离线。 |
TXIoTErrorCodeCameraStartFail | -2000 | 摄像头启动失败。 |
TXIoTErrorCodeCameraNotAuthorized | -2001 | 摄像头权限未授权。 |
TXIoTErrorCodeCameraOccupy | -2002 | 摄像头被占用。 |
TXIoTErrorCodeMicStartFail | -2003 | 麦克风启动失败。 |
TXIoTErrorCodeMicNotAuthorized | -2004 | 麦克风权限未授权。 |
TXIoTErrorCodeMicOccupy | -2005 | 麦克风被占用。 |
TXIoTErrorCodeSpeakerStartFail | -2006 | 扬声器启动失败。 |
TXIoTErrorCodeRecordDurationTooShort | -2007 | 录制时长过短。 |
TXIoTErrorCodeFilePathUnwritable | -2008 | 文件路径不可写。 |
TXIoTErrorCodeFilePathAlreadyExist | -2009 | 文件路径已存在。 |
TXIoTErrorCodeDeviceSwitchToVoIP | -2010 | 设备切换到 VOIP 模式。 |
通用枚举
TXIoTFamilyRole
TXIoTFamilyRole
家庭角色。
枚举 | 取值 |
TXIoTFamilyRoleUnknown | 0 |
TXIoTFamilyRoleMember | 1 |
TXIoTFamilyRoleAdmin | 2 |
公共数据结构
TXIoTDeviceId
TXIoTDeviceId
字段 | 说明 |
productId | 产品 ID。 |
deviceName | 设备名称。 |
TXIoTDeviceStatus
TXIoTDeviceStatus
设备在线状态。
字段 | 说明 |
isOnline | 是否在线。 |
onlineDuration | 累计在线时长（单位：秒）。 |
bringOnlineTime | 上线时间戳（Unix 秒级时间戳）。 |
TXIoTDeviceInfo
TXIoTDeviceInfo
字段 | 说明 |
deviceId | 设备 ID。 |
aliasName | 设备别名。 |
familyId | 所属家庭 ID。 |
roomId | 所属房间 ID。 |
iconUrl | 设备图标 URL。 |
createTime | 创建时间（Unix 秒级时间戳）。 |
updateTime | 更新时间（Unix 秒级时间戳）。 |
status | 设备在线状态。 |
TXIoTFamilyInfo
TXIoTFamilyInfo
字段 | 说明 |
familyId | 家庭 ID。 |
name | 家庭名称。 |
createTime | 创建时间（Unix 秒级时间戳）。 |
updateTime | 更新时间（Unix 秒级时间戳）。 |
role | 当前用户在该家庭中的角色。 |
TXIoTRoomInfo
TXIoTRoomInfo
字段 | 说明 |
roomId | 房间 ID。 |
name | 房间名称。 |
familyId | 所属家庭 ID。 |
deviceCount | 房间内设备数量。 |
createTime | 创建时间（Unix 秒级时间戳）。 |
updateTime | 更新时间（Unix 秒级时间戳）。 |
TXIoTUserInfo
TXIoTUserInfo
字段 | 说明 |
userId | 用户 ID。 |
nickName | 用户昵称。 |
avatarUrl | 用户头像 URL。 |
role | 用户角色。 |
deviceBindTime | 设备绑定时间（Unix 秒级时间戳）。 |
TXIoTPageResult<T>
TXIoTPageResult<T>
字段 | 说明 |
dataList | 当前页数据列表。 |
nextPageToken | 下一页游标；首次查询传空字符串，取结果中返回值用于获取下一页；为空字符串表示已到最后一页。 |
通用回调
TXIoTCallback<ResultType>
TXIoTCallback<ResultType>
有返回值的异步回调。
@interface TXIoTCallback<__covariant ResultType> : NSObject@property(nonatomic, copy) void (^onSuccess)(ResultType _Nullable result);@property(nonatomic, copy) void (^onError)(TXIoTErrorCode errorCode, NSString* _Nullable errorMessage);@end
TXIoTVoidCallback
TXIoTVoidCallback
无返回值的异步回调。
@interface TXIoTVoidCallback : NSObject@property(nonatomic, copy) void (^onSuccess)(void);@property(nonatomic, copy) void (^onError)(TXIoTErrorCode errorCode, NSString* _Nullable errorMessage);@end
