io.relayr.java

Class RelayrJavaSdk

java.lang.Object

io.relayr.java.RelayrJavaSdk

public class RelayrJavaSdk
extends java.lang.Object

The RelayrJavaSdk Class serves as the access point to all endpoints in the Android SDK. It includes basic calls such as user login validation and can also call the handlers of the other classes. For easy start, after logging in, obtain User by calling getUser(). This is main object in Relayr SDK that can be used to fetch users Device, Transmitter, Group and Account objects. Every mentioned object has it's own interaction methods so direct usage of APIs is not necessary. However it's still possible to obtain any of the desired API handlers through appropriate method:

• getUserApi()
• getRelayrApi()
• getDeviceApi()
• getGroupsApi()
• getAccountsApi()
• getPublishersApi()
• getProjectsApi()
• getRuleTemplateApi()
• getAggregatedDataService() ()} or using AggregatedDataHelper
• getRawDataService() ()} ()} or using RawDataHelper
• getDeviceModelsApi() or using cache getDeviceModelsCache()

For other details check methods JavaDoc

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RelayrJavaSdk.Builder Initializes the SDK.

Constructor Summary

Constructors

Constructor and Description
RelayrJavaSdk()

Method Summary

Modifier and Type	Method and Description
static AccountsApi	getAccountsApi()
static AggregatedDataService	getAggregatedDataService()
static DeviceApi	getDeviceApi()
static DeviceModelsApi	getDeviceModelsApi()
static DeviceModelCache	getDeviceModelsCache()
static GroupsApi	getGroupsApi()
static retrofit.RestAdapter.LogLevel	getLogLevel() Returns log level set when initializing the SDK.
static NotificationService	getNotificationService()
static ProjectsApi	getProjectsApi()
static PublishersApi	getPublishersApi()
static RawDataService	getRawDataService()
static RelayrApi	getRelayrApi()
static RuleTemplateApi	getRuleTemplateApi()
static rx.Observable<User>	getUser()
static UserApi	getUserApi()
static java.lang.String	getVersion()
static WebSocketClient	getWebSocketClient() Use this class to subscribe to live data from device, namely Reading, Command and Configuration
static boolean	isProductionEnvironment() Returns true if production environment servers are used.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RelayrJavaSdk

public RelayrJavaSdk()

Method Detail

getLogLevel

public static retrofit.RestAdapter.LogLevel getLogLevel()

Returns log level set when initializing the SDK. Possible levels: RestAdapter.LogLevel.NONE, RestAdapter.LogLevel.BASIC, RestAdapter.LogLevel.HEADERS, RestAdapter.LogLevel.HEADERS_AND_ARGS, RestAdapter.LogLevel.FULL,

Returns:

current Log level

isProductionEnvironment

public static boolean isProductionEnvironment()

Returns true if production environment servers are used. False if development environment is selected.

getUser

public static rx.Observable<User> getUser()

Returns:

user object. This is main object in Relayr SDK that can be used to fetch user Device, Transmitter, Group and Account. Any of the mentioned objects has it's own special methods so direct usage of APIs is not necessary but it's still possible

getVersion

public static java.lang.String getVersion()

Returns:

the version String

getRelayrApi

public static RelayrApi getRelayrApi()

Returns:

the handler of the Relayr API. Used as an access point to class RelayrApi

getAccountsApi

public static AccountsApi getAccountsApi()

Returns:

the handler of the Accounts API. Use to add third party accounts to the relayr user. Used as an access point to class AccountsApi

getDeviceApi

public static DeviceApi getDeviceApi()

Returns:

the handler of the Device API. Used as an access point to class DeviceApi

getGroupsApi

public static GroupsApi getGroupsApi()

Returns:

the handler of the Groups API. Used as an access point to class GroupsApi

getUserApi

public static UserApi getUserApi()

Returns:

the handler of the relayr User API. Use to get user data, user transmitters, devices, accounts and groups Used as an access point to class UserApi

getAggregatedDataService

public static AggregatedDataService getAggregatedDataService()

Returns:

the handler of the relayr AggregatedDataService API. Used as an access point to class AggregatedDataService Device.getAggregatedDataHelper() can be used to fetch aggregated history data for each device.

getRawDataService

public static RawDataService getRawDataService()

Returns:

the handler of the relayr RawDataService API. Used as an access point to class RawDataService Device.getRawDataHelper() can be used to fetch raw history data for each device.

getNotificationService

public static NotificationService getNotificationService()

Returns:

the handler of the relayr NotificationService API. Used as an access point to class NotificationService

getRuleTemplateApi

public static RuleTemplateApi getRuleTemplateApi()

Returns:

the handler of the relayr RuleTemplate API. Used as an access point to class RuleTemplateApi Provides an API for the creation of Rule Engine Rules on the base of pre made templates.

getWebSocketClient

public static WebSocketClient getWebSocketClient()

Use this class to subscribe to live data from device, namely Reading, Command and Configuration

Returns:

the handler of the WebSocketClient

getDeviceModelsApi

public static DeviceModelsApi getDeviceModelsApi()

Returns:

the handler of the relayr DeviceModels API. Returns new device models. Used as an access point to class DeviceModelsApi

getDeviceModelsCache

public static DeviceModelCache getDeviceModelsCache()

Returns:

cached DeviceModel objects. Cache will be populated with models from Device.modelId when device is fetched. Use instead of getDeviceModelsApi()

getPublishersApi

public static PublishersApi getPublishersApi()

Returns:

the handler of the relayr PublishersApi.

getProjectsApi

public static ProjectsApi getProjectsApi()

Returns:

the handler of the relayr ProjectsApi.