Android - An Open Handset Alliance Project

android.telephony
public class

android.telephony.DataStateIntentReceiver

java.lang.Object
	android.content.IntentReceiver
		android.telephony.DataStateIntentReceiver

A IntentReceiver implementation that provides data connection state over phone.

There are two Intents you can register and listen for: the data connection state, and data activity state. For each of these intents you have to register with corresponding notify function before calling corresponding get function to access values. You can use unregisterIntent and registerIntent to stop and resume listening.

Summary

Public Constructors

					DataStateIntentReceiver()
					default constructor
					DataStateIntentReceiver(Context context, Handler target)
					Commonly use constructor

Public Methods

				DataActivityState	getActivityState()
					getActivityState
				DataState	getConnectionState()
					getConnectionState
				boolean	getNotifyActivityState()
					Check if registere for data activity state notification
				boolean	getNotifyConnectionState()
					Check if registere for data connection state notification
				void	notifyActivity(int eventWhat)
					Call this if you want to be notified of data activity states.
				void	notifyConnectionState(int eventWhat)
					Call this if you want to be notified of data connection states.
				void	onReceiveIntent(Context context, Intent intent)
					This method is called when the IntentReceiver is receiving an Intent broadcast.
				void	registerIntent()
					Register to be run in caller thread with intent filter
				void	setContext(Context c)
					Set the application environment of caller
				void	setTarget(Handler h)
					Set the message post and callback handler provided by caller
				void	unregisterIntent()
					Unregister from caller thread

Methods inherited from class android.content.IntentReceiver

abortBroadcast, clearAbortBroadcast, getAbortBroadcast, getDebugUnregister, getResultCode, getResultData, getResultExtras, onReceiveIntent, setDebugUnregister, setResult, setResultCode, setResultData, setResultExtras

	final	void	abortBroadcast()
			Sets the flag indicating that this receiver should abort the current broadcast.
	final	void	clearAbortBroadcast()
			Clears the flag indicating that this receiver should abort the current broadcast.
	final	boolean	getAbortBroadcast()
			Returns the flag indicating whether or not this receiver should abort the current broadcast.
	final	boolean	getDebugUnregister()
			Return the last value given to setDebugUnregister(boolean).
	final	int	getResultCode()
			Retrieve the current result code, as set by the previous receiver.
	final	String	getResultData()
			Retrieve the current result data, as set by the previous receiver.
	final	Bundle	getResultExtras(boolean makeMap)
			Retrieve the current result extra data, as set by the previous receiver.
abstract		void	onReceiveIntent(Context context, Intent intent)
			This method is called when the IntentReceiver is receiving an Intent broadcast.
	final	void	setDebugUnregister(boolean debug)
			Control inclusion of debugging help for mismatched calls to {@ Context#registerReceiver(IntentReceiver, IntentFilter) Context.registerReceiver()}.
	final	void	setResult(int code, String data, Bundle extras)
	final	void	setResultCode(int code)
			Change the current result code of this broadcast.
	final	void	setResultData(String data)
			Change the current result data of this broadcast.
	final	void	setResultExtras(Bundle extras)
			Change the current result extras of this broadcast.

Methods inherited from class java.lang.Object

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

	Object	clone()
		Answers a new instance of the same class as the receiver, whose slots have been filled in with the values in the slots of the receiver.
	boolean	equals(Object o)
		Compares the argument to the receiver, and answers true if they represent the same object using a class specific comparison.
	void	finalize()
		Called by the virtual machine when there are no longer any (non-weak) references to the receiver.
final	Class	getClass()
		Answers the unique instance of java.lang.Class which represents the class of the receiver.
	int	hashCode()
		Answers an integer hash code for the receiver.
final	void	notify()
		Causes one thread which is `wait` ing on the receiver to be made ready to run.
final	void	notifyAll()
		Causes all threads which are `wait` ing on the receiver to be made ready to run.
	String	toString()
		Answers a string containing a concise, human-readable description of the receiver.
final	void	wait(long time, int frac)
		Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by `notify` or `notifyAll`) or the expiration of the timeout.
final	void	wait(long time)
		Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by `notify` or `notifyAll`) or the expiration of the timeout.
final	void	wait()
		Causes the thread which sent this message to be made not ready to run pending some change in the receiver (as indicated by `notify` or `notifyAll`).

Details

Public Constructors

public DataStateIntentReceiver()

default constructor

public DataStateIntentReceiver(Context context, Handler target)

Commonly use constructor

Parameters

context	the application environment of caller
target	the message post and callback handler provided by caller

Public Methods

public DataActivityState getActivityState()

getActivityState

Returns

Phone.DataActivityState enum. throws RuntimeException if client has not called notifyActivity(int)

public DataState getConnectionState()

getConnectionState

Returns

Phone.DataState enum. throws RuntimeException if client has not called notifyConnectionState(int)

public boolean getNotifyActivityState()

Check if registere for data activity state notification

Returns

true for registered

public boolean getNotifyConnectionState()

Check if registere for data connection state notification

Returns

true for registered

public void notifyActivity(int eventWhat)

Call this if you want to be notified of data activity states.

Parameters

eventWhat	the callback event what code.

public void notifyConnectionState(int eventWhat)

Call this if you want to be notified of data connection states.

Parameters

eventWhat	the callback event what code.

public void onReceiveIntent(Context context, Intent intent)

This method is called when the IntentReceiver is receiving an Intent broadcast. During this time you can use the other methods on IntentReceiver to view/modify the current result values. The function is normally called from the main thread of its process, so you should never perform long-running operations in it (there is a timeout of 10 seconds that the system allows before considering the receiver to be blocked and a candidate to be killed). You cannot launch a popup dialog in your implementation of onReceiveIntent().

If this IntentReceiver was launched through a <receiver> tag, then the object is no longer alive after returning from this function. This means you should not perform any operations that return a result to you asynchronously -- in particular, for interacting with services, you should use startService(Intent, Bundle) instead of bindService(Intent, ServiceConnection, int).

Parameters

context	The Context in which the receiver is running.
intent	The Intent being received.

public void registerIntent()

public void setContext(Context c)

Set the application environment of caller

Parameters

c	the application environment of caller

public void setTarget(Handler h)

Set the message post and callback handler provided by caller

Parameters

h	the message post and callback handler provided by caller

public void unregisterIntent()

Unregister from caller thread

Android - An Open Handset Alliance Project

Documentation

Goodies

android.telephony.DataStateIntentReceiver

Summary

Public Constructors

Public Methods

Methods inherited from class android.content.IntentReceiver

Methods inherited from class java.lang.Object

Details

Public Constructors

public DataStateIntentReceiver()

public DataStateIntentReceiver(Context context, Handler target)

Parameters

Public Methods

public DataActivityState getActivityState()

Returns

public DataState getConnectionState()

Returns

public boolean getNotifyActivityState()

Returns

public boolean getNotifyConnectionState()

Returns

public void notifyActivity(int eventWhat)

Parameters

public void notifyConnectionState(int eventWhat)

Parameters

public void onReceiveIntent(Context context, Intent intent)

Parameters

public void registerIntent()

public void setContext(Context c)

Parameters

public void setTarget(Handler h)

Parameters

public void unregisterIntent()


e.g. "intent" or "activity"