XLinkSDK

用户可以使用本类提供的内容实现SDK的启动、停止、退出登录、获取版本号等需求。

一、注意事项

XLinkSDK不允许创建新的实例对象,请务必使用提供的[XLinkSDK share]单例对象。

二、属性列表

参数名称 描述 类型 必选
cloudDelegate SDK云端连接状态回调代理 id
userDelegate SDK用户授权相关回调代理 id
dataDelegate SDK数据相关的delegate,包括接收到dataPoint的更新 id
deviceStateDelegate SDK设备状态相关的delegate,包括设备在线离线状态和设备属性的变化 id
xlinkConfig SDK全局的配置 XLinkConfig
userModel 当前登陆的用户 XLinkUserModel
started 判断sdk是否已经启动 BOOL

三、API 列表

1. 全局的单例对象

+ (instancetype)share;

支持的版本

开始支持的版本:5.0

注意事项

XLinkSDK不允许创建新的实例对象,请务必使用提供的[XLinkSDK share]单例对象。

输入参数

输出参数

错误码

2. 使用默认配置参数开始运行SDK

- (``void``)start;

支持的版本

开始支持的版本:5.0

注意事项

不需要多次调用start,但是调用stop之后,如果想再次使用sdk的话,就需要再次调用start。

输入参数

输出参数

错误码

3. 使用自定义配置参数开始运行SDK

- (``void``)startWithConfig:(XLinkConfig *)xlinkConfig;

支持的版本

开始支持的版本:5.0

注意事项

不需要多次调用start,但是调用stop之后,如果想再次使用sdk的话,就需要再次调用start。

输入参数

参数名称 描述 类型 必选
xlinkConfig 自定义的配置参数 XLinkConfig

输出参数

错误码

4. 停止SDK, 断开云端连接。

- (``void``)stop;

支持的版本

开始支持的版本:5.0

注意事项

调用stop之后,如果想再次使用sdk的话,就需要再次调用start。

输入参数

输出参数

错误码

5. 停止SDK, 断开云端连接,回收资源,清除授权信息。

- (``void``)logoutAndStop;

支持的版本

开始支持的版本:5.0

注意事项

调用logoutAndStop之后,如果想再次使用sdk的话,就需要再次调用start。

输入参数

输出参数

错误码

6. 获取SDK版本号。

+ (NSString *)getXLinkSDKVersion;

支持的版本

开始支持的版本:6.0

注意事项

返回当前SDK版本号的字符串。

输入参数

输出参数

具体的接口输出参数描述如下:

描述 类型 必选
SDK当前版本号 String

错误码

7. 开始执行任务

- (``void``)startTask:(XLinkTask *)task;

支持的版本

开始支持的版本:5.0

注意事项

输入参数

具体的接口输入参数描述如下:

参数名称 描述 类型 必选
task 要启动的任务 XLinkTask

输出参数

错误码

8. 结束任务执行

- (``void``)stopTask:(XLinkTask *)task;

支持的版本

开始支持的版本:5.0

注意事项

输入参数

具体的接口输入参数描述如下:

参数名称 描述 类型 必选
task 要结束的任务 XLinkTask

输出参数

错误码

四、协议(代理)方法列表

1. XLinkCloudDelegate

云端相关回调

1.1. SDK和云端连接状态回调

- (``void``)onCloudStateChangedWithCloudConnectionState:(CloudConnectionState)state;

当SDK与云平台连上/断开的时候,会回调这个方法

具体的接口参数描述如下:

参数名称 描述 类型 必选
state 连接状态 CloudConnectionState

CloudConnectionState的含义如下

参数名称 描述
CloudConnectionStateConnectFail 连接失败
CloudConnectionStateConnectConnecting 连接中
CloudConnectionStateConnectSuccess 连接成功

1.2. 云端推送消息回调

- (``void``)onReceiveEventNotify:(XLinkEventNotify *)eventNotify;

当SDK连接上云端,并接收到云端推送时,会回调这个方法。

具体的接口参数描述如下:

参数名称 描述 类型 必选
eventNotify 收到的云端推送信息 XLinkEventNotify

2. XLinkUserDelegate

用户授权结果回调

2.1. 用户下线回调

- (``void``)onUserLogout:(LogoutReason)reason;

用户被下线(被踢或者手动退出)/授权信息过期 的时候,会回调这个方法。 请根据LogoutReason进行处理

具体的接口参数描述如下:

参数名称 描述 类型 必选
reason 下线原因 LogoutReason

LogoutReason的含义如下

参数名称 描述
LogoutReasonUserLogout 用户主动退出
LogoutReasonSingleSignKickOff 单点登录。当前用户被踢出
LogoutReasonTokenExpired 用户凭证过期
LogoutReasonUserAuthInfoInvaild 用户授权信息不正确

3. XLinkDataDelegate

数据回调

3.1 设备数据端点上报回调

- (``void``)onDataPointUpdateWithDevice:(XDevice *)xDevice withList:(NSArray <XLinkDataPoint *> *)list;

当SDK收到设备上报的所以的数据端点时,会回调这个方法

具体的接口参数描述如下:

参数名称 描述 类型 必选
xDevice 接收到数据的设备 XDevice
list 数据端点列表 NSArray <XLinkDataPoint *>

4. XLinkDeviceStateDelegate

4.1. 设备连接状态变化回调

受SDK管理的设备(用户未调用XLinkSDK.getDeviceManager().removeDevice(xDevice))状态发生改变时

具体的接口参数描述如下:

参数名称 描述 类型 必选
xDevice 接收到数据的设备 XDevice
state 设备连接状态 XDeviceConnectionState

XDeviceConnectionState的含义如下

参数名称 描述
XDeviceConnectionStateDetached XDevice的状态未知
XDeviceConnectionStateOffline SDK设备与设备失去连接
XDeviceConnectionStateConnecting SDK正在连接设备
XDeviceConnectionStateOnline SDK设备保持连接

4.2. 设备属性变化回调

- (``void``)onDeviceChanged:(XDevice *)xDevice withEvent:(XDeviceEvent)event;

设备属性或者设备状态发生改变时,会回调这个方法。

具体的接口参数描述如下:

参数名称 描述 类型 必选
xDevice 接收到数据的设备 XDevice
event 设备改变的事件 XDeviceEvent

XDeviceConnectionState的含义如下

参数名称 描述
XDeviceEventUnSubscribe 订阅关系取消
XDeviceEventSubscribe 订阅关系建立
XDeviceEventInfoChanged 设备基本属性变化
XDeviceEventPropertyChanged 设备基本属性变化
没找到需要的文档?
你可以提交工单反馈 或 阅读常见问题