circuit-foundation/com.slack.circuit.foundation/EventListener

EventListener

@Stable

interface EventListener(source)

A listener for tracking the state changes of a given Screen. This can be used for instrumentation and other telemetry.

Types

Companion

object Companion

Factory

@Stable

fun interface Factory

Functions

dispose

open fun dispose()

Called once when this EventListener should be disposed and the corresponding circuit is disposed.

onAfterCreatePresenter

open fun onAfterCreatePresenter(screen: Screen, navigator: Navigator, presenter: Presenter<*>?, context: CircuitContext)

Called just after creating a presenter for a given screen. The presenter may be null if none was found.

onAfterCreateUi

open fun onAfterCreateUi(screen: Screen, ui: Ui<*>?, context: CircuitContext)

Called just after creating a ui for a given screen. The ui may be null if none was found.

onBeforeCreatePresenter

open fun onBeforeCreatePresenter(screen: Screen, navigator: Navigator, context: CircuitContext)

Called just before creating a Presenter for a given screen.

onBeforeCreateUi

open fun onBeforeCreateUi(screen: Screen, context: CircuitContext)

Called just before creating a Ui for a given screen.

onDisposeContent

open fun onDisposeContent()

Called once after the Ui.Content composition is disposed.

onDisposePresent

open fun onDisposePresent()

Called once after the Presenter.present composition is disposed.

onStartContent

open fun onStartContent()

Called once before the initial Ui.Content call.

onStartPresent

open fun onStartPresent()

Called once before the initial Presenter.present call.

onState

open fun onState(state: CircuitUiState)

Called when there is a new state returned by the Presenter. This is called every time state is recomposed.

onUnavailableContent

open fun onUnavailableContent(screen: Screen, presenter: Presenter<*>?, ui: Ui<*>?, context: CircuitContext)

Called when no content was found and one or both of presenter and ui are null.

start

open fun start()

Called once before doing any processing for the requested circuit.

EventListener

See also

Types

Functions