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

Getting Started with the Backend Services .NET SDK

Getting Started with the Backend Services .NET SDK

Telerik Platform provides the Backend Services .NET SDK to developers who want to integrate the services in their Windows Phone, Windows Store, or ASP.NET application. The SDK is a wrapper around the Backend Services RESTful services.

Some of the features that the .NET SDK adds over the RESTful API are:

  • Fully asynchronous API
  • Easy mapping from Telerik Platform content types to .NET classes
  • Support for await/async on compatible platforms
  • Support for LINQ
  • Fluent interface API

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

This article is organized as follows:

Obtaining and Installing the SDK

To use the Backend Services .NET SDK you need the SDK assembly. It is distributed in a ZIP archive. Follow these steps to download it:

  1. Log in to your Telerik Platform account and click Getting StartedDownloads in the top right corner.
  2. Under Download SDKs & Tools click Backend Services to see a list of available downloads.
  3. Follow the instructions on the page to download a ZIP archive containing the .NET SDK flavor that you need.
  4. Unzip the archive to your project folder and reference the .dll.

Entry Point

The entry point of the Backend Services .NET SDK is the EverliveApp class. It provides access to a single Telerik Platform application. You will normally have one instance of this class, globally available, but you can have as many as you want. This may be necessary when you need to enable inter-application collaboration scenarios.

Before you can instantiate the SDK instance you need to add the following statements to reference the required namespaces from the SDK:

using Telerik.Everlive.Sdk.Core.Model.System;
using Telerik.Everlive.Sdk.Core;
Imports Telerik.Everlive.Sdk.Core.Model.System
Imports Telerik.Everlive.Sdk.Core

An EverliveApp object is instantiated by supplying your application's App ID. The App ID is a unique identifier for your Telerik Platform app. See Introduction to Security for more information, including how to obtain it.

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

You can specify optional initialization settings that are available in the EverliveAppSettings class:

string appId = "your-app-id";
//By default UseHttps is false
EverliveAppSettings appSettings = new EverliveAppSettings() { AppId = appId, UseHttps = true };
var app = new EverliveApp(appSettings);
appId As String = "your-app-id"
//By default UseHttps is false
appSettings As New EverliveAppSettings() With { _
    Key .AppId = appId, _
    Key .UseHttps = True _
}
app As New EverliveApp(appSettings)

The next table describes the full list of initialization settings:

Setting Description
AppId The App ID of your Telerik Platform app.
ServiceUrl The access URL of Backend Services. Normally you don't need to change that. Default: api.everlive.com.
UseHttps Whether to use HTTPS instead of HTTP when making requests. The default value is false.
ApiVersion This specifies the version of the RESTful API to use when making requests. Breaking changes and new version may be introduced between RESTful API versions. It is recommended to set this to the specific version you tested with.
OutboundDateTimeProcessing Deprecated* 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.
* Setting this property has no effect anymore as all values are converted to UTC on the server anyway.

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 each of them does.

Name Type Description
Telerik.Everlive.Sdk.Core.EverliveApp class Entry point of the SDK. Used when working with a single Telerik Platform application.
Telerik.Everlive.Sdk.Core.EverliveAppSettings class Connection and behavior settings for the EverliveApp object.
Telerik.Everlive.Sdk.Core.Model.System namespace Contains classes representing system types: User, File, Role, etc.
Telerik.Everlive.Sdk.Core.Model.System.Push namespace Contains classes representing system types for push notifications and devices.
Telerik.Everlive.Sdk.Core.Model.System.Push.IOS namespace Contains classes representing system types for push notifications for iOS.
Telerik.Everlive.Sdk.Core.Model.System.Push.Android namespace Contains classes representing system types for push notifications for Android.
Telerik.Everlive.Sdk.Core.Model.System.Push.WindowsPhone namespace Contains classes representing system types for push notifications for Windows Phone.
Telerik.Everlive.Sdk.Core.Model.Base.DataItem class Base data class for representing a single Telerik Platform content type.
Telerik.Everlive.Sdk.Core.Model.Base.ErrorType enum An enumeration for errors returned by Telerik Platform.
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.
Telerik.Everlive.Sdk.Core.Transport.Response class A class representing a response from Telerik Platform. It is possible to subscribe and process Response instances before they are deserialized and processed.

Next Steps


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.