ObservableState is a read-only wrapper of a StateSubject. It can be used to provide assurances that the Subject itself cannot be accidentally retrieved via casting, but that accessors can still subscribe to the underlying Subject.

Observer

fun interface Observer<T>

Functional interface representing an Observer of items to be emitted by an Observable.

ReplaySubject

interface ReplaySubject<T> : Subject<T>

A ReplaySubject is a specialized Subject that also maintains the latest N emissions in a cache. Upon subscription, all values in the cache will be emitted to the subscriber.

Single

interface Single<T> : Subscribable<T>

A Subscribable implementation whereby only a single result is expected to be emitted to the subscriber.

SingleResult

typealias SingleResult<T> = Single<TealiumResult<T>>

A Single that completes with a TealiumResult.

StateSubject

interface StateSubject<T> : Subject<T> , ObservableState<T>

A StateSubject is a specialized Subject that also maintains the latest emission as state, retrievable via the value getter.

Subject

interface Subject<T> : Observable<T> , Observer<T>

A Subject is an Observable that can be used to publish new values to any subscribers, where an Observable cannot.

Subscribable

interface Subscribable<T>

A Subscribable object allows you to subscribe an Observer to receive updates from a specific source. Each updated value will be provided through the given Observer.onNext method.

SubscribableState

interface SubscribableState<T> : Subscribable<T>

A SubscribableState object allows you to subscribe an Observer to receive updates from a specific source - as with Subscribable. Each updated value will be provided through the given Observer.onNext method.

Functions

addTo

fun <T : Disposable> T.addTo(container: CompositeDisposable): T

Add the current disposable to a specific container for easier cleanup.

filterNotNull

fun <T> Observable<T?>.filterNotNull(): Observable<T>

Convenience method for converting an observable of nullable items, into an observable of non-nullable items.

mapToUnit

fun <T> Observable<T>.mapToUnit(): Observable<Unit>

Convenience method that maps any incoming emission to Unit

merge

fun <T> Iterable<Observable<T>>.merge(): Observable<T>

Convenience method for merging a Iterable group of Observables of the same type.

onFailure

fun <T : TealiumResult<R>, R> Single<T>.onFailure(handler: Callback<Exception>): Disposable

Subscribes a handler for handling only the failure element of this Single.

onSuccess

fun <T : TealiumResult<R>, R> Single<T>.onSuccess(handler: Callback<R>): Disposable

Subscribes a handler for handling only the successful element of this Single.