io.relayr.java.api

Interface ChannelApi

public interface ChannelApi

Method Summary

Modifier and Type	Method and Description
rx.Observable<DataChannel>	create(ChannelDefinition mqttDefinition) Creates an MQTT channel for a device specified with ChannelDefinition.deviceId Used in RelayrJavaSdk.getWebSocketClient() to create channels and subscribe to device readings.
rx.Observable<PublishChannel>	createForDevice(ChannelDefinition mqttDefinition, java.lang.String deviceId) Create channel to publish device data to.
rx.Observable<java.lang.Void>	delete(java.lang.String channelId) Deletes an MQTT channel
rx.Observable<ExistingChannel>	getChannels(java.lang.String deviceId) Returns existing MQTT channels for specified device.

Method Detail

create

@POST(value="/channels")
rx.Observable<DataChannel> create(@Body
                                                           ChannelDefinition mqttDefinition)

Creates an MQTT channel for a device specified with ChannelDefinition.deviceId Used in RelayrJavaSdk.getWebSocketClient() to create channels and subscribe to device readings.

Parameters:

mqttDefinition - - requires ChannelDefinition with ChannelTransport.MQTT

Returns:

an DataChannel with created MQTT channel credentials, Observer.onError(Throwable) otherwise

delete

@DELETE(value="/channels/{channelId}")
rx.Observable<java.lang.Void> delete(@Path(value="channelId")
                                                                            java.lang.String channelId)

Deletes an MQTT channel

Parameters:

channelId - existing channel ID

Returns:

an empty Observable if channel is deleted, Observer.onError(Throwable) otherwise

getChannels

@GET(value="/devices/{deviceId}/channels")
rx.Observable<ExistingChannel> getChannels(@Path(value="deviceId")
                                                                                      java.lang.String deviceId)

Returns existing MQTT channels for specified device.

Parameters:

deviceId - - device identificator

Returns:

an ExistingChannel, Observer.onError(Throwable) otherwise

createForDevice

@POST(value="/devices/{deviceId}/transmitter")
rx.Observable<PublishChannel> createForDevice(@Body
                                                                                             ChannelDefinition mqttDefinition,
                                                                                             @Path(value="deviceId")
                                                                                             java.lang.String deviceId)

Create channel to publish device data to.

Parameters:

mqttDefinition - defines deviceId and type of transport ChannelTransport.MQTT

deviceId - device identificator

Returns:

an PublishChannel, Observer.onError(Throwable) otherwise