SdkSandboxControllerCompat
class SdkSandboxControllerCompat
Compat version of android.app.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. The Context can be obtained using SandboxedSdkProviderCompat.context.
| See also | |
|---|---|
SdkSandboxController |
Summary
Public companion functions |
|
|---|---|
SdkSandboxControllerCompat |
Creates |
Public functions |
|
|---|---|
List<AppOwnedSdkSandboxInterfaceCompat> |
Fetches all |
String |
Returns the package name of the client app. |
List<SandboxedSdkCompat> |
Fetches information about Sdks that are loaded in the sandbox or locally. |
suspend SandboxedSdkCompat |
Load SDK in a SDK sandbox java process or locally. |
IBinder |
registerSdkSandboxActivityHandler(Returns an identifier for a |
Unit |
unregisterSdkSandboxActivityHandler(Unregister an already registered |
Public companion functions
from
fun from(context: Context): SdkSandboxControllerCompat
Creates SdkSandboxControllerCompat.
| Parameters | |
|---|---|
context: Context |
SDK context |
| Returns | |
|---|---|
SdkSandboxControllerCompat |
SdkSandboxControllerCompat object. |
Public functions
getAppOwnedSdkSandboxInterfaces
fun getAppOwnedSdkSandboxInterfaces(): List<AppOwnedSdkSandboxInterfaceCompat>
Fetches all AppOwnedSdkSandboxInterfaceCompat that are registered by the app.
| Returns | |
|---|---|
List<AppOwnedSdkSandboxInterfaceCompat> |
List of all currently registered |
getClientPackageName
fun getClientPackageName(): String
Returns the package name of the client app.
| Returns | |
|---|---|
String |
Package name of the client app. |
getSandboxedSdks
fun getSandboxedSdks(): List<SandboxedSdkCompat>
Fetches information about Sdks that are loaded in the sandbox or locally.
| Returns | |
|---|---|
List<SandboxedSdkCompat> |
List of |
| See also | |
|---|---|
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 |
name of the SDK to be loaded. |
params: Bundle |
additional parameters to be passed to the SDK in the form of a |
| Returns | |
|---|---|
SandboxedSdkCompat |
|
| Throws | |
|---|---|
androidx.privacysandbox.sdkruntime.core.LoadSdkCompatException |
on fail. |
registerSdkSandboxActivityHandler
fun registerSdkSandboxActivityHandler(
handlerCompat: SdkSandboxActivityHandlerCompat
): IBinder
Returns an identifier for a SdkSandboxActivityHandlerCompat after registering it.
This function registers an implementation of SdkSandboxActivityHandlerCompat created by an SDK and returns an IBinder which uniquely identifies the passed SdkSandboxActivityHandlerCompat object.
| Parameters | |
|---|---|
handlerCompat: SdkSandboxActivityHandlerCompat |
is the |
| Returns | |
|---|---|
IBinder |
|
| See also | |
|---|---|
registerSdkSandboxActivityHandler |
unregisterSdkSandboxActivityHandler
fun unregisterSdkSandboxActivityHandler(
handlerCompat: SdkSandboxActivityHandlerCompat
): Unit
Unregister an already registered SdkSandboxActivityHandlerCompat.
If the passed SdkSandboxActivityHandlerCompat is registered, it will be unregistered. Otherwise, it will do nothing.
If the IBinder token of the unregistered handler used to start a android.app.Activity, the android.app.Activity will fail to start.
| Parameters | |
|---|---|
handlerCompat: SdkSandboxActivityHandlerCompat |
is the |
| See also | |
|---|---|
unregisterSdkSandboxActivityHandler |