GWIoTApi/com.gw.gwiotapi.livedata

Package-level declarations

Types

An instance of NLifecycleOwner that is always observing (and never terminates).

actual typealias LifecycleOwner = androidx.lifecycle.LifecycleOwner

The LifecycleOwner is an interface that describes a component with an lifetime that makes observations for a period of time and and is eventually terminated.

actual typealias LifecycleOwner = NLifecycleOwner

The implementation of LiveData components for iOS applications.

LiveData

actual typealias LiveData<T> = androidx.lifecycle.LiveData<T>

expect abstract class LiveData<T>

LiveData is an abstract class describing a data holder class that is observed within a lifetime.

actual typealias LiveData<T> = NLiveData<T>

LiveEvent

actual open class LiveEvent<T> : LiveData<T>

expect open class LiveEvent<T> : LiveData<T>

LiveEvent和MutableLiveEvent用于透传事件，和LiveData的区别在于，LiveEvent不会触发旧值的监听

actual open class LiveEvent<T> : NLiveData<T>

MutableLiveData

actual typealias MutableLiveData<T> = androidx.lifecycle.MutableLiveData<T>

expect open class MutableLiveData<T> : LiveData<T>

The MutableLiveData is an extension of LiveData that can have its value changed.

actual open class MutableLiveData<T> : NLiveData<T>

MutableLiveEvent

actual open class MutableLiveEvent<T> : LiveEvent<T>

expect class MutableLiveEvent<T> : LiveEvent<T>

actual open class MutableLiveEvent<T> : LiveEvent<T>

NLifecycleListener

interface NLifecycleListener

The NLifecycleListener is a component that listens to changes in the lifetime of a NLifecycleOwner.

NLifecycleOwner

interface NLifecycleOwner

The NLifecycleOwner is an interface that describes a component with an lifetime that makes observations for a period of time and and is eventually terminated.

NLiveData

abstract class NLiveData<T>(_value: T?, postman: Postman<T>?)

NLiveData is an implementation of LiveData using kotlin components. It is designed to be shared between platforms that do not provide their own native solution (ie. Android).

NObserver

interface NObserver<T>

The Observer is an interface that describes a component that is notified when a watched value is changed.

Observer

actual typealias Observer<T> = androidx.lifecycle.Observer<T>

expect interface Observer<T>

The Observer is an interface that describes a component that is notified when a watched value is changed.

actual typealias Observer<T> = NObserver<T>

OnceEvent

class OnceEvent<out T : Any>(value: T)

The OnceEvent is an object containing a value that is to be consumed once and only once.

Postman

interface Postman<T>

The Postman is an interface used to post a value to a LiveData object on the next event loop of the main thread.

WeakEventOwner

class WeakEventOwner<T : Any>(val obj: <Error class: unknown class><T>) : NLifecycleOwner

WeakOwner

class WeakOwner<T : Any>(val obj: <Error class: unknown class><T>) : NLifecycleOwner

Functions

consume

fun <T : Any> LiveData<OnceEvent<T>>.consume(owner: LifecycleOwner, block: (T) -> Unit): Observer<OnceEvent<T>>

Consume the event as dispatched from the data object.