# 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)

*** ** * ** ***

Kotlin\|[Java](https://developer.android.com/reference/androidx/privacysandbox/sdkruntime/provider/controller/SdkSandboxControllerCompat "View this page in Java")

<br />

```
class SdkSandboxControllerCompat
```

<br />

*** ** * ** ***

| **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[SdkSandboxControllerCompat.from](https://developer.android.com/reference/kotlin/androidx/privacysandbox/sdkruntime/provider/controller/SdkSandboxControllerCompat#from(android.content.Context)). The[Context](https://developer.android.com/reference/android/content/Context.html)can be obtained using[SandboxedSdkProviderCompat.context](https://developer.android.com/reference/kotlin/androidx/privacysandbox/sdkruntime/core/SandboxedSdkProviderCompat#context()).  

|                                                           See also                                                           |
|------------------------------------------------------------------------------------------------------------------------------|---|
| [SdkSandboxController](https://developer.android.com/reference/android/app/sdksandbox/sdkprovider/SdkSandboxController.html) |   |

## Summary

|                                                                 ### Public companion functions                                                                 |
|----------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [SdkSandboxControllerCompat](https://developer.android.com/reference/kotlin/androidx/privacysandbox/sdkruntime/provider/controller/SdkSandboxControllerCompat) | [from](https://developer.android.com/reference/kotlin/androidx/privacysandbox/sdkruntime/provider/controller/SdkSandboxControllerCompat#from(android.content.Context))`(context: `[Context](https://developer.android.com/reference/android/content/Context.html)`)` Creates[SdkSandboxControllerCompat](https://developer.android.com/reference/kotlin/androidx/privacysandbox/sdkruntime/provider/controller/SdkSandboxControllerCompat). |

|                                                                                                                     ### Public functions                                                                                                                     |
|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [List](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html)`<`[AppOwnedSdkSandboxInterfaceCompat](https://developer.android.com/reference/kotlin/androidx/privacysandbox/sdkruntime/core/AppOwnedSdkSandboxInterfaceCompat)`>` | [getAppOwnedSdkSandboxInterfaces](https://developer.android.com/reference/kotlin/androidx/privacysandbox/sdkruntime/provider/controller/SdkSandboxControllerCompat#getAppOwnedSdkSandboxInterfaces())`()` Fetches all[AppOwnedSdkSandboxInterfaceCompat](https://developer.android.com/reference/kotlin/androidx/privacysandbox/sdkruntime/core/AppOwnedSdkSandboxInterfaceCompat)that are registered by the app.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| [String](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html)                                                                                                                                                                            | [getClientPackageName](https://developer.android.com/reference/kotlin/androidx/privacysandbox/sdkruntime/provider/controller/SdkSandboxControllerCompat#getClientPackageName())`()` Returns the package name of the client app.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| [List](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html)`<`[SandboxedSdkCompat](https://developer.android.com/reference/kotlin/androidx/privacysandbox/sdkruntime/core/SandboxedSdkCompat)`>`                               | [getSandboxedSdks](https://developer.android.com/reference/kotlin/androidx/privacysandbox/sdkruntime/provider/controller/SdkSandboxControllerCompat#getSandboxedSdks())`()` Fetches information about Sdks that are loaded in the sandbox or locally.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| `suspend `[SandboxedSdkCompat](https://developer.android.com/reference/kotlin/androidx/privacysandbox/sdkruntime/core/SandboxedSdkCompat)                                                                                                                    | [loadSdk](https://developer.android.com/reference/kotlin/androidx/privacysandbox/sdkruntime/provider/controller/SdkSandboxControllerCompat#loadSdk(kotlin.String,android.os.Bundle))`(sdkName: `[String](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html)`, params: `[Bundle](https://developer.android.com/reference/android/os/Bundle.html)`)` Load SDK in a SDK sandbox java process or locally.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| [IBinder](https://developer.android.com/reference/android/os/IBinder.html)                                                                                                                                                                                   | [registerSdkSandboxActivityHandler](https://developer.android.com/reference/kotlin/androidx/privacysandbox/sdkruntime/provider/controller/SdkSandboxControllerCompat#registerSdkSandboxActivityHandler(androidx.privacysandbox.sdkruntime.core.activity.SdkSandboxActivityHandlerCompat))`(` ` handlerCompat: `[SdkSandboxActivityHandlerCompat](https://developer.android.com/reference/kotlin/androidx/privacysandbox/sdkruntime/core/activity/SdkSandboxActivityHandlerCompat) `)` Returns an identifier for a[SdkSandboxActivityHandlerCompat](https://developer.android.com/reference/kotlin/androidx/privacysandbox/sdkruntime/core/activity/SdkSandboxActivityHandlerCompat)after registering it.                                                                                                                                                                                                          |
| [Unit](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html)                                                                                                                                                                                | [registerSdkSandboxClientImportanceListener](https://developer.android.com/reference/kotlin/androidx/privacysandbox/sdkruntime/provider/controller/SdkSandboxControllerCompat#registerSdkSandboxClientImportanceListener(java.util.concurrent.Executor,androidx.privacysandbox.sdkruntime.core.SdkSandboxClientImportanceListenerCompat))`(` ` executor: `[Executor](https://developer.android.com/reference/java/util/concurrent/Executor.html)`,` ` listenerCompat: `[SdkSandboxClientImportanceListenerCompat](https://developer.android.com/reference/kotlin/androidx/privacysandbox/sdkruntime/core/SdkSandboxClientImportanceListenerCompat) `)` Registers a listener to be notified of changes in the client's[android.app.ActivityManager.RunningAppProcessInfo.importance](https://developer.android.com/reference/android/app/ActivityManager.RunningAppProcessInfo.html#importance()).                 |
| [Unit](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html)                                                                                                                                                                                | [unregisterSdkSandboxActivityHandler](https://developer.android.com/reference/kotlin/androidx/privacysandbox/sdkruntime/provider/controller/SdkSandboxControllerCompat#unregisterSdkSandboxActivityHandler(androidx.privacysandbox.sdkruntime.core.activity.SdkSandboxActivityHandlerCompat))`(` ` handlerCompat: `[SdkSandboxActivityHandlerCompat](https://developer.android.com/reference/kotlin/androidx/privacysandbox/sdkruntime/core/activity/SdkSandboxActivityHandlerCompat) `)` Unregister an already registered[SdkSandboxActivityHandlerCompat](https://developer.android.com/reference/kotlin/androidx/privacysandbox/sdkruntime/core/activity/SdkSandboxActivityHandlerCompat).                                                                                                                                                                                                                     |
| [Unit](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html)                                                                                                                                                                                | [unregisterSdkSandboxClientImportanceListener](https://developer.android.com/reference/kotlin/androidx/privacysandbox/sdkruntime/provider/controller/SdkSandboxControllerCompat#unregisterSdkSandboxClientImportanceListener(androidx.privacysandbox.sdkruntime.core.SdkSandboxClientImportanceListenerCompat))`(` ` listenerCompat: `[SdkSandboxClientImportanceListenerCompat](https://developer.android.com/reference/kotlin/androidx/privacysandbox/sdkruntime/core/SdkSandboxClientImportanceListenerCompat) `)` Unregisters a listener previously registered using[registerSdkSandboxClientImportanceListener](https://developer.android.com/reference/kotlin/androidx/privacysandbox/sdkruntime/provider/controller/SdkSandboxControllerCompat#registerSdkSandboxClientImportanceListener(java.util.concurrent.Executor,androidx.privacysandbox.sdkruntime.core.SdkSandboxClientImportanceListenerCompat)) |

## Public companion functions

### 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)  

```
fun from(context: Context): SdkSandboxControllerCompat
```

Creates[SdkSandboxControllerCompat](https://developer.android.com/reference/kotlin/androidx/privacysandbox/sdkruntime/provider/controller/SdkSandboxControllerCompat).  

|                                         Parameters                                         |
|--------------------------------------------------------------------------------------------|-------------|
| `context: `[Context](https://developer.android.com/reference/android/content/Context.html) | SDK context |

|                                                                            Returns                                                                             |
|----------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------|
| [SdkSandboxControllerCompat](https://developer.android.com/reference/kotlin/androidx/privacysandbox/sdkruntime/provider/controller/SdkSandboxControllerCompat) | SdkSandboxControllerCompat object. |

## Public functions

### 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)  

```
fun getAppOwnedSdkSandboxInterfaces(): List<AppOwnedSdkSandboxInterfaceCompat>
```

Fetches all[AppOwnedSdkSandboxInterfaceCompat](https://developer.android.com/reference/kotlin/androidx/privacysandbox/sdkruntime/core/AppOwnedSdkSandboxInterfaceCompat)that are registered by the app.  

|                                                                                                                           Returns                                                                                                                            |
|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [List](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html)`<`[AppOwnedSdkSandboxInterfaceCompat](https://developer.android.com/reference/kotlin/androidx/privacysandbox/sdkruntime/core/AppOwnedSdkSandboxInterfaceCompat)`>` | List of all currently registered[AppOwnedSdkSandboxInterfaceCompat](https://developer.android.com/reference/kotlin/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)  

```
fun getClientPackageName(): String
```

Returns the package name of the client app.  

|                                      Returns                                      |
|-----------------------------------------------------------------------------------|---------------------------------|
| [String](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.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)  

```
fun getSandboxedSdks(): List<SandboxedSdkCompat>
```

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

|                                                                                                            Returns                                                                                                             |
|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [List](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html)`<`[SandboxedSdkCompat](https://developer.android.com/reference/kotlin/androidx/privacysandbox/sdkruntime/core/SandboxedSdkCompat)`>` | List of[SandboxedSdkCompat](https://developer.android.com/reference/kotlin/androidx/privacysandbox/sdkruntime/core/SandboxedSdkCompat)containing all currently loaded sdks |

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

### loadSdk

```
suspend fun loadSdk(sdkName: String, params: Bundle): SandboxedSdkCompat
```

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                                          |
|----------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `sdkName: `[String](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html) | name of the SDK to be loaded.                                                                                                                                                   |
| `params: `[Bundle](https://developer.android.com/reference/android/os/Bundle.html)           | additional parameters to be passed to the SDK in the form of a[Bundle](https://developer.android.com/reference/android/os/Bundle.html)as agreed between the client and the SDK. |

|                                                             Returns                                                             |
|---------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [SandboxedSdkCompat](https://developer.android.com/reference/kotlin/androidx/privacysandbox/sdkruntime/core/SandboxedSdkCompat) | [SandboxedSdkCompat](https://developer.android.com/reference/kotlin/androidx/privacysandbox/sdkruntime/core/SandboxedSdkCompat)from SDK on a successful run. |

|                                                                                     Throws                                                                                      |
|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------|
| [androidx.privacysandbox.sdkruntime.core.LoadSdkCompatException](https://developer.android.com/reference/kotlin/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)  

```
fun registerSdkSandboxActivityHandler(
    handlerCompat: SdkSandboxActivityHandlerCompat
): IBinder
```

Returns an identifier for a[SdkSandboxActivityHandlerCompat](https://developer.android.com/reference/kotlin/androidx/privacysandbox/sdkruntime/core/activity/SdkSandboxActivityHandlerCompat)after registering it.

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

|                                                                                     Parameters                                                                                      |
|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `handlerCompat: `[SdkSandboxActivityHandlerCompat](https://developer.android.com/reference/kotlin/androidx/privacysandbox/sdkruntime/core/activity/SdkSandboxActivityHandlerCompat) | is the[SdkSandboxActivityHandlerCompat](https://developer.android.com/reference/kotlin/androidx/privacysandbox/sdkruntime/core/activity/SdkSandboxActivityHandlerCompat)to register |

|                                  Returns                                   |
|----------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [IBinder](https://developer.android.com/reference/android/os/IBinder.html) | [IBinder](https://developer.android.com/reference/android/os/IBinder.html)uniquely identify the passed[SdkSandboxActivityHandlerCompat](https://developer.android.com/reference/kotlin/androidx/privacysandbox/sdkruntime/core/activity/SdkSandboxActivityHandlerCompat) |

|                                                                                                                 See also                                                                                                                  |
|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|
| [registerSdkSandboxActivityHandler](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)  

```
fun registerSdkSandboxClientImportanceListener(
    executor: Executor,
    listenerCompat: SdkSandboxClientImportanceListenerCompat
): Unit
```

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

|                                                                                          Parameters                                                                                           |
|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `executor: `[Executor](https://developer.android.com/reference/java/util/concurrent/Executor.html)                                                                                            | Executor for running listenerCompat                                                                                                                                                                         |
| `listenerCompat: `[SdkSandboxClientImportanceListenerCompat](https://developer.android.com/reference/kotlin/androidx/privacysandbox/sdkruntime/core/SdkSandboxClientImportanceListenerCompat) | an implementation of[SdkSandboxClientImportanceListenerCompat](https://developer.android.com/reference/kotlin/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)  

```
fun unregisterSdkSandboxActivityHandler(
    handlerCompat: SdkSandboxActivityHandlerCompat
): Unit
```

Unregister an already registered[SdkSandboxActivityHandlerCompat](https://developer.android.com/reference/kotlin/androidx/privacysandbox/sdkruntime/core/activity/SdkSandboxActivityHandlerCompat).

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

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

|                                                                                     Parameters                                                                                      |
|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `handlerCompat: `[SdkSandboxActivityHandlerCompat](https://developer.android.com/reference/kotlin/androidx/privacysandbox/sdkruntime/core/activity/SdkSandboxActivityHandlerCompat) | is the[SdkSandboxActivityHandlerCompat](https://developer.android.com/reference/kotlin/androidx/privacysandbox/sdkruntime/core/activity/SdkSandboxActivityHandlerCompat)to unregister. |

|                                                                                                                   See also                                                                                                                    |
|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|
| [unregisterSdkSandboxActivityHandler](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)  

```
fun unregisterSdkSandboxClientImportanceListener(
    listenerCompat: SdkSandboxClientImportanceListenerCompat
): Unit
```

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

|                                                                                          Parameters                                                                                           |
|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `listenerCompat: `[SdkSandboxClientImportanceListenerCompat](https://developer.android.com/reference/kotlin/androidx/privacysandbox/sdkruntime/core/SdkSandboxClientImportanceListenerCompat) | an implementation of[SdkSandboxClientImportanceListenerCompat](https://developer.android.com/reference/kotlin/androidx/privacysandbox/sdkruntime/core/SdkSandboxClientImportanceListenerCompat)to unregister. |