rx.android.observables

Class AndroidObservable

java.lang.Object

rx.android.observables.AndroidObservable

public final class AndroidObservable
extends java.lang.Object

Method Summary

Methods

Modifier and Type	Method and Description
static <T> rx.Observable<T>	bindActivity(android.app.Activity activity, rx.Observable<T> source) Binds the given source sequence to an activity.
static <T> rx.Observable<T>	bindFragment(java.lang.Object fragment, rx.Observable<T> source) Binds the given source sequence to a fragment (native or support-v4).
static <T> rx.Observable<T>	fromActivity(android.app.Activity activity, rx.Observable<T> sourceObservable) Deprecated. Use AndroidObservable.bindActivity(android.app.Activity, rx.Observable) instead
static rx.Observable<android.content.Intent>	fromBroadcast(android.content.Context context, android.content.IntentFilter filter) Create Observable that wraps BroadcastReceiver and emmit received intents.
static rx.Observable<android.content.Intent>	fromBroadcast(android.content.Context context, android.content.IntentFilter filter, java.lang.String broadcastPermission, android.os.Handler schedulerHandler) Create Observable that wraps BroadcastReceiver and emmit received intents.
static <T> rx.Observable<T>	fromFragment(java.lang.Object fragment, rx.Observable<T> sourceObservable) Deprecated. Use AndroidObservable.bindFragment(Object, rx.Observable) instead
static rx.Observable<android.content.Intent>	fromLocalBroadcast(android.content.Context context, android.content.IntentFilter filter) Create Observable that wraps BroadcastReceiver and connects to LocalBroadcastManager to emmit received intents.

Methods inherited from class java.lang.Object

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

Method Detail

fromActivity

@Deprecated
public static <T> rx.Observable<T> fromActivity(android.app.Activity activity,
                                           rx.Observable<T> sourceObservable)

Deprecated. Use AndroidObservable.bindActivity(android.app.Activity, rx.Observable) instead

Transforms a source observable to be attached to the given Activity, in such a way that notifications will always arrive on the main UI thread. Currently, this is equivalent to calling observeOn(AndroidSchedulers.mainThread()), but this behavior may change in the future, so it is encouraged to use this wrapper instead.

You must unsubscribe from the returned observable in onDestroy to not leak the given Activity.

Ex.:

     // in any Activity
     mSubscription = fromActivity(this, Observable.just("value")).subscribe(...);
     // in onDestroy
     mSubscription.unsubscribe();
 

Type Parameters:

T -

Parameters:

activity - the activity in which the source observable will be observed

sourceObservable - the observable sequence to observe from the given Activity

Returns:

a new observable sequence that will emit notifications on the main UI thread

fromFragment

@Deprecated
public static <T> rx.Observable<T> fromFragment(java.lang.Object fragment,
                                           rx.Observable<T> sourceObservable)

Deprecated. Use AndroidObservable.bindFragment(Object, rx.Observable) instead

Transforms a source observable to be attached to the given fragment, in such a way that notifications will always arrive on the main UI thread. Moreover, it will be guaranteed that no notifications will be delivered to the fragment while it's in detached state (i.e. its host Activity was destroyed.) In other words, during calls to onNext, you may assume that fragment.getActivity() will never return null.

This method accepts both native fragments and support library fragments in its first parameter. It will throw for unsupported types.

You must unsubscribe from the returned observable in onDestroy to not leak the given fragment.

Ex.:

     // in any Fragment
     mSubscription = fromFragment(this, Observable.just("value")).subscribe(...);
     // in onDestroy
     mSubscription.unsubscribe();
 

Type Parameters:

T -

Parameters:

fragment - the fragment in which the source observable will be observed

sourceObservable - the observable sequence to observe from the given fragment

Returns:

a new observable sequence that will emit notifications on the main UI thread

bindActivity

public static <T> rx.Observable<T> bindActivity(android.app.Activity activity,
                                rx.Observable<T> source)

Binds the given source sequence to an activity.

This helper will schedule the given sequence to be observed on the main UI thread and ensure that no notifications will be forwarded to the activity in case it is scheduled to finish.

You should unsubscribe from the returned Observable in onDestroy at the latest, in order to not leak the activity or an inner subscriber. Conversely, when the source sequence can outlive the activity, make sure to bind to new instances of the activity again, e.g. after going through configuration changes. Refer to the samples project for actual examples.

Parameters:

activity - the activity to bind the source sequence to

source - the source sequence

bindFragment

public static <T> rx.Observable<T> bindFragment(java.lang.Object fragment,
                                rx.Observable<T> source)

Binds the given source sequence to a fragment (native or support-v4).

This helper will schedule the given sequence to be observed on the main UI thread and ensure that no notifications will be forwarded to the fragment in case it gets detached from its activity or the activity is scheduled to finish.

You should unsubscribe from the returned Observable in onDestroy for normal fragments, or in onDestroyView for retained fragments, in order to not leak any references to the host activity or the fragment. Refer to the samples project for actual examples.

Parameters:

fragment - the fragment to bind the source sequence to

source - the source sequence

fromBroadcast

public static rx.Observable<android.content.Intent> fromBroadcast(android.content.Context context,
                                                  android.content.IntentFilter filter)

Create Observable that wraps BroadcastReceiver and emmit received intents.

Parameters:

filter - Selects the Intent broadcasts to be received.

fromBroadcast

public static rx.Observable<android.content.Intent> fromBroadcast(android.content.Context context,
                                                  android.content.IntentFilter filter,
                                                  java.lang.String broadcastPermission,
                                                  android.os.Handler schedulerHandler)

Create Observable that wraps BroadcastReceiver and emmit received intents.

Parameters:

filter - Selects the Intent broadcasts to be received.

broadcastPermission - String naming a permissions that a broadcaster must hold in order to send an Intent to you. If null, no permission is required.

schedulerHandler - Handler identifying the thread that will receive the Intent. If null, the main thread of the process will be used.

fromLocalBroadcast

public static rx.Observable<android.content.Intent> fromLocalBroadcast(android.content.Context context,
                                                       android.content.IntentFilter filter)

Create Observable that wraps BroadcastReceiver and connects to LocalBroadcastManager to emmit received intents.

Parameters:

filter - Selects the Intent broadcasts to be received.