io.relayr.java.api

Interface DeviceModelsApi

public interface DeviceModelsApi

Method Summary

Modifier and Type	Method and Description
rx.Observable<DeviceFirmware>	getDeviceModelByFirmware(java.lang.String modelId, java.lang.String version) Returns device io.relayr.java.model defined by modelId and firmware version
rx.Observable<DeviceModel>	getDeviceModelById(java.lang.String modelId) Returns specific device io.relayr.java.model
rx.Observable<DeviceFirmwares>	getDeviceModelFirmwares(java.lang.String modelId) Returns specific device io.relayr.java.model's firmware list
rx.Observable<DeviceModels>	getDeviceModels(int limit) Returns list all available device models.
rx.Observable<DeviceModels>	getDeviceModels(int limit, int offset) Returns list all available device models.
rx.Observable<ReadingMeanings>	getReadingMeanings() Returns a list of the possible reading types of the devices on the relayr platform
rx.Observable<DeviceFirmware>	getUsersDeviceModelByFirmware(java.lang.String userId, java.lang.String modelId, java.lang.String version) Returns device io.relayr.java.model defined by modelId and firmware version
rx.Observable<DeviceModel>	getUsersDeviceModelById(java.lang.String userId, java.lang.String modelId) Returns list of all device models owned by user
rx.Observable<DeviceFirmwares>	getUsersDeviceModelFirmwares(java.lang.String userId, java.lang.String modelId) Returns specific device io.relayr.java.model's firmware list
rx.Observable<DeviceModels>	getUsersDeviceModels(java.lang.String userId) Returns list of all device models owned by user
rx.Observable<DeviceModels>	getUsersPrototypes(java.lang.String userId, int limit, int offset) Returns list of all available device models for prototypes.

Method Detail

getReadingMeanings

@GET(value="/device-models/meanings")
rx.Observable<ReadingMeanings> getReadingMeanings()

Returns a list of the possible reading types of the devices on the relayr platform

Returns:

an Observable with a list of Reading meanings

getDeviceModels

@GET(value="/device-models")
rx.Observable<DeviceModels> getDeviceModels(@Query(value="limit")
                                                                         int limit)

Returns list all available device models.

Parameters:

limit - maximum number of device models to fetch

Returns:

an Observable with a list of device models.

getDeviceModels

@GET(value="/device-models")
rx.Observable<DeviceModels> getDeviceModels(@Query(value="limit")
                                                                         int limit,
                                                                         @Query(value="offset")
                                                                         int offset)

Returns list all available device models.

Parameters:

limit - maximum number of device models to fetch

offset - offset from zero index

Returns:

an Observable with a list of device models.

getDeviceModelById

@GET(value="/device-models/{modelId}")
rx.Observable<DeviceModel> getDeviceModelById(@Path(value="modelId")
                                                                                     java.lang.String modelId)

Returns specific device io.relayr.java.model

Returns:

an Observable

getDeviceModelFirmwares

@GET(value="/device-models/{modelId}/firmware")
rx.Observable<DeviceFirmwares> getDeviceModelFirmwares(@Path(value="modelId")
                                                                                                       java.lang.String modelId)

Returns specific device io.relayr.java.model's firmware list

Returns:

an Observable

getDeviceModelByFirmware

@GET(value="/device-models/{modelId}/firmware/{version}")
rx.Observable<DeviceFirmware> getDeviceModelByFirmware(@Path(value="modelId")
                                                                                                                 java.lang.String modelId,
                                                                                                                 @Path(value="version")
                                                                                                                 java.lang.String version)

Returns device io.relayr.java.model defined by modelId and firmware version

Returns:

an Observable

getUsersDeviceModels

@GET(value="/users/{userId}/device-models")
rx.Observable<DeviceModels> getUsersDeviceModels(@Path(value="userId")
                                                                                             java.lang.String userId)

Returns list of all device models owned by user

Returns:

an Observable with a list of device models.

getUsersDeviceModelById

@GET(value="/users/{userId}/device-models/{modelId}")
rx.Observable<DeviceModel> getUsersDeviceModelById(@Path(value="userId")
                                                                                                         java.lang.String userId,
                                                                                                         @Path(value="modelId")
                                                                                                         java.lang.String modelId)

Returns list of all device models owned by user

Returns:

an Observable with a list of device models.

getUsersDeviceModelFirmwares

@GET(value="/users/{userId}/device-models/{modelId}/firmware")
rx.Observable<DeviceFirmwares> getUsersDeviceModelFirmwares(@Path(value="userId")
                                                                                                                           java.lang.String userId,
                                                                                                                           @Path(value="modelId")
                                                                                                                           java.lang.String modelId)

Returns specific device io.relayr.java.model's firmware list

Returns:

an Observable

getUsersDeviceModelByFirmware

@GET(value="/users/{userId}/device-models/{modelId}/firmware/{version}")
rx.Observable<DeviceFirmware> getUsersDeviceModelByFirmware(@Path(value="userId")
                                                                                                                                     java.lang.String userId,
                                                                                                                                     @Path(value="modelId")
                                                                                                                                     java.lang.String modelId,
                                                                                                                                     @Path(value="version")
                                                                                                                                     java.lang.String version)

Returns device io.relayr.java.model defined by modelId and firmware version

Returns:

an Observable

getUsersPrototypes

@GET(value="/users/{userId}/device-models/prototypes")
rx.Observable<DeviceModels> getUsersPrototypes(@Path(value="userId")
                                                                                                      java.lang.String userId,
                                                                                                      @Query(value="limit")
                                                                                                      int limit,
                                                                                                      @Query(value="offset")
                                                                                                      int offset)

Returns list of all available device models for prototypes.

Returns:

an Observable