GatewayChannel

java.lang.Object
- com.aliyun.alink.linksdk.channel.gateway.api.GatewayChannel

所有已实现的接口:: IGatewayChannel

public class GatewayChannel
extends java.lang.Object
implements IGatewayChannel

设备网关入口类

字段概要

字段
限定符和类型	字段和说明
`static java.lang.String`	`DID_SEPARATOR`
`static java.lang.String`	`METHOD_PRESET_SUBDEV_REGITER`
`static java.lang.String`	`TOPIC_PRESET_SUBDEV_REGITER`

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`void`	`addSubDevice(SubDeviceInfo deviceInfo, ISubDeviceConnectListener subDeviceConnectListener)` 建立 topo 关系
`void`	`asyncSendRequest(java.lang.String topic, java.lang.String method, java.util.Map<java.lang.String,java.lang.Object> opts, java.lang.Object params, IGatewayRequestListener listener)` RPC请求接口，封装了业务的上行request以及下行resp。
`void`	`ayncSendPublishRequest(java.lang.String topic, java.lang.String method, java.util.Map<java.lang.String,java.lang.Object> opts, java.lang.Object params, IGatewayRequestListener listener)` 发布消息接口，不同于asyncSendRequest。
`void`	`destroyConnect()` 断开长链接通道
`void`	`deviceListUpload(java.util.List<SubDeviceInfo> foundList, IConnectSendListener listener)` 上报发现的子设备列表可能用于第三方应用获取并选择添加拓扑关系
`GatewayConnectState`	`getGatewayConnectState()` 获取当前长连接通道状态
`static IGatewayChannel`	`getInstance()`
`ISubDeviceChannel`	`getSubDeviceChannel(java.lang.String sudDeviceId)` 获取子设备连接通道
`void`	`getSubDevices(IConnectSendListener listener)` 获取子设备列表
`void`	`registerDownstreamListener(boolean uiSafey, IGatewayDownstreamListener listener)` 设置通道的下推回调，如果不需要用的时候，unRegisterDownstreamListener
`void`	`removeSubDevice(SubDeviceInfo subDeviceInfo, ISubDeviceRemoveListener removeListener)` 删除 topo 关系
`void`	`setNeedAutoLoginSubdevice(boolean needAutoLoginSubdevice)`
`void`	`startConnect(Context context, PersistentConnectConfig config, IGatewayConnectListener listener)` 长连接通道启动接口，应用起来时调用一次
`void`	`startConnectReuseMobileChannel(Context context, IGatewayConnectListener listener)` 长连接通道启动借口给，复用Mobile Channel接口
`void`	`subDeviceRegister(ARequest requestData, IConnectSendListener listener)` 子设备动态注册通用接口，上报数据由用户封装，topic如果为空则默认使用 /sys/pk/dn/thing/proxy/provisioning/product_register 当前version 使用 1.0
`void`	`subDeviceRegister(java.util.List<SubDeviceInfo> infoList, IConnectSendListener listener)` 子设备动态注册
`void`	`subDevicUnregister(java.util.List<SubDeviceInfo> infoList, IConnectSendListener listener)` 取消子设备动态注册
`void`	`subscribe(java.lang.String topic, IGatewaySubscribeListener listener)` app订阅topic的接口
`void`	`unRegisterDownstreamListener(IGatewayDownstreamListener listener)` 取消某个通道的下推回调
`void`	`unSubscribe(java.lang.String topic, IGatewaySubscribeListener listener)` app取消订阅topic的接口

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 字段详细资料
  - DID_SEPARATOR
```
public static final java.lang.String DID_SEPARATOR
```
    另请参阅:
    
    常量字段值
  - TOPIC_PRESET_SUBDEV_REGITER
```
public static final java.lang.String TOPIC_PRESET_SUBDEV_REGITER
```
    另请参阅:
    
    常量字段值
  - METHOD_PRESET_SUBDEV_REGITER
```
public static final java.lang.String METHOD_PRESET_SUBDEV_REGITER
```
    另请参阅:
    
    常量字段值
- 方法详细资料
  - setNeedAutoLoginSubdevice
```
public void setNeedAutoLoginSubdevice(boolean needAutoLoginSubdevice)
```
  - getInstance
```
public static IGatewayChannel getInstance()
```
  - startConnect
```
public void startConnect(Context context,
                         PersistentConnectConfig config,
                         IGatewayConnectListener listener)
```
    从接口复制的说明: IGatewayChannel
    
    长连接通道启动接口，应用起来时调用一次
    
    指定者:
    
    startConnect 在接口中 IGatewayChannel
    
    config - 通道建联配置项
    
    listener - 反馈通道状态变化
  - startConnectReuseMobileChannel
```
public void startConnectReuseMobileChannel(Context context,
                                           IGatewayConnectListener listener)
```
    从接口复制的说明: IGatewayChannel
    
    长连接通道启动借口给，复用Mobile Channel接口
    
    指定者:
    
    startConnectReuseMobileChannel 在接口中 IGatewayChannel
    
    listener - 反馈通道状态变化
  - getGatewayConnectState
```
public GatewayConnectState getGatewayConnectState()
```
    从接口复制的说明: IGatewayChannel
    
    获取当前长连接通道状态
    
    指定者:
    
    getGatewayConnectState 在接口中 IGatewayChannel
    
    返回:
    
    当前连接专题该你
  - subDeviceRegister
```
public void subDeviceRegister(java.util.List<SubDeviceInfo> infoList,
                              IConnectSendListener listener)
```
    从接口复制的说明: IGatewayChannel
    
    子设备动态注册
    
    指定者:
    
    subDeviceRegister 在接口中 IGatewayChannel
    
    参数:
    
    infoList - 子设备列表
    
    listener - 监听器
  - subDeviceRegister
```
public void subDeviceRegister(ARequest requestData,
                              IConnectSendListener listener)
```
    从接口复制的说明: IGatewayChannel
    
    子设备动态注册通用接口，上报数据由用户封装，topic如果为空则默认使用 /sys/pk/dn/thing/proxy/provisioning/product_register 当前version 使用 1.0
    
    指定者:
    
    subDeviceRegister 在接口中 IGatewayChannel
    
    参数:
    
    requestData - 需要动态注册的列表数据
    
    listener - 监听器
  - subDevicUnregister
```
public void subDevicUnregister(java.util.List<SubDeviceInfo> infoList,
                               IConnectSendListener listener)
```
    从接口复制的说明: IGatewayChannel
    
    取消子设备动态注册
    
    指定者:
    
    subDevicUnregister 在接口中 IGatewayChannel
    
    参数:
    
    infoList - 子设备列表
    
    listener - 监听器
  - addSubDevice
```
public void addSubDevice(SubDeviceInfo deviceInfo,
                         ISubDeviceConnectListener subDeviceConnectListener)
```
    从接口复制的说明: IGatewayChannel
    
    建立 topo 关系
    
    指定者:
    
    addSubDevice 在接口中 IGatewayChannel
    
    参数:
    
    deviceInfo - 子设备信息
    
    subDeviceConnectListener - 子设备上下行数据通道
  - removeSubDevice
```
public void removeSubDevice(SubDeviceInfo subDeviceInfo,
                            ISubDeviceRemoveListener removeListener)
```
    从接口复制的说明: IGatewayChannel
    
    删除 topo 关系
    
    指定者:
    
    removeSubDevice 在接口中 IGatewayChannel
    
    参数:
    
    subDeviceInfo - 子设备信息
  - getSubDevices
```
public void getSubDevices(IConnectSendListener listener)
```
    从接口复制的说明: IGatewayChannel
    
    获取子设备列表
    
    指定者:
    
    getSubDevices 在接口中 IGatewayChannel
    
    参数:
    
    listener - 监听器
  - deviceListUpload
```
public void deviceListUpload(java.util.List<SubDeviceInfo> foundList,
                             IConnectSendListener listener)
```
    从接口复制的说明: IGatewayChannel
    
    上报发现的子设备列表可能用于第三方应用获取并选择添加拓扑关系
    
    指定者:
    
    deviceListUpload 在接口中 IGatewayChannel
    
    参数:
    
    foundList - 子设备列表
    
    listener - 监听器
  - asyncSendRequest
```
public void asyncSendRequest(java.lang.String topic,
                             java.lang.String method,
                             java.util.Map<java.lang.String,java.lang.Object> opts,
                             java.lang.Object params,
                             IGatewayRequestListener listener)
```
    从接口复制的说明: IGatewayChannel
    
    RPC请求接口，封装了业务的上行request以及下行resp。
    
    指定者:
    
    asyncSendRequest 在接口中 IGatewayChannel
    
    参数:
    
    topic - topic rpc请求的topic，由具体业务确定，完整topic形如： /sys/${productKey}/${deviceName}/app/abc/cba 其中App 端 Topic 订阅协议前缀：/sys/${productKey}/${deviceName}/app/ 所以开发者只需要传完整topic的业务部分，如上例中的abc/cba即可。也可以使用通配符如abc/#.
    
    method - payload 中的method
    
    opts - 可选配置项，可空，预留
    
    params - 业务参数。
    
    listener - 业务服务器响应回调接口
  - ayncSendPublishRequest
```
public void ayncSendPublishRequest(java.lang.String topic,
                                   java.lang.String method,
                                   java.util.Map<java.lang.String,java.lang.Object> opts,
                                   java.lang.Object params,
                                   IGatewayRequestListener listener)
```
    从接口复制的说明: IGatewayChannel
    
    发布消息接口，不同于asyncSendRequest。这个接口不会有业务回执。
    
    指定者:
    
    ayncSendPublishRequest 在接口中 IGatewayChannel
    
    参数:
    
    topic - rpc请求的topic，由具体业务确定，上行的完整topic形如： /sys/${productKey}/${deviceName}/app/up/abc/cba 其中App 端 Topic 订阅协议前缀：/sys/${productKey}/${deviceName}/app/up 在sdk中会自动补齐。所以开发者只需要传完整topic的业务部分，如上例中的/abc/cba即可。也可以使用通配符如/abc/#.
  - subscribe
```
public void subscribe(java.lang.String topic,
                      IGatewaySubscribeListener listener)
```
    从接口复制的说明: IGatewayChannel
    
    app订阅topic的接口
    
    指定者:
    
    subscribe 在接口中 IGatewayChannel
    
    参数:
    
    topic - 订阅的消息的topic，由具体业务确定，只需要传业务方的区段，公用区段不需要传. 可以参见invokeWithTopic:opts:params:respHandler: 中的topic定义
    
    listener - 订阅流程结束的监听
  - unSubscribe
```
public void unSubscribe(java.lang.String topic,
                        IGatewaySubscribeListener listener)
```
    从接口复制的说明: IGatewayChannel
    
    app取消订阅topic的接口
    
    指定者:
    
    unSubscribe 在接口中 IGatewayChannel
    
    参数:
    
    topic - 订阅的消息的topic，由具体业务确定，只需要传业务方的区段，公用区段不需要传. 可以参见asyncSendRequest 中的topic定义
    
    listener - 订阅流程结束的监听
  - registerDownstreamListener
```
public void registerDownstreamListener(boolean uiSafey,
                                       IGatewayDownstreamListener listener)
```
    从接口复制的说明: IGatewayChannel
    
    设置通道的下推回调，如果不需要用的时候，unRegisterDownstreamListener
    
    指定者:
    
    registerDownstreamListener 在接口中 IGatewayChannel
    
    参数:
    
    uiSafey - 是否要在UI线程里回调，建议为YES
  - unRegisterDownstreamListener
```
public void unRegisterDownstreamListener(IGatewayDownstreamListener listener)
```
    从接口复制的说明: IGatewayChannel
    
    取消某个通道的下推回调
    
    指定者:
    
    unRegisterDownstreamListener 在接口中 IGatewayChannel
  - getSubDeviceChannel
```
public ISubDeviceChannel getSubDeviceChannel(java.lang.String sudDeviceId)
```
    从接口复制的说明: IGatewayChannel
    
    获取子设备连接通道
    
    指定者:
    
    getSubDeviceChannel 在接口中 IGatewayChannel
    
    参数:
    
    sudDeviceId - 子设备ID pk+dn
    
    返回:
    
    子设备连接通道
  - destroyConnect
```
public void destroyConnect()
```
    从接口复制的说明: IGatewayChannel
    
    断开长链接通道
    
    指定者:
    
    destroyConnect 在接口中 IGatewayChannel

类 GatewayChannel

字段概要

方法概要

从类继承的方法 java.lang.Object

字段详细资料

DID_SEPARATOR

TOPIC_PRESET_SUBDEV_REGITER

METHOD_PRESET_SUBDEV_REGITER

方法详细资料

setNeedAutoLoginSubdevice

getInstance

startConnect

startConnectReuseMobileChannel

getGatewayConnectState

subDeviceRegister

subDeviceRegister

subDevicUnregister

addSubDevice

removeSubDevice

getSubDevices

deviceListUpload

asyncSendRequest

ayncSendPublishRequest

subscribe

unSubscribe

registerDownstreamListener

unRegisterDownstreamListener

getSubDeviceChannel

destroyConnect