SessionObserverFactoryRegistry


public interface SessionObserverFactoryRegistry

Known direct subclasses
AbstractSandboxedUiAdapter

An abstract class that implements SandboxedUiAdapter while abstracting away methods that do not need to be implemented by a UI provider.


Summary

Public methods

abstract void
addObserverFactory(
    @NonNull SessionObserverFactory sessionObserverFactory
)

Adds a SessionObserverFactory for tracking UI presentation state across UI sessions.

abstract @NonNull List<@NonNull SessionObserverFactory>
abstract void
removeObserverFactory(
    @NonNull SessionObserverFactory sessionObserverFactory
)

Removes a SessionObserverFactory, if it has been previously added with addObserverFactory.

Public methods

addObserverFactory

Added in 1.0.0-alpha13
abstract void addObserverFactory(
    @NonNull SessionObserverFactory sessionObserverFactory
)

Adds a SessionObserverFactory for tracking UI presentation state across UI sessions. This has no effect on already open sessions.

For each session that is created for the adapter after this call returns, SessionObserverFactory.create will be invoked to allow a new SessionObserver instance to be attached to the UI session. This SessionObserver will receive UI updates for the lifetime of the session. A separate SessionObserverFactory.create call will be made for each UI session.

getSessionObserverFactories

Added in 1.0.0-alpha13
abstract @NonNull List<@NonNull SessionObserverFactorygetSessionObserverFactories()

removeObserverFactory

Added in 1.0.0-alpha13
abstract void removeObserverFactory(
    @NonNull SessionObserverFactory sessionObserverFactory
)

Removes a SessionObserverFactory, if it has been previously added with addObserverFactory.

If the SessionObserverFactory was not previously added, no action is performed. Any existing SessionObserver instances that have been created by the SessionObserverFactory will continue to receive updates until their corresponding UI session has been closed. For any subsequent sessions created], no call to SessionObserverFactory.create will be made.