SandboxedSdkUiSessionState

Artifact: androidx.privacysandbox.ui:ui-client

View Source

Added in 1.0.0-alpha10

---

Kotlin |Java

public sealed class SandboxedSdkUiSessionState

Known direct subclasses

SandboxedSdkUiSessionState.Active, SandboxedSdkUiSessionState.Error, SandboxedSdkUiSessionState.Idle, SandboxedSdkUiSessionState.Loading

SandboxedSdkUiSessionState.Active	There is an open session with the supplied SandboxedUiAdapter and its UI is currently being displayed.
SandboxedSdkUiSessionState.Error	There was an error in the UI session.
SandboxedSdkUiSessionState.Idle	There is no currently open UI session and there is no operation in progress to open one.
SandboxedSdkUiSessionState.Loading	A UI session is currently attempting to be opened.

---

Represents the state of a UI session.

A UI session refers to the session opened with a SandboxedUiAdapter to let the host display UI from the UI provider. If the host has requested to open a session with its SandboxedUiAdapter, the state will be Loading until the session has been opened and the content has been displayed. At this point, the state will become Active. If there is no active session and no session is being loaded, the state is Idle.

Summary

Nested types
public static class SandboxedSdkUiSessionState.Active extends SandboxedSdkUiSessionState There is an open session with the supplied SandboxedUiAdapter and its UI is currently being displayed.
public final class SandboxedSdkUiSessionState.Error extends SandboxedSdkUiSessionState There was an error in the UI session.
public static class SandboxedSdkUiSessionState.Idle extends SandboxedSdkUiSessionState There is no currently open UI session and there is no operation in progress to open one.
public static class SandboxedSdkUiSessionState.Loading extends SandboxedSdkUiSessionState A UI session is currently attempting to be opened.