SandboxedSdkProvider

Kotlin |Java

public abstract class SandboxedSdkProvider
extends Object

java.lang.Object
↳	android.app.sdksandbox.SandboxedSdkProvider

Encapsulates API which SDK sandbox can use to interact with SDKs loaded into it.

SDK has to implement this abstract class to generate an entry point for SDK sandbox to be able to call it through.

Summary

Public constructors
`SandboxedSdkProvider()`

Public methods
`final void`	`attachContext(Context context)` Sets the SDK `Context` which can then be received using `getContext()`.
`void`	`beforeUnloadSdk()` Does the work needed for the SDK to free its resources before being unloaded.
`final Context`	`getContext()` Return the `Context` previously set through `SandboxedSdkProvider#attachContext`.
`abstract View`	`getView(Context windowContext, Bundle params, int width, int height)` This method was deprecated in API level 36. This method will no longer be supported as it is being used by `SdkSandboxManager.requestSurfacePackage(String, Bundle, Executor, OutcomeReceiver)` which is getting deprecated.
`abstract SandboxedSdk`	`onLoadSdk(Bundle params)` Does the work needed for the SDK to start handling requests.

Inherited methods

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

Public constructors

SandboxedSdkProvider

Added in API level 34
Also in Ad Services Extensions 4

public SandboxedSdkProvider ()

Public methods

attachContext

Added in API level 34
Also in Ad Services Extensions 4

public final void attachContext (Context context)

Sets the SDK Context which can then be received using getContext(). This is called before onLoadSdk(Bundle) is invoked. No operations requiring a Context should be performed before then, as SandboxedSdkProvider#getContext will return null until this method has been called.

Throws IllegalStateException if a base context has already been set.

Parameters
`context`	`Context`: The new base context. This value cannot be `null`.

beforeUnloadSdk

Added in API level 34
Also in Ad Services Extensions 4

public void beforeUnloadSdk ()

Does the work needed for the SDK to free its resources before being unloaded.

This function is called by the SDK sandbox manager before it unloads the SDK. The SDK should fail any invocations on the Binder previously returned to the client through SandboxedSdk.getInterface().

The SDK should not do any long-running tasks here, like I/O and network calls.

getContext

Added in API level 34
Also in Ad Services Extensions 4

public final Context getContext ()

Return the Context previously set through SandboxedSdkProvider#attachContext. This will return null if no context has been previously set.

Returns
`Context`

getView

Added in API level 34
Also in Ad Services Extensions 4
Deprecated in API level 36

public abstract View getView (Context windowContext, 
                Bundle params, 
                int width, 
                int height)

This method was deprecated in API level 36.
This method will no longer be supported as it is being used by SdkSandboxManager.requestSurfacePackage(String, Bundle, Executor, OutcomeReceiver) which is getting deprecated.

Requests a view to be remotely rendered to the client app process.

Returns View will be wrapped into SurfacePackage. the resulting SurfacePackage will be sent back to the client application.

The SDK should not do any long-running tasks here, like I/O and network calls. Doing so can prevent the SDK from receiving requests from the client.

Parameters
`windowContext`	`Context`: the `Context` of the display which meant to show the view This value cannot be `null`.
`params`	`Bundle`: list of params passed from the client application requesting the view This value cannot be `null`.
`width`	`int`: The view returned will be laid as if in a window of this width, in pixels.
`height`	`int`: The view returned will be laid as if in a window of this height, in pixels.

Returns
`View`	a `View` which SDK sandbox pass to the client application requesting the view This value cannot be `null`.

onLoadSdk

Added in API level 34
Also in Ad Services Extensions 4

public abstract SandboxedSdk onLoadSdk (Bundle params)

Does the work needed for the SDK to start handling requests.

This function is called by the SDK sandbox after it loads the SDK.

SDK should do any work to be ready to handle upcoming requests. It should not do any long-running tasks here, like I/O and network calls. Doing so can prevent the SDK from receiving requests from the client. Additionally, it should not do initialization that depends on other SDKs being loaded into the SDK sandbox.

The SDK should not do any operations requiring a Context object before this method has been called.

Parameters
`params`	`Bundle`: list of params passed from the client when it loads the SDK. This can be empty. This value cannot be `null`.

Returns
`SandboxedSdk`	Returns a `SandboxedSdk`, passed back to the client. The IBinder used to create the `SandboxedSdk` object will be used by the client to call into the SDK. This value cannot be `null`.

Throws
`LoadSdkException`