SandboxedUiAdapter.Session


public interface SandboxedUiAdapter.Session extends AutoCloseable

Known direct subclasses
AbstractSandboxedUiAdapter.AbstractSession

An abstract class that implements SandboxedUiAdapter.Session so that a UI provider does not need to implement the entire interface.


A single session with the provider of remote content.

Summary

Public methods

abstract void

Close this session, indicating that the remote provider of content should dispose of associated resources and that the SessionClient should not receive further callback events.

abstract @NonNull Set<@NonNull String>

The set of options that will be used to determine what information is calculated and sent to SessionObservers attached to this session.

abstract @NonNull View

Return the View that presents content for this session.

abstract void

Notify the session that the host configuration has changed to configuration.

abstract void
notifyResized(int width, int height)

Notify the provider that the size of the host presentation area has changed to a size of width x height pixels.

abstract void
notifyUiChanged(@NonNull Bundle uiContainerInfo)

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

abstract void
notifyZOrderChanged(boolean isZOrderOnTop)

Notify the provider that there's a change in the intended z order of the session UI and it is now set to isZOrderOnTop.

Public methods

close

Added in 1.0.0-alpha12
abstract void close()

Close this session, indicating that the remote provider of content should dispose of associated resources and that the SessionClient should not receive further callback events.

getSignalOptions

Added in 1.0.0-alpha12
abstract @NonNull Set<@NonNull StringgetSignalOptions()

The set of options that will be used to determine what information is calculated and sent to SessionObservers attached to this session.

This value should not be directly set by UI providers. Instead, the registration of any SessionObserverFactory with addObserverFactory will indicate that information should be calculated for this session.

getView

Added in 1.0.0-alpha12
abstract @NonNull View getView()

Return the View that presents content for this session. The same view will be returned for the life of the session object. Accessing view after close may throw an IllegalStateException.

notifyConfigurationChanged

Added in 1.0.0-alpha12
abstract void notifyConfigurationChanged(@NonNull Configuration configuration)

Notify the session that the host configuration has changed to configuration.

notifyResized

Added in 1.0.0-alpha12
abstract void notifyResized(int width, int height)

Notify the provider that the size of the host presentation area has changed to a size of width x height pixels.

notifyUiChanged

Added in 1.0.0-alpha12
abstract void notifyUiChanged(@NonNull Bundle uiContainerInfo)

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

uiContainerInfo 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 use addObserverFactory to observe UI changes rather than using this method.

notifyZOrderChanged

Added in 1.0.0-alpha12
abstract void notifyZOrderChanged(boolean isZOrderOnTop)

Notify the provider that there's a change in the intended z order of the session UI and it is now set to isZOrderOnTop.