com.trello.rxlifecycle.android

Class RxLifecycleAndroid

java.lang.Object

com.trello.rxlifecycle.android.RxLifecycleAndroid

public class RxLifecycleAndroid
extends Object

Method Summary

Modifier and Type	Method and Description
static <T> com.trello.rxlifecycle.LifecycleTransformer<T>	bindActivity(Observable<ActivityEvent> lifecycle) Binds the given source to an Activity lifecycle.
static <T> com.trello.rxlifecycle.LifecycleTransformer<T>	bindFragment(Observable<FragmentEvent> lifecycle) Binds the given source to a Fragment lifecycle.
static <T> com.trello.rxlifecycle.LifecycleTransformer<T>	bindView(View view) Binds the given source to a View lifecycle.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

bindActivity

public static <T> com.trello.rxlifecycle.LifecycleTransformer<T> bindActivity(Observable<ActivityEvent> lifecycle)

Binds the given source to an Activity lifecycle.

Use with Observable.compose(Observable.Transformer): source.compose(RxLifecycleAndroid.bindActivity(lifecycle)).subscribe()

This helper automatically determines (based on the lifecycle sequence itself) when the source should stop emitting items. In the case that the lifecycle sequence is in the creation phase (CREATE, START, etc) it will choose the equivalent destructive phase (DESTROY, STOP, etc). If used in the destructive phase, the notifications will cease at the next event; for example, if used in PAUSE, it will unsubscribe in STOP.

Due to the differences between the Activity and Fragment lifecycles, this method should only be used for an Activity lifecycle.

Parameters:

lifecycle - the lifecycle sequence of an Activity * @return a reusable Observable.Transformer that unsubscribes the source during the Activity lifecycle

bindFragment

public static <T> com.trello.rxlifecycle.LifecycleTransformer<T> bindFragment(Observable<FragmentEvent> lifecycle)

Binds the given source to a Fragment lifecycle.

Use with Observable.compose(Observable.Transformer): source.compose(RxLifecycleAndroid.bindFragment(lifecycle)).subscribe()

This helper automatically determines (based on the lifecycle sequence itself) when the source should stop emitting items. In the case that the lifecycle sequence is in the creation phase (CREATE, START, etc) it will choose the equivalent destructive phase (DESTROY, STOP, etc). If used in the destructive phase, the notifications will cease at the next event; for example, if used in PAUSE, it will unsubscribe in STOP.

Due to the differences between the Activity and Fragment lifecycles, this method should only be used for a Fragment lifecycle.

Parameters:

lifecycle - the lifecycle sequence of a Fragment

Returns:

a reusable Observable.Transformer that unsubscribes the source during the Fragment lifecycle

bindView

public static <T> com.trello.rxlifecycle.LifecycleTransformer<T> bindView(View view)

Binds the given source to a View lifecycle.

Specifically, when the View detaches from the window, the sequence will be completed.

Use with Observable.compose(Observable.Transformer): source.compose(RxLifecycleAndroid.bindView(lifecycle)).subscribe()

Warning: you should make sure to use the returned Transformer on the main thread, since we're binding to a View (which only allows binding on the main thread).

Parameters:

view - the view to bind the source sequence to

Returns:

a reusable Observable.Transformer that unsubscribes the source during the View lifecycle