platform_framework_api_common_lifecycle/com.tomtom.ivi.platform.framework.api.common.lifecycle/LifecycleAwareListeners

LifecycleAwareListeners

abstract class LifecycleAwareListeners<T>

LifecycleAwareListeners is a container for listeners with Android Lifecycle awareness.

It forwards events to registered listeners, depending on their lifecycle state. Events are forwarded to regular listeners when their lifecycle owner is active. Events for forever listeners are always received.

Lifecycle owners are considered active when their state is Lifecycle.State.STARTED or Lifecycle.State.RESUMED.

Listeners will be removed automatically when their lifecycle owner's state becomes Lifecycle.State.DESTROYED.

Constructors

LifecycleAwareListeners

fun LifecycleAwareListeners()

Properties

active

val active: LiveData<Boolean>

true when at least one of the registered listeners is active; false otherwise.

Functions

addListener

fun addListener(lifecycleOwner: LifecycleOwner, listener: T)

Add a listener that will receive events when its LifecycleOwner is active.

addListenerForever

fun addListenerForever(listener: T)

Add a listener that will always receive events.

removeListener

fun removeListener(listener: T)

Remove listener.

removeListeners

fun removeListeners(owner: LifecycleOwner)

Remove all listeners registered with a lifecycle owner.

Inheritors

LifecycleAwareListenersOwner