SdkSandboxControllerCompat
public final 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 methods |
|
|---|---|
static final @NonNull SdkSandboxControllerCompat |
Creates |
final @NonNull List<@NonNull AppOwnedSdkSandboxInterfaceCompat> |
Fetches all |
final @NonNull String |
Returns the package name of the client app. |
final @NonNull List<@NonNull SandboxedSdkCompat> |
Fetches information about Sdks that are loaded in the sandbox or locally. |
final @NonNull SandboxedSdkCompat |
Load SDK in a SDK sandbox java process or locally. |
final @NonNull IBinder |
registerSdkSandboxActivityHandler(Returns an identifier for a |
final void |
unregisterSdkSandboxActivityHandler(Unregister an already registered |
Public methods
from
public static final @NonNull SdkSandboxControllerCompat from(@NonNull Context context)
Creates SdkSandboxControllerCompat.
| Returns | |
|---|---|
@NonNull SdkSandboxControllerCompat |
SdkSandboxControllerCompat object. |
getAppOwnedSdkSandboxInterfaces
public final @NonNull List<@NonNull AppOwnedSdkSandboxInterfaceCompat> getAppOwnedSdkSandboxInterfaces()
Fetches all AppOwnedSdkSandboxInterfaceCompat that are registered by the app.
| Returns | |
|---|---|
@NonNull List<@NonNull AppOwnedSdkSandboxInterfaceCompat> |
List of all currently registered |
getClientPackageName
public final @NonNull String getClientPackageName()
Returns the package name of the client app.
getSandboxedSdks
public final @NonNull List<@NonNull SandboxedSdkCompat> getSandboxedSdks()
Fetches information about Sdks that are loaded in the sandbox or locally.
| Returns | |
|---|---|
@NonNull List<@NonNull SandboxedSdkCompat> |
List of |
| See also | |
|---|---|
getSandboxedSdks |
loadSdk
public final @NonNull SandboxedSdkCompat loadSdk(@NonNull String sdkName, @NonNull Bundle params)
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 | |
|---|---|
@NonNull String sdkName |
name of the SDK to be loaded. |
@NonNull Bundle params |
additional parameters to be passed to the SDK in the form of a |
| Returns | |
|---|---|
@NonNull SandboxedSdkCompat |
|
| Throws | |
|---|---|
androidx.privacysandbox.sdkruntime.core.LoadSdkCompatException |
on fail. |
registerSdkSandboxActivityHandler
public final @NonNull IBinder registerSdkSandboxActivityHandler(
@NonNull SdkSandboxActivityHandlerCompat handlerCompat
)
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 | |
|---|---|
@NonNull SdkSandboxActivityHandlerCompat handlerCompat |
is the |
| Returns | |
|---|---|
@NonNull IBinder |
|
| See also | |
|---|---|
registerSdkSandboxActivityHandler |
unregisterSdkSandboxActivityHandler
public final void unregisterSdkSandboxActivityHandler(
@NonNull SdkSandboxActivityHandlerCompat handlerCompat
)
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 | |
|---|---|
@NonNull SdkSandboxActivityHandlerCompat handlerCompat |
is the |
| See also | |
|---|---|
unregisterSdkSandboxActivityHandler |