Skip to content

Clarify desugaring requirement for android #706

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rakshil14-2 merged 4 commits into from
Aug 10, 2026
Merged

Clarify desugaring requirement for android #706

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
31c1ea2
updating readme
rakshil14-2 Aug 7, 2026
6e2fef0
clarify both build libaries
rakshil14-2 Aug 7, 2026
4d1de59
trivial
rakshil14-2 Aug 7, 2026
12c13a4
add comment
rakshil14-2 Aug 7, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 21 additions & 2 deletions documents/ANDROID.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,8 +40,27 @@ a dependency of the aws-iot-device-sdk-android library.
* Android SDK 24 ([Download SDK Manager](https://developer.android.com/tools/releases/platform-tools#downloads))
* [Set ANDROID_HOME](./PREREQUISITES.md#set-android_home)

> [!NOTE]
> The SDK supports Android minimum API of 24 but requires [desugaring](https://developer.android.com/studio/write/java8-support#library-desugaring) to support Java 8 language APIs used in by the SDK. If minimum Android API Version is set to 26+ desugaring is not required.
> [!IMPORTANT]
> The published `aws-iot-device-sdk-android` artifact (and its `aws-crt-android` dependency) are built with [core library desugaring](https://developer.android.com/studio/write/java8-support#library-desugaring) enabled, because the SDK uses Java 8 library APIs such as `java.time` while supporting a minimum Android API of 24.
>
> As a result, **every app that consumes the SDK must also enable core library desugaring, regardless of its own `minSdk`** (including API 26+). If it is not enabled, the build fails at `checkDebugAarMetadata` with `requires core library desugaring to be enabled`.
>
> Add the following to your app module's `build.gradle`:
>
> ```groovy
> android {
> compileOptions {
> coreLibraryDesugaringEnabled true
> }
> }
>
> dependencies {
> // Use the latest version compatible with your AGP (2.0.4 requires AGP 7.4+)
> coreLibraryDesugaring 'com.android.tools:desugar_jdk_libs:2.0.4'
> }
> ```
>
> If you build from source with a `minSdk` of 26 or higher, you may remove the desugaring requirement but you must do so in **both** libraries: this SDK (`aws-iot-device-sdk-android`) **and** its [`aws-crt-java`](https://github.com/awslabs/aws-crt-java) dependency (`aws-crt-android`), which is pulled in transitively and enforces the same requirement on its own. Once both are rebuilt at `minSdk` 26+ with the flag removed, consuming apps at API 26+ no longer need to enable desugaring.

### Build and install IoT Device SDK from source
> [!NOTE]
Expand Down
Loading