SessionObserverFactoryRegistry


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 functions

Unit
addObserverFactory(sessionObserverFactory: SessionObserverFactory)

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

Unit

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

Public functions

addObserverFactory

Added in 1.0.0-alpha13
fun addObserverFactory(sessionObserverFactory: SessionObserverFactory): Unit

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.

removeObserverFactory

Added in 1.0.0-alpha13
fun removeObserverFactory(sessionObserverFactory: SessionObserverFactory): Unit

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.

Public properties

sessionObserverFactories

Added in 1.0.0-alpha13
val sessionObserverFactoriesList<SessionObserverFactory>