Android - An Open Handset Alliance Project

android.telephony
public final class

android.telephony.PhoneStateIntentReceiver

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

A IntentReceiver implementation that provides phone state and operation information.

There are five Intents you can register and listen for: the service state, phone call state, signal strength, message waiting indicator, and call forwarding indicator. 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

Constants

		Value
String	INTENT_KEY_ASU	"asu"
String	INTENT_KEY_CFI	"cfi"
String	INTENT_KEY_MWI	"mwi"

Public Constructors

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

Public Methods

				boolean	getCallForwardingIndicator()
					Return current call forwarding indicator state.
				boolean	getMessageWaitingIndicator()
					Return current message waiting indicator state.
				boolean	getNotifyCallForwardingIndicator()
					Check if registere for call forwarding notification
				boolean	getNotifyMessageWaitingIndicator()
					Check if registere for message waiting notification
				boolean	getNotifyPhoneCallState()
					Check if registere for phone call state notification
				boolean	getNotifyServiceState()
					Check if registere for service state notification
				boolean	getNotifySignalStrength()
					Check if registere for signal strength notification
				State	getPhoneState()
					Returns current phone state
				ServiceState	getServiceState()
					Returns current service state
				int	getSignalStrength()
					Returns current signal strength in "asu", ranging from 0-31 or -1 if unknown For GSM, dBm = -113 + 2*asu 0 means "-113 dBm or less" 31 means "-51 dBm or greater"
				int	getSignalStrengthDbm()
					Return current signal strength in "dBm", ranging from -113 - -51dBm or -1 if unknown
				void	notifyCallForwardingIndicator(int eventWhat)
					Call this if you want to be notified of call forwarding states.
				void	notifyMessageWaitingIndicator(int eventWhat)
					Call this if you want to be notified of message waiting states.
				void	notifyPhoneCallState(int eventWhat)
					Call this if you want to be notified of phone call states.
				void	notifyServiceState(int eventWhat)
					Call this if you want to be notified of phone service states.
				void	notifySignalStrength(int eventWhat)
					Call this if you want to be notified of radio signal strength.
				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

Constants

public static final String INTENT_KEY_ASU

Constant Value: "asu"

public static final String INTENT_KEY_CFI

Constant Value: "cfi"

public static final String INTENT_KEY_MWI

Constant Value: "mwi"

Public Constructors

public PhoneStateIntentReceiver()

default constructor

public PhoneStateIntentReceiver(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 boolean getCallForwardingIndicator()

Return current call forwarding indicator state.

Returns

true if there are call forwarding. Throws RuntimeException if client has not called notifyCallForwardingIndicator()

public boolean getMessageWaitingIndicator()

Return current message waiting indicator state.

Returns

true if there are messages waiting. Throws RuntimeException if client has not called notifyMessageWaitingIndicator()

public boolean getNotifyCallForwardingIndicator()

Check if registere for call forwarding notification

Returns

true for registered

public boolean getNotifyMessageWaitingIndicator()

Check if registere for message waiting notification

Returns

true for registered

public boolean getNotifyPhoneCallState()

Check if registere for phone call state notification

Returns

true for registered

public boolean getNotifyServiceState()

Check if registere for service state notification

Returns

true for registered

public boolean getNotifySignalStrength()

Check if registere for signal strength notification

Returns

true for registered

public State getPhoneState()

Returns current phone state

Returns

Phone.State enum. Phone.IDLE if not yet updated. Throws RuntimeException if client has not called notifyPhoneCallState()

public ServiceState getServiceState()

Returns current service state

Returns

ServiceState object, "out of service" info if not yet updated. Throws RuntimeException if client has not called notifyServiceState()

public int getSignalStrength()

Returns current signal strength in "asu", ranging from 0-31 or -1 if unknown For GSM, dBm = -113 + 2*asu 0 means "-113 dBm or less" 31 means "-51 dBm or greater"

Returns

signal strength in asu, -1 if not yet updated Throws RuntimeException if client has not called notifySignalStrength()

public int getSignalStrengthDbm()

Return current signal strength in "dBm", ranging from -113 - -51dBm or -1 if unknown

Returns

signal strength in dBm, -1 if not yet updated Throws RuntimeException if client has not called notifySignalStrength()

public void notifyCallForwardingIndicator(int eventWhat)

Call this if you want to be notified of call forwarding states.

Parameters

eventWhat	the callback event what code.

public void notifyMessageWaitingIndicator(int eventWhat)

Call this if you want to be notified of message waiting states.

Parameters

eventWhat	the callback event what code.

public void notifyPhoneCallState(int eventWhat)

Call this if you want to be notified of phone call states.

Parameters

eventWhat	the callback event what code.

public void notifyServiceState(int eventWhat)

Call this if you want to be notified of phone service states.

Parameters

eventWhat	the callback event what code.

public void notifySignalStrength(int eventWhat)

Call this if you want to be notified of radio signal strength.

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


e.g. "intent" or "activity"

Android - An Open Handset Alliance Project

Documentation

Goodies

android.telephony.PhoneStateIntentReceiver

Summary

Constants

Public Constructors

Public Methods

Methods inherited from class android.content.IntentReceiver

Methods inherited from class java.lang.Object

Details

Constants

public static final String INTENT_KEY_ASU

public static final String INTENT_KEY_CFI

public static final String INTENT_KEY_MWI

Public Constructors

public PhoneStateIntentReceiver()

public PhoneStateIntentReceiver(Context context, Handler target)

Parameters

Public Methods

public boolean getCallForwardingIndicator()

Returns

public boolean getMessageWaitingIndicator()

Returns

public boolean getNotifyCallForwardingIndicator()

Returns

public boolean getNotifyMessageWaitingIndicator()

Returns

public boolean getNotifyPhoneCallState()

Returns

public boolean getNotifyServiceState()

Returns

public boolean getNotifySignalStrength()

Returns

public State getPhoneState()

Returns

public ServiceState getServiceState()

Returns

public int getSignalStrength()

Returns

public int getSignalStrengthDbm()

Returns

public void notifyCallForwardingIndicator(int eventWhat)

Parameters

public void notifyMessageWaitingIndicator(int eventWhat)

Parameters

public void notifyPhoneCallState(int eventWhat)

Parameters

public void notifyServiceState(int eventWhat)

Parameters

public void notifySignalStrength(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()