# AbstractSandboxedUiAdapter.AbstractSession

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/AbstractSandboxedUiAdapter.kt+class:androidx.privacysandbox.ui.provider.AbstractSandboxedUiAdapter.AbstractSession) 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)

*** ** * ** ***


```
public abstract class AbstractSandboxedUiAdapter.AbstractSession implements SandboxedUiAdapter.Session
```

<br />

*** ** * ** ***

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

An abstract class that implements `https://developer.android.com/reference/androidx/privacysandbox/ui/core/SandboxedUiAdapter.Session` so that a UI provider does not need to implement the entire interface.

UI providers should use this class rather than implementing `https://developer.android.com/reference/androidx/privacysandbox/ui/core/SandboxedUiAdapter.Session`.

## Summary

| ### Public constructors |
|---|
| `[AbstractSession](https://developer.android.com/reference/androidx/privacysandbox/ui/provider/AbstractSandboxedUiAdapter.AbstractSession#AbstractSession())()` **This method is deprecated.** This library is no longer supported. |

| ### Public methods |
|---|---|
| `void` | `[close](https://developer.android.com/reference/androidx/privacysandbox/ui/provider/AbstractSandboxedUiAdapter.AbstractSession#close())()` **This method is deprecated.** This library is no longer supported. |
| `final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/util/Set.html<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html>` | `[getSignalOptions](https://developer.android.com/reference/androidx/privacysandbox/ui/provider/AbstractSandboxedUiAdapter.AbstractSession#getSignalOptions())()` **This method is deprecated.** This library is no longer supported. |
| `void` | `[notifyConfigurationChanged](https://developer.android.com/reference/androidx/privacysandbox/ui/provider/AbstractSandboxedUiAdapter.AbstractSession#notifyConfigurationChanged(android.content.res.Configuration))(@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/android/content/res/Configuration.html configuration)` **This method is deprecated.** This library is no longer supported. |
| `void` | `[notifyResized](https://developer.android.com/reference/androidx/privacysandbox/ui/provider/AbstractSandboxedUiAdapter.AbstractSession#notifyResized(kotlin.Int,kotlin.Int))(int width, int height)` **This method is deprecated.** This library is no longer supported. |
| `void` | `[notifySessionRendered](https://developer.android.com/reference/androidx/privacysandbox/ui/provider/AbstractSandboxedUiAdapter.AbstractSession#notifySessionRendered(kotlin.collections.Set))( @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/util/Set.html<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html> supportedSignalOptions )` **This method is deprecated.** This library is no longer supported. |
| `void` | `[notifyUiChanged](https://developer.android.com/reference/androidx/privacysandbox/ui/provider/AbstractSandboxedUiAdapter.AbstractSession#notifyUiChanged(android.os.Bundle))(@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/android/os/Bundle.html uiContainerInfo)` **This method is deprecated.** This library is no longer supported. |
| `void` | `[notifyZOrderChanged](https://developer.android.com/reference/androidx/privacysandbox/ui/provider/AbstractSandboxedUiAdapter.AbstractSession#notifyZOrderChanged(kotlin.Boolean))(boolean isZOrderOnTop)` **This method is deprecated.** This library is no longer supported. |

| ### Inherited methods |
|---|
| From [androidx.privacysandbox.ui.core.SandboxedUiAdapter.Session](https://developer.android.com/reference/androidx/privacysandbox/ui/core/SandboxedUiAdapter.Session) |---|---| | `abstract @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/android/view/View.html` | `[getView](https://developer.android.com/reference/androidx/privacysandbox/ui/core/SandboxedUiAdapter.Session#getView())()` **This method is deprecated.** This library is no longer supported. | |

## Public constructors

### AbstractSession

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)

```
public [AbstractSession](https://developer.android.com/reference/androidx/privacysandbox/ui/provider/AbstractSandboxedUiAdapter.AbstractSession#AbstractSession())()
```

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

## Public methods

### close

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)

```
public void [close](https://developer.android.com/reference/androidx/privacysandbox/ui/provider/AbstractSandboxedUiAdapter.AbstractSession#close())()
```

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

Close this session, indicating that the remote provider of content should dispose of associated resources and that the `https://developer.android.com/reference/androidx/privacysandbox/ui/core/SandboxedUiAdapter.SessionClient` should not receive further callback events.

### getSignalOptions

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)

```
public final @NonNull Set<@NonNull String> [getSignalOptions](https://developer.android.com/reference/androidx/privacysandbox/ui/provider/AbstractSandboxedUiAdapter.AbstractSession#getSignalOptions())()
```

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

The set of options that will be used to determine what information is calculated and sent to `https://developer.android.com/reference/androidx/privacysandbox/ui/core/SessionObserver`s attached to this session.

This value should not be directly set by UI providers. Instead, the registration of any `https://developer.android.com/reference/androidx/privacysandbox/ui/core/SessionObserverFactory` will indicate that information should be calculated for this session.

### notifyConfigurationChanged

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)

```
public void [notifyConfigurationChanged](https://developer.android.com/reference/androidx/privacysandbox/ui/provider/AbstractSandboxedUiAdapter.AbstractSession#notifyConfigurationChanged(android.content.res.Configuration))(@NonNull Configuration configuration)
```

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

Notify the session that the host configuration has changed to `https://developer.android.com/reference/androidx/privacysandbox/ui/core/SandboxedUiAdapter.Session#notifyConfigurationChanged(android.content.res.Configuration)`.

### notifyResized

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)

```
public void [notifyResized](https://developer.android.com/reference/androidx/privacysandbox/ui/provider/AbstractSandboxedUiAdapter.AbstractSession#notifyResized(kotlin.Int,kotlin.Int))(int width, int height)
```

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

Notify the provider that the size of the host presentation area has changed to a size of `https://developer.android.com/reference/androidx/privacysandbox/ui/core/SandboxedUiAdapter.Session#notifyResized(kotlin.Int,kotlin.Int)` x `https://developer.android.com/reference/androidx/privacysandbox/ui/core/SandboxedUiAdapter.Session#notifyResized(kotlin.Int,kotlin.Int)` pixels.

### notifySessionRendered

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)

```
public void [notifySessionRendered](https://developer.android.com/reference/androidx/privacysandbox/ui/provider/AbstractSandboxedUiAdapter.AbstractSession#notifySessionRendered(kotlin.collections.Set))(
    @NonNull Set<@NonNull String> supportedSignalOptions
)
```

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

Notifies that the session has been rendered inside the container hosting this session.

`https://developer.android.com/reference/androidx/privacysandbox/ui/core/SandboxedUiAdapter.Session#notifySessionRendered(kotlin.collections.Set)` specifies the signal options which are supported by the host container.

UI providers should add `https://developer.android.com/reference/androidx/privacysandbox/ui/core/SessionObserverFactory`s to receive this value rather than using this method directly. This API is used to notify the `https://developer.android.com/reference/androidx/privacysandbox/ui/core/SessionObserver`s associated with this session about the supported signal options for this session.

| See also |
|---|---|
| `https://developer.android.com/reference/androidx/privacysandbox/ui/core/SandboxedUiAdapterSignalOptions` |   |

### notifyUiChanged

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)

```
public void [notifyUiChanged](https://developer.android.com/reference/androidx/privacysandbox/ui/provider/AbstractSandboxedUiAdapter.AbstractSession#notifyUiChanged(android.os.Bundle))(@NonNull Bundle uiContainerInfo)
```

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

Notify the session when the presentation state of its UI container has changed.

`https://developer.android.com/reference/androidx/privacysandbox/ui/core/SandboxedUiAdapter.Session#notifyUiChanged(android.os.Bundle)` contains a Bundle that represents the state of the container. The exact details of this Bundle depend on the container this Bundle is describing. This notification is not in real time and is throttled, so it should not be used to react to UI changes on the client side.

UI providers should add `https://developer.android.com/reference/androidx/privacysandbox/ui/core/SessionObserverFactory`s to observe UI changes rather than using this method directly.

### notifyZOrderChanged

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)

```
public void [notifyZOrderChanged](https://developer.android.com/reference/androidx/privacysandbox/ui/provider/AbstractSandboxedUiAdapter.AbstractSession#notifyZOrderChanged(kotlin.Boolean))(boolean isZOrderOnTop)
```

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

Notify the provider that there's a change in the intended z order of the session UI and it is now set to `https://developer.android.com/reference/androidx/privacysandbox/ui/core/SandboxedUiAdapter.Session#notifyZOrderChanged(kotlin.Boolean)`.