Microsoft Azure Mobile Apps: Android Client SDK

With Microsoft Azure Mobile Apps you can add a scalable backend to your connected client applications in minutes. To learn more, visit our Developer Center.

Getting Started

If you are new to Mobile Services, you can get started by following our tutorials for connecting your Mobile Services cloud backend to Android apps.

Supported Platforms

The current release of the Android SDK for Azure Mobile Apps supports:

Android releases for API 19 through 26 (KitKat through Oreo)

Other platforms may work, but have not been tested.

Version Information

There are two major versions of this SDK:

SDK v2.x.x is used with Azure Mobile Services.
SDK v3.x.x is used with Azure App Service / Azure Mobile Apps.

Please ensure you are using the right SDK version that matches your backend cloud service.

Download Source Code

To get the source code of our SDKs and samples via git just type:

git clone https://github.com/Azure/azure-mobile-apps-android-client.git
cd ./azure-mobile-apps-android-client/

Reference Documentation

Android SDK

Microsoft Azure Mobile Services can be used with an Android-based device using our Android SDK. You can get the Android SDK in one of the following two ways or you can download the source code using the instructions above.

For an Android studio project, add the line compile 'com.microsoft.azure:azure-mobile-android:3.4.0@aar' to the app’s Gradle.build file with your desired SDK version plugged in (you can find the latest versions here):
Eclipse users can download the Android SDK directly or can download the source code using the instructions above.

Prerequisites

The SDK requires Android Studio.

Building and Referencing the SDK

Open the folder \azure-mobile-apps-android-client\sdk using the option Open an existing Android Studio Project in Android Studio.
Project should be built automatically, In case it does not build, Right click on sdk folder and select Make Module 'sdk'.
The file sdk-release.aar should be present at \azure-mobile-apps-android-client\sdk\src\sdk\build\outputs\aar.
Rename the file sdk-release.aar to sdk-release.zip.
Extract the zip file, classes.jar should be present in the root folder.

Running the Tests

The SDK has a suite of unit tests that you can easily run.

Open the folder \azure-mobile-apps-android-client\sdk using the option Open an existing Android Studio Project in Android Studio.
Project should be built automatically, In case it does not build, Right click on sdk folder and select Make Module 'sdk.testapp'.
Expand sdk.testapp and sub folder java.
Right click on com.microsoft.windowsazure.mobileservices.sdk.testapp, Select Run, Select Tests in com.microsoft.windowsazure.mobileservices.sdk.testapp (with Android tests icon).

Useful Resources

Quickstarts
Samples
Tutorials and product overview are available at Microsoft Azure Mobile Services Developer Center.
Our product team actively monitors the Mobile Services Developer Forum to assist you with any troubles.

Contribute Code or Provide Feedback

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

If you would like to become an active contributor to this project please follow the instructions provided in Microsoft Azure Projects Contribution Guidelines.

If you encounter any bugs with the library please file an issue in the Issues section of the project.

phileo/azure-mobile-apps-android-client