# SdkSandboxControllerCompat

Artifact: [androidx.privacysandbox.sdkruntime:sdkruntime-provider](https://developer.android.com/jetpack/androidx/releases/privacysandbox-sdkruntime) [View Source](https://cs.android.com/search?q=file:androidx/privacysandbox/sdkruntime/provider/controller/SdkSandboxControllerCompat.kt+class:androidx.privacysandbox.sdkruntime.provider.controller.SdkSandboxControllerCompat) Added in [1.0.0-alpha19](https://developer.android.com/jetpack/androidx/releases/privacysandbox-sdkruntime#1.0.0-alpha19) Deprecated in [1.0.0-alpha19](https://developer.android.com/jetpack/androidx/releases/privacysandbox-sdkruntime#1.0.0-alpha19)

*** ** * ** ***


```
public final class SdkSandboxControllerCompat
```

<br />

*** ** * ** ***

> [!CAUTION]
> **This class is deprecated.**   
> This library is no longer supported.

Compat version of android.app.public sdksandbox.sdkprovider.SdkSandboxController.

Controller that is used by SDK loaded in the sandbox or locally to access information provided by the sandbox environment.

It enables the SDK to communicate with other SDKS and know about the state of the sdks that are currently loaded.

An instance can be obtained using `https://developer.android.com/reference/androidx/privacysandbox/sdkruntime/provider/controller/SdkSandboxControllerCompat#from(android.content.Context)`. The `https://developer.android.com/reference/android/content/Context.html` can be obtained using `https://developer.android.com/reference/androidx/privacysandbox/sdkruntime/core/SandboxedSdkProviderCompat#context()`.

| See also |
|---|---|
| `https://developer.android.com/reference/android/app/sdksandbox/sdkprovider/SdkSandboxController.html` |   |

## Summary

| ### Public methods |
|---|---|
| `static final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/privacysandbox/sdkruntime/provider/controller/SdkSandboxControllerCompat` | `[from](https://developer.android.com/reference/androidx/privacysandbox/sdkruntime/provider/controller/SdkSandboxControllerCompat#from(android.content.Context))(@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/android/content/Context.html context)` **This method is deprecated.** This library is no longer supported. |
| `final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/util/List.html<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/privacysandbox/sdkruntime/core/AppOwnedSdkSandboxInterfaceCompat>` | `[getAppOwnedSdkSandboxInterfaces](https://developer.android.com/reference/androidx/privacysandbox/sdkruntime/provider/controller/SdkSandboxControllerCompat#getAppOwnedSdkSandboxInterfaces())()` **This method is deprecated.** This library is no longer supported. |
| `final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html` | `[getClientPackageName](https://developer.android.com/reference/androidx/privacysandbox/sdkruntime/provider/controller/SdkSandboxControllerCompat#getClientPackageName())()` **This method is deprecated.** This library is no longer supported. |
| `final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/util/List.html<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/privacysandbox/sdkruntime/core/SandboxedSdkCompat>` | `[getSandboxedSdks](https://developer.android.com/reference/androidx/privacysandbox/sdkruntime/provider/controller/SdkSandboxControllerCompat#getSandboxedSdks())()` **This method is deprecated.** This library is no longer supported. |
| `final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/privacysandbox/sdkruntime/core/SandboxedSdkCompat` | `[loadSdk](https://developer.android.com/reference/androidx/privacysandbox/sdkruntime/provider/controller/SdkSandboxControllerCompat#loadSdk(kotlin.String,android.os.Bundle))(@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html sdkName, @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/android/os/Bundle.html params)` **This method is deprecated.** This library is no longer supported. |
| `final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/android/os/IBinder.html` | `[registerSdkSandboxActivityHandler](https://developer.android.com/reference/androidx/privacysandbox/sdkruntime/provider/controller/SdkSandboxControllerCompat#registerSdkSandboxActivityHandler(androidx.privacysandbox.sdkruntime.core.activity.SdkSandboxActivityHandlerCompat))( @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/privacysandbox/sdkruntime/core/activity/SdkSandboxActivityHandlerCompat handlerCompat )` **This method is deprecated.** This library is no longer supported. |
| `final void` | `[registerSdkSandboxClientImportanceListener](https://developer.android.com/reference/androidx/privacysandbox/sdkruntime/provider/controller/SdkSandboxControllerCompat#registerSdkSandboxClientImportanceListener(java.util.concurrent.Executor,androidx.privacysandbox.sdkruntime.core.SdkSandboxClientImportanceListenerCompat))( @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/util/concurrent/Executor.html executor, @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/privacysandbox/sdkruntime/core/SdkSandboxClientImportanceListenerCompat listenerCompat )` **This method is deprecated.** This library is no longer supported. |
| `final void` | `[unregisterSdkSandboxActivityHandler](https://developer.android.com/reference/androidx/privacysandbox/sdkruntime/provider/controller/SdkSandboxControllerCompat#unregisterSdkSandboxActivityHandler(androidx.privacysandbox.sdkruntime.core.activity.SdkSandboxActivityHandlerCompat))( @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/privacysandbox/sdkruntime/core/activity/SdkSandboxActivityHandlerCompat handlerCompat )` **This method is deprecated.** This library is no longer supported. |
| `final void` | `[unregisterSdkSandboxClientImportanceListener](https://developer.android.com/reference/androidx/privacysandbox/sdkruntime/provider/controller/SdkSandboxControllerCompat#unregisterSdkSandboxClientImportanceListener(androidx.privacysandbox.sdkruntime.core.SdkSandboxClientImportanceListenerCompat))( @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/privacysandbox/sdkruntime/core/SdkSandboxClientImportanceListenerCompat listenerCompat )` **This method is deprecated.** This library is no longer supported. |

## Public methods

### from

Added in [1.0.0-alpha19](https://developer.android.com/jetpack/androidx/releases/privacysandbox-sdkruntime#1.0.0-alpha19) Deprecated in [1.0.0-alpha19](https://developer.android.com/jetpack/androidx/releases/privacysandbox-sdkruntime#1.0.0-alpha19)

```
public static final @NonNull SdkSandboxControllerCompat [from](https://developer.android.com/reference/androidx/privacysandbox/sdkruntime/provider/controller/SdkSandboxControllerCompat#from(android.content.Context))(@NonNull Context context)
```

> [!CAUTION]
> **This method is deprecated.**   
> This library is no longer supported.

Creates `https://developer.android.com/reference/androidx/privacysandbox/sdkruntime/provider/controller/SdkSandboxControllerCompat`.

| Parameters |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/android/content/Context.html context` | SDK context |

| Returns |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/privacysandbox/sdkruntime/provider/controller/SdkSandboxControllerCompat` | SdkSandboxControllerCompat object. |

### getAppOwnedSdkSandboxInterfaces

Added in [1.0.0-alpha19](https://developer.android.com/jetpack/androidx/releases/privacysandbox-sdkruntime#1.0.0-alpha19) Deprecated in [1.0.0-alpha19](https://developer.android.com/jetpack/androidx/releases/privacysandbox-sdkruntime#1.0.0-alpha19)

```
public final @NonNull List<@NonNull AppOwnedSdkSandboxInterfaceCompat> [getAppOwnedSdkSandboxInterfaces](https://developer.android.com/reference/androidx/privacysandbox/sdkruntime/provider/controller/SdkSandboxControllerCompat#getAppOwnedSdkSandboxInterfaces())()
```

> [!CAUTION]
> **This method is deprecated.**   
> This library is no longer supported.

Fetches all `https://developer.android.com/reference/androidx/privacysandbox/sdkruntime/core/AppOwnedSdkSandboxInterfaceCompat` that are registered by the app.

| Returns |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/util/List.html<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/privacysandbox/sdkruntime/core/AppOwnedSdkSandboxInterfaceCompat>` | List of all currently registered `https://developer.android.com/reference/androidx/privacysandbox/sdkruntime/core/AppOwnedSdkSandboxInterfaceCompat` |

### getClientPackageName

Added in [1.0.0-alpha19](https://developer.android.com/jetpack/androidx/releases/privacysandbox-sdkruntime#1.0.0-alpha19) Deprecated in [1.0.0-alpha19](https://developer.android.com/jetpack/androidx/releases/privacysandbox-sdkruntime#1.0.0-alpha19)

```
public final @NonNull String [getClientPackageName](https://developer.android.com/reference/androidx/privacysandbox/sdkruntime/provider/controller/SdkSandboxControllerCompat#getClientPackageName())()
```

> [!CAUTION]
> **This method is deprecated.**   
> This library is no longer supported.

Returns the package name of the client app.

| Returns |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html` | Package name of the client app. |

### getSandboxedSdks

Added in [1.0.0-alpha19](https://developer.android.com/jetpack/androidx/releases/privacysandbox-sdkruntime#1.0.0-alpha19) Deprecated in [1.0.0-alpha19](https://developer.android.com/jetpack/androidx/releases/privacysandbox-sdkruntime#1.0.0-alpha19)

```
public final @NonNull List<@NonNull SandboxedSdkCompat> [getSandboxedSdks](https://developer.android.com/reference/androidx/privacysandbox/sdkruntime/provider/controller/SdkSandboxControllerCompat#getSandboxedSdks())()
```

> [!CAUTION]
> **This method is deprecated.**   
> This library is no longer supported.

Fetches information about Sdks that are loaded in the sandbox or locally.

| Returns |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/util/List.html<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/privacysandbox/sdkruntime/core/SandboxedSdkCompat>` | List of `https://developer.android.com/reference/androidx/privacysandbox/sdkruntime/core/SandboxedSdkCompat` containing all currently loaded sdks |

| See also |
|---|---|
| `https://developer.android.com/reference/android/app/sdksandbox/sdkprovider/SdkSandboxController.html#getSandboxedSdks()` |   |

### loadSdk

```
public final @NonNull SandboxedSdkCompat [loadSdk](https://developer.android.com/reference/androidx/privacysandbox/sdkruntime/provider/controller/SdkSandboxControllerCompat#loadSdk(kotlin.String,android.os.Bundle))(@NonNull String sdkName, @NonNull Bundle params)
```

> [!CAUTION]
> **This method is deprecated.**   
> This library is no longer supported.

Load SDK in a SDK sandbox java process or locally.

The caller may only load SDKs the client app depends on into the SDK sandbox.

| Parameters |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html sdkName` | name of the SDK to be loaded. |
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/android/os/Bundle.html params` | additional parameters to be passed to the SDK in the form of a `https://developer.android.com/reference/android/os/Bundle.html` as agreed between the client and the SDK. |

| Returns |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/privacysandbox/sdkruntime/core/SandboxedSdkCompat` | `https://developer.android.com/reference/androidx/privacysandbox/sdkruntime/core/SandboxedSdkCompat` from SDK on a successful run. |

| Throws |
|---|---|
| `https://developer.android.com/reference/androidx/privacysandbox/sdkruntime/core/LoadSdkCompatException` | on fail. |

### registerSdkSandboxActivityHandler

Added in [1.0.0-alpha19](https://developer.android.com/jetpack/androidx/releases/privacysandbox-sdkruntime#1.0.0-alpha19) Deprecated in [1.0.0-alpha19](https://developer.android.com/jetpack/androidx/releases/privacysandbox-sdkruntime#1.0.0-alpha19)

```
public final @NonNull IBinder [registerSdkSandboxActivityHandler](https://developer.android.com/reference/androidx/privacysandbox/sdkruntime/provider/controller/SdkSandboxControllerCompat#registerSdkSandboxActivityHandler(androidx.privacysandbox.sdkruntime.core.activity.SdkSandboxActivityHandlerCompat))(
    @NonNull SdkSandboxActivityHandlerCompat handlerCompat
)
```

> [!CAUTION]
> **This method is deprecated.**   
> This library is no longer supported.

Returns an identifier for a `https://developer.android.com/reference/androidx/privacysandbox/sdkruntime/core/activity/SdkSandboxActivityHandlerCompat` after registering it.

This function registers an implementation of `https://developer.android.com/reference/androidx/privacysandbox/sdkruntime/core/activity/SdkSandboxActivityHandlerCompat` created by an SDK and returns an `https://developer.android.com/reference/android/os/IBinder.html` which uniquely identifies the passed `https://developer.android.com/reference/androidx/privacysandbox/sdkruntime/core/activity/SdkSandboxActivityHandlerCompat` object.

| Parameters |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/privacysandbox/sdkruntime/core/activity/SdkSandboxActivityHandlerCompat handlerCompat` | is the `https://developer.android.com/reference/androidx/privacysandbox/sdkruntime/core/activity/SdkSandboxActivityHandlerCompat` to register |

| Returns |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/android/os/IBinder.html` | `https://developer.android.com/reference/android/os/IBinder.html` uniquely identify the passed `https://developer.android.com/reference/androidx/privacysandbox/sdkruntime/core/activity/SdkSandboxActivityHandlerCompat` |

| See also |
|---|---|
| `https://developer.android.com/reference/android/app/sdksandbox/sdkprovider/SdkSandboxController.html#registerSdkSandboxActivityHandler(android.app.sdksandbox.sdkprovider.SdkSandboxActivityHandler)` |   |

### registerSdkSandboxClientImportanceListener

Added in [1.0.0-alpha19](https://developer.android.com/jetpack/androidx/releases/privacysandbox-sdkruntime#1.0.0-alpha19) Deprecated in [1.0.0-alpha19](https://developer.android.com/jetpack/androidx/releases/privacysandbox-sdkruntime#1.0.0-alpha19)

```
public final void [registerSdkSandboxClientImportanceListener](https://developer.android.com/reference/androidx/privacysandbox/sdkruntime/provider/controller/SdkSandboxControllerCompat#registerSdkSandboxClientImportanceListener(java.util.concurrent.Executor,androidx.privacysandbox.sdkruntime.core.SdkSandboxClientImportanceListenerCompat))(
    @NonNull Executor executor,
    @NonNull SdkSandboxClientImportanceListenerCompat listenerCompat
)
```

> [!CAUTION]
> **This method is deprecated.**   
> This library is no longer supported.

Registers a listener to be notified of changes in the client's `https://developer.android.com/reference/android/app/ActivityManager.RunningAppProcessInfo.html#importance`.

| Parameters |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/util/concurrent/Executor.html executor` | Executor for running listenerCompat |
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/privacysandbox/sdkruntime/core/SdkSandboxClientImportanceListenerCompat listenerCompat` | an implementation of `https://developer.android.com/reference/androidx/privacysandbox/sdkruntime/core/SdkSandboxClientImportanceListenerCompat` to register. |

### unregisterSdkSandboxActivityHandler

Added in [1.0.0-alpha19](https://developer.android.com/jetpack/androidx/releases/privacysandbox-sdkruntime#1.0.0-alpha19) Deprecated in [1.0.0-alpha19](https://developer.android.com/jetpack/androidx/releases/privacysandbox-sdkruntime#1.0.0-alpha19)

```
public final void [unregisterSdkSandboxActivityHandler](https://developer.android.com/reference/androidx/privacysandbox/sdkruntime/provider/controller/SdkSandboxControllerCompat#unregisterSdkSandboxActivityHandler(androidx.privacysandbox.sdkruntime.core.activity.SdkSandboxActivityHandlerCompat))(
    @NonNull SdkSandboxActivityHandlerCompat handlerCompat
)
```

> [!CAUTION]
> **This method is deprecated.**   
> This library is no longer supported.

Unregister an already registered `https://developer.android.com/reference/androidx/privacysandbox/sdkruntime/core/activity/SdkSandboxActivityHandlerCompat`.

If the passed `https://developer.android.com/reference/androidx/privacysandbox/sdkruntime/core/activity/SdkSandboxActivityHandlerCompat` is registered, it will be unregistered. Otherwise, it will do nothing.

If the `https://developer.android.com/reference/android/os/IBinder.html` token of the unregistered handler used to start a `https://developer.android.com/reference/android/app/Activity.html`, the `https://developer.android.com/reference/android/app/Activity.html` will fail to start.

| Parameters |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/privacysandbox/sdkruntime/core/activity/SdkSandboxActivityHandlerCompat handlerCompat` | is the `https://developer.android.com/reference/androidx/privacysandbox/sdkruntime/core/activity/SdkSandboxActivityHandlerCompat` to unregister. |

| See also |
|---|---|
| `https://developer.android.com/reference/android/app/sdksandbox/sdkprovider/SdkSandboxController.html#unregisterSdkSandboxActivityHandler(android.app.sdksandbox.sdkprovider.SdkSandboxActivityHandler)` |   |

### unregisterSdkSandboxClientImportanceListener

Added in [1.0.0-alpha19](https://developer.android.com/jetpack/androidx/releases/privacysandbox-sdkruntime#1.0.0-alpha19) Deprecated in [1.0.0-alpha19](https://developer.android.com/jetpack/androidx/releases/privacysandbox-sdkruntime#1.0.0-alpha19)

```
public final void [unregisterSdkSandboxClientImportanceListener](https://developer.android.com/reference/androidx/privacysandbox/sdkruntime/provider/controller/SdkSandboxControllerCompat#unregisterSdkSandboxClientImportanceListener(androidx.privacysandbox.sdkruntime.core.SdkSandboxClientImportanceListenerCompat))(
    @NonNull SdkSandboxClientImportanceListenerCompat listenerCompat
)
```

> [!CAUTION]
> **This method is deprecated.**   
> This library is no longer supported.

Unregisters a listener previously registered using `https://developer.android.com/reference/androidx/privacysandbox/sdkruntime/provider/controller/SdkSandboxControllerCompat#registerSdkSandboxClientImportanceListener(java.util.concurrent.Executor,androidx.privacysandbox.sdkruntime.core.SdkSandboxClientImportanceListenerCompat)`

| Parameters |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/privacysandbox/sdkruntime/core/SdkSandboxClientImportanceListenerCompat listenerCompat` | an implementation of `https://developer.android.com/reference/androidx/privacysandbox/sdkruntime/core/SdkSandboxClientImportanceListenerCompat` to unregister. |