io.relayr.java.api

Interface RelayrApi

public interface RelayrApi

This class incorporates a wrapped version of the relayr API calls.

Method Summary

Modifier and Type	Method and Description
rx.Observable<java.lang.Void>	deleteTransmitter(java.lang.String transmitterId) Deletes a transmitter and all of its components (Transmitter and Devices)
rx.Observable<java.lang.Void>	deleteWunderBar(java.lang.String transmitterId) Deletes a WunderBar and all of its components (Transmitter and Devices)
rx.Observable<Transmitter>	getTransmitter(java.lang.String transmitterId)
rx.Observable<java.util.List<TransmitterDevice>>	getTransmitterDevices(java.lang.String transmitter)
rx.Observable<Transmitter>	registerTransmitter(Transmitter transmitter) Registers the transmitter
rx.Observable<Transmitter>	updateTransmitter(java.lang.String transmitterId, Transmitter transmitter) Updates a transmitter.

Method Detail

registerTransmitter

@POST(value="/transmitters")
rx.Observable<Transmitter> registerTransmitter(@Body
                                                                            Transmitter transmitter)

Registers the transmitter

Parameters:

transmitter - transmitter object to register

Returns:

an Observable to the registered Transmitter

getTransmitter

@GET(value="/transmitters/{id}")
rx.Observable<Transmitter> getTransmitter(@Path(value="id")
                                                                           java.lang.String transmitterId)

Parameters:

transmitterId -

Returns:

an Observable of a specific transmitter

updateTransmitter

@PATCH(value="/transmitters/{id}")
rx.Observable<Transmitter> updateTransmitter(@Path(value="id")
                                                                                java.lang.String transmitterId,
                                                                                @Body
                                                                                Transmitter transmitter)

Updates a transmitter.

Parameters:

transmitterId - id of the transmitter to update

transmitter - updated transmitter with the new details

Returns:

an Observable to the updated Transmitter

deleteTransmitter

@DELETE(value="/transmitters/{id}")
rx.Observable<java.lang.Void> deleteTransmitter(@Path(value="id")
                                                                                    java.lang.String transmitterId)

Deletes a transmitter and all of its components (Transmitter and Devices)

Parameters:

transmitterId - id of the transmitter (the Master Module)

Returns:

an empty Observable

deleteWunderBar

@DELETE(value="/wunderbars/{id}")
rx.Observable<java.lang.Void> deleteWunderBar(@Path(value="id")
                                                                                java.lang.String transmitterId)

Deletes a WunderBar and all of its components (Transmitter and Devices)

Parameters:

transmitterId - id of the transmitter (the Master Module)

Returns:

an empty Observable

getTransmitterDevices

@GET(value="/transmitters/{id}/devices")
rx.Observable<java.util.List<TransmitterDevice>> getTransmitterDevices(@Path(value="id")
                                                                                                                java.lang.String transmitter)

Parameters:

transmitter - the id of the transmitter to get the devices from

Returns:

an Observable with a list of devices that belong to the specific transmitter.