privacysandbox-tools

  
A library to utilize the Privacy Sandbox functionality in Android
Latest Update Stable Release Release Candidate Beta Release Alpha Release
May 24, 2023 - - - 1.0.0-alpha04

Declaring dependencies

To add a dependency on privacysandbox-tools, you must add the Google Maven repository to your project. Read Google's Maven repository for more information.

Add the dependencies for the artifacts you need in the build.gradle file for your app or module:

Groovy

dependencies {
    // Use to implement privacysandbox toolss
    implementation "androidx.privacysandbox.tools:tools:1.0.0-alpha04"

    // Use to implement privacysandbox tools complications
    implementation "androidx.privacysandbox.tools:tools-complications-data-source:1.0.0-alpha04"
    // (Kotlin-specific extensions)
    implementation "androidx.privacysandbox.tools:tools-complications-data-source-ktx:1.0.0-alpha04"

    // Use to implement a tools style and complication editor
    implementation "androidx.privacysandbox.tools:tools-editor:1.0.0-alpha04"

    // Can use to render complications.
    // This library is optional and toolss may have custom implementation for rendering
    // complications.
    implementation "androidx.privacysandbox.tools:tools-complications-rendering:1.0.0-alpha04"
}

Kotlin

dependencies {
    // Use to implement privacysandbox toolss
    implementation("androidx.privacysandbox.tools:tools:1.0.0-alpha04")

    // Use to implement privacysandbox tools complications
    implementation("androidx.privacysandbox.tools:tools-complications-data-source:1.0.0-alpha04")
    // (Kotlin-specific extensions)
    implementation("androidx.privacysandbox.tools:tools-complications-data-source-ktx:1.0.0-alpha04")

    // Use to implement a tools style and complication editor
    implementation("androidx.privacysandbox.tools:tools-editor:1.0.0-alpha04")

    // Can use to render complications.
    // This library is optional and toolss may have custom implementation for rendering
    // complications.
    implementation("androidx.privacysandbox.tools:tools-complications-rendering:1.0.0-alpha04")
}

For more information about dependencies, see Add build dependencies.

Feedback

Your feedback helps make Jetpack better. Let us know if you discover new issues or have ideas for improving this library. Please take a look at the existing issues in this library before you create a new one. You can add your vote to an existing issue by clicking the star button.

Create a new issue

See the Issue Tracker documentation for more information.

Version 1.0

Version 1.0.0-alpha04

May 24, 2023

androidx.privacysandbox.tools:tools-*:1.0.0-alpha04 is released. Version 1.0.0-alpha04 contains these commits.

New Features

  • CancellationExceptions are now propagated to apps, so SDKs can now cancel their coroutines as expected.
  • SdkActivityLaunchers can now be used in SDK APIs, so apps can send launchers to SDKs in the Privacy Sandbox. Note that this functionality is only available in developer previews at the moment.

Bug Fixes

  • Non-suspend functions declared by SDKs will now run in the main thread by default. They used to run in Binder threads.
  • Services can no longer inherit from UI interface adapters.
  • Fixed an issue where defining a UI adapter property in a data class would cause a compilation error.

Version 1.0.0-alpha03

March 8, 2023

androidx.privacysandbox.tools:tools-*:1.0.0-alpha03 is released. Version 1.0.0-alpha03 contains these commits.

New Features

  • Added support for Privacy Sandbox UI API integration

API Changes

  • Changed target kotlin version to 1.8.0

Version 1.0.0-alpha02

December 7, 2022

androidx.privacysandbox.tools:tools-*:1.0.0-alpha02 is released. Version 1.0.0-alpha02 contains these commits.

  • These tools are aimed to enhance the integration with the Privacy Sandbox SDK Runtime APIs. These tools will help with auto-generating boilerplate code to define and interact with the client-facing interfaces of the runtime-enabled SDK.

New Features - Adds support for defining client-facing SDK interfaces that accept callbacks and data value objects as parameters and return types - Propagate SDK exceptions to clients - Support for SDK Runtime backward compatibility generation

API Changes

  • Adding @JvmDefaultWithCompatibility annotation (I8f206)

Version 1.0.0-alpha01

November 9, 2022

androidx.privacysandbox.tools:tools-*:1.0.0-alpha01 is released. Version 1.0.0-alpha01 contains these commits.

New Features