Progress will discontinue Telerik Platform on May 10th, 2018. Learn more
  • Getting Started with the Backend Services Android SDK

Getting Started with the Backend Services Android SDK

Getting Started with the Backend Services Android SDK

The Backend Services Android SDK is a wrapper around the Backend Services RESTful services. It greatly simplifies the integration process and allows you to work with Backend Services without having any knowledge of the RESTful services.

Being an Android SDK, the Backend Services Android SDK is based on Java.

Key Features

  • Fully asynchronous API
  • Easy mapping from Telerik Platform content types to Java classes
  • Fluent interface API

Unsupported Operations

Any operations that are not directly supported by the SDK can be accessed through the RESTful API.

Download the Android SDK

To use the Backend Services Android SDK you need a single jar file. It is distributed in a ZIP archive.

Download the Backend Services Android SDK from the Downloads page or from this link.

Copy the jar in your project file structure and add it as a library.

Entry point

The entry point of the Backend Services Android SDK is the EverliveApp class. It provides access to a single Backend Services application. You will normally have one instance of this class, globally available. Of course, you can have as many instances as you want, in case you want to enable some inter-application collaboration scenarios.

An EverliveApp object is instantiated by supplying an App ID. You can also specify some other settings, but this is the most important one. The App ID links the runtime object to the Telerik Platform app you want to work with. Here is an example:

EverliveApp myApp = new EverliveApp("your-app-id");

Once you have an instance of EverliveApp, you are ready to make requests to Telerik Platform. You will find more examples later in the documentation.

Settings

When creating an EverliveApp instance, you can specify some settings to configure the behavior of the instance. Those settings are available in the EverliveAppSettings class. An instance of this class is accepted in the constructor of the EverliveApp. In the following table you will find the available settings and a description what they do.

Property Description
ServiceUrl The base URL of the Backend Services RESTful API. This defaults to api.everlive.com. Normally, you would not need to change that.
UseHttps Whether to use HTTPS when making requests. The default value is false.
ApiVersion This specifies the version of the RESTful API to use when making requests. When we add new features to the RESTful API, we might sometimes have breaking changes. This is why we have versioning of the API. It is recommended to set this to the specific version you tested with.
OutboundDateTimeProcessing How to process DateTime objects that go to the server.
InboundDateTimeProcessing How to process DateTime objects that come from the server.
DateTimeUnspecifiedHandling How to handle DateTime objects with Kind=Unspecified. Such dates are not supported by the server, so they must be processed.
SendSystemPropertiesToServer When set to true, it allows you to create/update system data item fields such as CreatedAt, CreatedBy, ModifiedAt. Requires master key authentication. When false, these fields will be autoset, even if you have set them in the request.

Important Classes and Interfaces

In this section you will find the most important classes, interfaces and namespaces in the SDK and a brief description of what they are used for.

Name Type Description
com.telerik.everlive.sdk.core.EverliveApp class Entry point of the SDK. Used to work with a single Telerik Platform application.
com.telerik.everlive.sdk.core.EverliveAppSettings class Connection and behavior settings for EverliveApp object.
com.telerik.everlive.sdk.core.model.system namespace Contains classes representing system types: User, File, Role, etc.
com.telerik.everlive.sdk.core.model.base.DataItem class Base data class for representing a single Telerik Platform content type.
com.telerik.everlive.sdk.core.model.base.ErrorType enum An enumeration for errors returned by Telerik Platform.
com.telerik.everlive.sdk.core.transport.Request class A class representing a single request to Telerik Platform. It is possible to subscribe and process Request instances before they are sent.
com.telerik.everlive.sdk.core.result.RequestResult class A generic class that wraps the result of a single request to Telerik Platform both successful or not. Used as a parameter in asynchronous callback function.
Start a free trial Request a demo
Contact us: +1-888-365-2779
sales@telerik.com
Copyright © 2016-2017, Progress Software Corporation and/or its subsidiaries or affiliates. All rights reserved.