Skip to content

Latest commit

 

History

History
95 lines (66 loc) · 6.81 KB

README.md

File metadata and controls

95 lines (66 loc) · 6.81 KB
Raw

Azure SDK for Android

This repository is for active development of the Azure SDK for Android. For consumers of the SDK we recommend visiting our versioned developer docs.

Note: The Azure SDK for Android replaces a previous offering, known as Azure.Android. Source code and documentation for Azure.Android is available in the Azure.Android branch.

Getting started

For your convenience, each service has a separate set of libraries that you can choose to use instead of one, large Azure package. To get started with a specific library, see the README.md file located in the library's project folder. You can find service libraries in the /sdk directory.

Prerequisites

  • The libraries are written in Java 8. Your application must be built with Android Gradle Plugin 3.0.0 or later, and must be configured to enable Java 8 language desugaring to use these libraries. Any Java 8+ APIs that would require the Java 8+ API desugaring provided by Android Gradle plugin 4.0.0 are not used.
  • You must have an Azure subscription to use these libraries.

Libraries available

Currently, the client libraries are in beta. These libraries follow the Azure SDK Design Guidelines for Android and share a number of core features such as HTTP retries, logging, transport protocols, authentication protocols, etc., so that once you learn how to use these features in one client library, you will know how to use them in other client libraries. You can learn about these shared features in azure-core.

The following libraries are currently in beta:

Core

Note: The SDK is currently in beta. The API surface and feature sets are subject to change at any time before they become generally available. We do not currently recommend them for production use.

The following libraries are currently generally available:

Azure Communication Services

Install the libraries

To install the Azure client libraries for Android, add them as dependencies within your Gradle or Maven build scripts.

Add a dependency with Gradle

To import one or more client libraries into your project using the Gradle build system, follow the instructions in Add build dependencies:

For each library you wish to use, add an implementation configuration to the dependencies block of your app's build.gradle or build.gradle.kts file, specifying the library's name and version:

// build.gradle
dependencies {
    ...
    implementation "com.azure.android:azure-communication-chat:2.0.0"
}

// build.gradle.kts
dependencies {
    ...
    implementation("com.azure.android:azure-communication-chat:2.0.0")
}

Add a dependency with Maven

To import one or more client libraries into your project using the Maven build system, add them to the dependencies section of your app's pom.xml file, specifying the artifact ID and version of each library you wish to use:

<dependency>
  <groupId>com.azure.android</groupId>
  <artifactId>azure-communication-chat</artifactId>
  <version>2.0.0</version>
</dependency>

Need help?

Reporting security issues and security bugs

Security issues and bugs should be reported privately, via email, to the Microsoft Security Response Center (MSRC) secure@microsoft.com. You should receive a response within 24 hours. If for some reason you do not, please follow up via email to ensure we received your original message. Further information, including the MSRC PGP key, can be found in the Security TechCenter.

Contributing

For details on contributing to this repository, see the contributing guide.

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.

When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repositories using our CLA.

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.

Impressions