LinkKit

java.lang.Object
- com.aliyun.alink.linkkit.api.LinkKit

All Implemented Interfaces:: ILinkKit

public class LinkKit
extends java.lang.Object
implements ILinkKit

LinkKit api 实现

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`deinit()` 反初始化接口清理内部状态，释放资源
`void`	`deviceRegister(Context context, LinkKitInitParams initParams, ARequest request, IConnectSendListener listener)` 一型一密使用 productKey、productSecret、deviceName 去云端换取 deviceSecret 的过程
`IDeviceCOTA`	`getDeviceCOTA()` 获取远程配置实例
`IDeviceLabel`	`getDeviceLabel()` 获取设备标签实例，可以使用该实例实现设备标签相关的功能。
`IDeviceShadow`	`getDeviceShadow()` 获取设备影子实例，可以使用该实例实现设备影子的相关操作。
`IThing`	`getDeviceThing()` 获取设备物模型操作实例，可以使用该实例实现设备属性上报、控制监听、时间上报、服务提供等。
`IGateway`	`getGateway()` 获取网关实例，可以实现网关子设备相关的管理功能。
`IStreamSender`	`getH2StreamClient()` 获取 H2 流发送实例
`static ILinkKit`	`getInstance()`
`IApiClient`	`getIoTApiClient()` IoT 套件对外 HTTP 请求接口
`IOta`	`getOta()` 获取OTA实例
`java.lang.String`	`getSDKVersion()`
`java.lang.String`	`getToSignString(java.util.Map<java.lang.String,java.lang.String> params)` 获取待签 String
`void`	`init(Context context, LinkKitInitParams params, ILinkKitConnectListener listener)` 初始化接口业务需要确保初始化成功，初始化成功之后，如果中间因为网络问题导致mqtt断链，SDK是会自动进行重连的，前提是没有关闭sdk的自动重连。重新初始化需要执行`ILinkKit.deinit()`方法，清除当前状态
`void`	`postLog(LogManager.RecLog recLog, IConnectSendListener iConnectSendListener)` 推送日志到云端的接口
`void`	`publish(ARequest request, IConnectSendListener listener)` 发布
`void`	`registerOnPushListener(IConnectNotifyListener listener)` 注册下行数据监听器这里会收到云端下行的所有事件
`void`	`reset(IConnectSendListener listener)` reset 当前设备的云端信息，如与当前设备的绑定关系，当前设备上报过的token
`void`	`setLevel(int level)` 设置云端允许上传日志等级
`void`	`subscribe(ARequest request, IConnectSubscribeListener listener)` 订阅设置 isSubscribe = true 需要注意的是订阅关系在云端是一直存在的，即使app被kill，云端订阅关系也是存在的。即只要订阅过一次，后续可以不进行重复订阅，云端针对这个topic的推送端上只要上线也是可以收到的。
`void`	`subscribeRRPC(ARequest request, IConnectRrpcListener listener)` RRPC 接口接口逻辑比较复杂，后续版本废弃，可以通过 subscribe+registerOnPushListener+publish 组合实现 1.
`void`	`unRegisterOnPushListener(IConnectNotifyListener listener)` 取消注册下行监听器需要和 `ILinkKit.registerOnPushListener(IConnectNotifyListener)` 成对出现
`void`	`unsubscribe(ARequest request, IConnectUnscribeListener listener)` 取消订阅设置 isSubscribe = false

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - init
```
public void init(Context context,
                 LinkKitInitParams params,
                 ILinkKitConnectListener listener)
```
    Description copied from interface: ILinkKit
    
    初始化接口业务需要确保初始化成功，初始化成功之后，如果中间因为网络问题导致mqtt断链，SDK是会自动进行重连的，前提是没有关闭sdk的自动重连。重新初始化需要执行ILinkKit.deinit()方法，清除当前状态
    
    Specified by:
    
    init in interface ILinkKit
    
    Parameters:
    
    context - 上下文，application context
    
    params - 初始化参数 LinkKitInitParams
    
    listener - 监听器 ILinkKitConnectListener
  - registerOnPushListener
```
public void registerOnPushListener(IConnectNotifyListener listener)
```
    Description copied from interface: ILinkKit
    
    注册下行数据监听器这里会收到云端下行的所有事件
    
    Specified by:
    
    registerOnPushListener in interface ILinkKit
    
    Parameters:
    
    listener - 监听器 IConnectNotifyListener
  - unRegisterOnPushListener
```
public void unRegisterOnPushListener(IConnectNotifyListener listener)
```
    Description copied from interface: ILinkKit
    
    取消注册下行监听器需要和 ILinkKit.registerOnPushListener(IConnectNotifyListener) 成对出现
    
    Specified by:
    
    unRegisterOnPushListener in interface ILinkKit
    
    Parameters:
    
    listener - 监听器 IConnectNotifyListener
  - deinit
```
public void deinit()
```
    Description copied from interface: ILinkKit
    
    反初始化接口清理内部状态，释放资源
    
    Specified by:
    
    deinit in interface ILinkKit
  - publish
```
public void publish(ARequest request,
                    IConnectSendListener listener)
```
    Description copied from interface: ILinkKit
    
    发布
    
    Specified by:
    
    publish in interface ILinkKit
    
    Parameters:
    
    request - 发布请求 MqttPublishRequest
    
    listener - 监听器 IConnectSendListener
  - subscribe
```
public void subscribe(ARequest request,
                      IConnectSubscribeListener listener)
```
    Description copied from interface: ILinkKit
    
    订阅设置 isSubscribe = true 需要注意的是订阅关系在云端是一直存在的，即使app被kill，云端订阅关系也是存在的。即只要订阅过一次，后续可以不进行重复订阅，云端针对这个topic的推送端上只要上线也是可以收到的。
    
    Specified by:
    
    subscribe in interface ILinkKit
    
    Parameters:
    
    request - 订阅请求 MqttSubscribeRequest
    
    listener - 监听器 IConnectSubscribeListener
  - unsubscribe
```
public void unsubscribe(ARequest request,
                        IConnectUnscribeListener listener)
```
    Description copied from interface: ILinkKit
    
    取消订阅设置 isSubscribe = false
    
    Specified by:
    
    unsubscribe in interface ILinkKit
    
    Parameters:
    
    request - 取消订阅请求 MqttSubscribeRequest
    
    listener - 监听器 IConnectUnscribeListener
  - subscribeRRPC
```
public void subscribeRRPC(ARequest request,
                          IConnectRrpcListener listener)
```
    Description copied from interface: ILinkKit
    
    RRPC 接口接口逻辑比较复杂，后续版本废弃，可以通过 subscribe+registerOnPushListener+publish 组合实现 1. 调用 registerOnPushListener 接口，注册全局下行监听； 2. 订阅云端系统或自定义topic，如topic=/ext/rrpc/+/${topic}； 3. 在 registerOnPushListener onNotify 方法里面接收下行 topic 消息，并调用 publish 接口发送 RRPC 响应。
    
    Specified by:
    
    subscribeRRPC in interface ILinkKit
    
    Parameters:
    
    request - RRPC 请求 MqttRrpcRegisterRequest
    
    listener - 监听器 IConnectRrpcListener
  - getIoTApiClient
```
public IApiClient getIoTApiClient()
```
    Description copied from interface: ILinkKit
    
    IoT 套件对外 HTTP 请求接口
    
    Specified by:
    
    getIoTApiClient in interface ILinkKit
  - getDeviceCOTA
```
public IDeviceCOTA getDeviceCOTA()
```
    Description copied from interface: ILinkKit
    
    获取远程配置实例
    
    Specified by:
    
    getDeviceCOTA in interface ILinkKit
    
    Returns:
    
    COTA远程配置实例
  - getGateway
```
public IGateway getGateway()
```
    Description copied from interface: ILinkKit
    
    获取网关实例，可以实现网关子设备相关的管理功能。
    
    Specified by:
    
    getGateway in interface ILinkKit
    
    Returns:
    
    网关管理实例
  - getDeviceShadow
```
public IDeviceShadow getDeviceShadow()
```
    Description copied from interface: ILinkKit
    
    获取设备影子实例，可以使用该实例实现设备影子的相关操作。
    
    Specified by:
    
    getDeviceShadow in interface ILinkKit
    
    Returns:
    
    设备影子实例
  - getDeviceLabel
```
public IDeviceLabel getDeviceLabel()
```
    Description copied from interface: ILinkKit
    
    获取设备标签实例，可以使用该实例实现设备标签相关的功能。
    
    Specified by:
    
    getDeviceLabel in interface ILinkKit
    
    Returns:
    
    设备标签实例
  - getDeviceThing
```
public IThing getDeviceThing()
```
    Description copied from interface: ILinkKit
    
    获取设备物模型操作实例，可以使用该实例实现设备属性上报、控制监听、时间上报、服务提供等。
    
    Specified by:
    
    getDeviceThing in interface ILinkKit
    
    Returns:
    
    设备物模型操作实例
  - getH2StreamClient
```
public IStreamSender getH2StreamClient()
```
    Description copied from interface: ILinkKit
    
    获取 H2 流发送实例
    
    Specified by:
    
    getH2StreamClient in interface ILinkKit
    
    Returns:
    
    H2 流发送操作实例
  - getOta
```
public IOta getOta()
```
    Description copied from interface: ILinkKit
    
    获取OTA实例
    
    Specified by:
    
    getOta in interface ILinkKit
    
    Returns:
    
    OTA实例
  - getToSignString
```
public java.lang.String getToSignString(java.util.Map<java.lang.String,java.lang.String> params)
```
    Description copied from interface: ILinkKit
    
    获取待签 String
    
    Specified by:
    
    getToSignString in interface ILinkKit
    
    Parameters:
    
    params - 签名参数
    
    Returns:
    
    签名结果
  - deviceRegister
```
public void deviceRegister(Context context,
                           LinkKitInitParams initParams,
                           ARequest request,
                           IConnectSendListener listener)
```
    Description copied from interface: ILinkKit
    
    一型一密使用 productKey、productSecret、deviceName 去云端换取 deviceSecret 的过程
    
    Specified by:
    
    deviceRegister in interface ILinkKit
    
    Parameters:
    
    context - 上下文
    
    initParams - 动态注册相关参数 LinkKitInitParams
    
    request - 请求 HubApiRequest
    
    listener - 请求结果监听器
  - reset
```
public void reset(IConnectSendListener listener)
```
    Description copied from interface: ILinkKit
    
    reset 当前设备的云端信息，如与当前设备的绑定关系，当前设备上报过的token
    
    Specified by:
    
    reset in interface ILinkKit
    
    Parameters:
    
    listener - 回调 IConnectSendListener
  - getSDKVersion
```
public java.lang.String getSDKVersion()
```
    Specified by:
    
    getSDKVersion in interface ILinkKit
    
    Returns:
    
    返回 linkkit 的sdk版本号
  - postLog
```
public void postLog(LogManager.RecLog recLog,
                    IConnectSendListener iConnectSendListener)
```
    Description copied from interface: ILinkKit
    
    推送日志到云端的接口
    
    Specified by:
    
    postLog in interface ILinkKit
  - setLevel
```
public void setLevel(int level)
```
    Description copied from interface: ILinkKit
    
    设置云端允许上传日志等级
    
    Specified by:
    
    setLevel in interface ILinkKit
  - getInstance
```
public static ILinkKit getInstance()
```

Class LinkKit

Method Summary

Methods inherited from class java.lang.Object

Method Detail

init

registerOnPushListener

unRegisterOnPushListener

deinit

publish

subscribe

unsubscribe

subscribeRRPC

getIoTApiClient

getDeviceCOTA

getGateway

getDeviceShadow

getDeviceLabel

getDeviceThing

getH2StreamClient

getOta

getToSignString

deviceRegister

reset

getSDKVersion

postLog

setLevel

getInstance