# SandboxedUiAdapter

Artifact: [androidx.privacysandbox.ui:ui-core](https://developer.android.com/jetpack/androidx/releases/privacysandbox-ui) [View Source](https://cs.android.com/search?q=file:androidx/privacysandbox/ui/core/SandboxedUiAdapter.kt+class:androidx.privacysandbox.ui.core.SandboxedUiAdapter) Added in [1.0.0-alpha17](https://developer.android.com/jetpack/androidx/releases/privacysandbox-ui#1.0.0-alpha17) Deprecated in [1.0.0-alpha17](https://developer.android.com/jetpack/androidx/releases/privacysandbox-ui#1.0.0-alpha17)

*** ** * ** ***

<br />

```
public interface SandboxedUiAdapter
```

<br />

Known direct subclasses [AbstractSandboxedUiAdapter](https://developer.android.com/reference/androidx/privacysandbox/ui/provider/AbstractSandboxedUiAdapter), [DelegatingSandboxedUiAdapter](https://developer.android.com/reference/androidx/privacysandbox/ui/core/DelegatingSandboxedUiAdapter)

|---|---|
| `https://developer.android.com/reference/androidx/privacysandbox/ui/provider/AbstractSandboxedUiAdapter` | **This class is deprecated.** This library is no longer supported. |
| `https://developer.android.com/reference/androidx/privacysandbox/ui/core/DelegatingSandboxedUiAdapter` | **This class is deprecated.** This library is no longer supported. |

*** ** * ** ***

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

An Adapter that provides content from a SandboxedSdk to be displayed as part of a host app's UI.

## Summary

| ### Nested types |
|---|
| `public interface https://developer.android.com/reference/androidx/privacysandbox/ui/core/SandboxedUiAdapter.Session extends https://developer.android.com/reference/java/lang/AutoCloseable.html` **This interface is deprecated.** This library is no longer supported. |
| `public interface https://developer.android.com/reference/androidx/privacysandbox/ui/core/SandboxedUiAdapter.SessionClient` **This interface is deprecated.** This library is no longer supported. |

| ### Public methods |
|---|---|
| `abstract void` | `[openSession](https://developer.android.com/reference/androidx/privacysandbox/ui/core/SandboxedUiAdapter#openSession(android.content.Context,androidx.privacysandbox.ui.core.SessionData,kotlin.Int,kotlin.Int,kotlin.Boolean,java.util.concurrent.Executor,androidx.privacysandbox.ui.core.SandboxedUiAdapter.SessionClient))( @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/android/content/Context.html context, @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/privacysandbox/ui/core/SessionData sessionData, int initialWidth, int initialHeight, boolean isZOrderOnTop, @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/util/concurrent/Executor.html clientExecutor, @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/privacysandbox/ui/core/SandboxedUiAdapter.SessionClient client )` **This method is deprecated.** This library is no longer supported. |

| ### Extension functions |
|---|---|
| `default final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/android/os/Bundle.html` | `https://developer.android.com/reference/androidx/privacysandbox/ui/core/SandboxedUiAdapterProxy.[toCoreLibInfo](https://developer.android.com/reference/androidx/privacysandbox/ui/core/SandboxedUiAdapter#(androidx.privacysandbox.ui.core.SandboxedUiAdapter).toCoreLibInfo(android.content.Context))( @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/privacysandbox/ui/core/SandboxedUiAdapter receiver, @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. |

## Public methods

### openSession

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

```
abstract void [openSession](https://developer.android.com/reference/androidx/privacysandbox/ui/core/SandboxedUiAdapter#openSession(android.content.Context,androidx.privacysandbox.ui.core.SessionData,kotlin.Int,kotlin.Int,kotlin.Boolean,java.util.concurrent.Executor,androidx.privacysandbox.ui.core.SandboxedUiAdapter.SessionClient))(
    @NonNull Context context,
    @NonNull SessionData sessionData,
    int initialWidth,
    int initialHeight,
    boolean isZOrderOnTop,
    @NonNull Executor clientExecutor,
    @NonNull SandboxedUiAdapter.SessionClient client
)
```

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

Open a new session for displaying content with an initial size of `https://developer.android.com/reference/androidx/privacysandbox/ui/core/SandboxedUiAdapter#openSession(android.content.Context,androidx.privacysandbox.ui.core.SessionData,kotlin.Int,kotlin.Int,kotlin.Boolean,java.util.concurrent.Executor,androidx.privacysandbox.ui.core.SandboxedUiAdapter.SessionClient)`x`https://developer.android.com/reference/androidx/privacysandbox/ui/core/SandboxedUiAdapter#openSession(android.content.Context,androidx.privacysandbox.ui.core.SessionData,kotlin.Int,kotlin.Int,kotlin.Boolean,java.util.concurrent.Executor,androidx.privacysandbox.ui.core.SandboxedUiAdapter.SessionClient)` pixels. `https://developer.android.com/reference/androidx/privacysandbox/ui/core/SandboxedUiAdapter#openSession(android.content.Context,androidx.privacysandbox.ui.core.SessionData,kotlin.Int,kotlin.Int,kotlin.Boolean,java.util.concurrent.Executor,androidx.privacysandbox.ui.core.SandboxedUiAdapter.SessionClient)` will receive all incoming communication from the provider of content. All incoming calls to `https://developer.android.com/reference/androidx/privacysandbox/ui/core/SandboxedUiAdapter#openSession(android.content.Context,androidx.privacysandbox.ui.core.SessionData,kotlin.Int,kotlin.Int,kotlin.Boolean,java.util.concurrent.Executor,androidx.privacysandbox.ui.core.SandboxedUiAdapter.SessionClient)` will be made through the provided `https://developer.android.com/reference/androidx/privacysandbox/ui/core/SandboxedUiAdapter#openSession(android.content.Context,androidx.privacysandbox.ui.core.SessionData,kotlin.Int,kotlin.Int,kotlin.Boolean,java.util.concurrent.Executor,androidx.privacysandbox.ui.core.SandboxedUiAdapter.SessionClient)`. `https://developer.android.com/reference/androidx/privacysandbox/ui/core/SandboxedUiAdapter#openSession(android.content.Context,androidx.privacysandbox.ui.core.SessionData,kotlin.Int,kotlin.Int,kotlin.Boolean,java.util.concurrent.Executor,androidx.privacysandbox.ui.core.SandboxedUiAdapter.SessionClient)` tracks if the content surface will be placed on top of its window

## Extension functions

### SandboxedUiAdapterProxy.toCoreLibInfo

Artifact: [androidx.privacysandbox.ui:ui-provider](https://developer.android.com/jetpack/androidx/releases/privacysandbox-ui) [View Source](https://cs.android.com/search?q=file:androidx/privacysandbox/ui/provider/BinderAdapterDelegate.kt+function:toCoreLibInfo)

```
default final @NonNull Bundle SandboxedUiAdapterProxy.[toCoreLibInfo](https://developer.android.com/reference/androidx/privacysandbox/ui/core/SandboxedUiAdapter#(androidx.privacysandbox.ui.core.SandboxedUiAdapter).toCoreLibInfo(android.content.Context))(
    @NonNull SandboxedUiAdapter receiver,
    @NonNull Context context
)
```

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

Provides a `https://developer.android.com/reference/android/os/Bundle.html` containing a Binder which represents a `https://developer.android.com/reference/androidx/privacysandbox/ui/core/SandboxedUiAdapter`. The Bundle is shuttled to the host app in order for the `https://developer.android.com/reference/androidx/privacysandbox/ui/core/SandboxedUiAdapter` to be used to retrieve content.