Added in API level 1

Summary: Constants | Inherited Constants | Fields | Ctors | Methods | Protected Methods | Inherited Methods

ServiceState

---

Kotlin |Java

public class ServiceState
extends Object implements Parcelable

java.lang.Object
↳	android.telephony.ServiceState

---

Contains phone state and service related information. The following phone information is included in returned ServiceState:

• Service state: IN_SERVICE, OUT_OF_SERVICE, EMERGENCY_ONLY, POWER_OFF
• Duplex mode: UNKNOWN, FDD, TDD
• Roaming indicator
• Operator name, short name and numeric id
• Network selection mode

For historical reasons this class is not declared as final; however, it should be treated as though it were final.

Summary

Constants
int	DUPLEX_MODE_FDD Duplex mode for the phone is frequency-division duplexing.
int	DUPLEX_MODE_TDD Duplex mode for the phone is time-division duplexing.
int	DUPLEX_MODE_UNKNOWN Duplex mode for the phone is unknown.
int	STATE_EMERGENCY_ONLY The phone is registered and locked. Only emergency numbers are allowed.
int	STATE_IN_SERVICE Normal operation condition, the phone is registered with an operator either in home network or in roaming.
int	STATE_OUT_OF_SERVICE Phone is not registered with any operator, the phone can be currently searching a new operator to register to, or not searching to registration at all, or registration is denied, or radio signal is not available.
int	STATE_POWER_OFF Radio of telephony is explicitly powered off.
int	UNKNOWN_ID Unknown ID.

Inherited constants

From interface android.os.Parcelable int CONTENTS_FILE_DESCRIPTOR Descriptor bit used with describeContents(): indicates that the Parcelable object's flattened representation includes a file descriptor. int PARCELABLE_WRITE_RETURN_VALUE Flag for use with writeToParcel(Parcel, int): the object being written is a return value, that is the result of a function such as "Parcelable someFunction()", "void someFunction(out Parcelable)", or "void someFunction(inout Parcelable)".

Fields
public static final Creator<ServiceState>	CREATOR

Public constructors
ServiceState() Empty constructor
ServiceState(ServiceState s) Copy constructors
ServiceState(Parcel in) This constructor is deprecated. The constructor takes parcel should not be public at the beginning. Use ServiceState() instead.

Public methods
int	describeContents() Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
boolean	equals(Object o) Indicates whether some other object is "equal to" this one.
int	getCdmaNetworkId() Get the CDMA NID (Network Identification Number), a number uniquely identifying a network within a wireless system.
int	getCdmaSystemId() Get the CDMA SID (System Identification Number), a number uniquely identifying a wireless system.
int[]	getCellBandwidths() Get an array of cell bandwidths (kHz) for the current serving cells
int	getChannelNumber() Get the channel number of the current primary serving cell, or -1 if unknown This is NRARFCN for NR, EARFCN for LTE, UARFCN for UMTS, and ARFCN for GSM.
int	getDuplexMode() Get the current duplex mode
boolean	getIsManualSelection() Get current network selection mode.
List<NetworkRegistrationInfo>	getNetworkRegistrationInfoList() Get all of the available network registration info.
String	getOperatorAlphaLong() Get current registered operator name in long alphanumeric format.
String	getOperatorAlphaShort() Get current registered operator name in short alphanumeric format.
String	getOperatorNumeric() Get current registered operator numeric id.
boolean	getRoaming() Get current roaming indicator of phone.
int	getState() Get current voice service state
int	hashCode() Returns a hash code value for the object.
boolean	isSearching() This indicates whether the device is searching for service.
boolean	isUsingNonTerrestrialNetwork() Get whether device is connected to a non-terrestrial network.
void	setIsManualSelection(boolean isManual)
void	setOperatorName(String longName, String shortName, String numeric)
void	setRoaming(boolean roaming)
void	setState(int state)
void	setStateOff()
void	setStateOutOfService()
String	toString() Returns a string representation of the object.
void	writeToParcel(Parcel out, int flags) Flatten this object in to a Parcel.

Protected methods
void	copyFrom(ServiceState s)

Inherited methods
From class java.lang.Object Object clone() Creates and returns a copy of this object. boolean equals(Object obj) Indicates whether some other object is "equal to" this one. void finalize() Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. final Class<?> getClass() Returns the runtime class of this Object. int hashCode() Returns a hash code value for the object. final void notify() Wakes up a single thread that is waiting on this object's monitor. final void notifyAll() Wakes up all threads that are waiting on this object's monitor. String toString() Returns a string representation of the object. final void wait(long timeoutMillis, int nanos) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. final void wait(long timeoutMillis) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. final void wait() Causes the current thread to wait until it is awakened, typically by being notified or interrupted.
From interface android.os.Parcelable abstract int describeContents() Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. abstract void writeToParcel(Parcel dest, int flags) Flatten this object in to a Parcel.

Constants

DUPLEX_MODE_FDD

Added in API level 28

public static final int DUPLEX_MODE_FDD

Duplex mode for the phone is frequency-division duplexing.

Constant Value: 1 (0x00000001)

DUPLEX_MODE_TDD

Added in API level 28

public static final int DUPLEX_MODE_TDD

Duplex mode for the phone is time-division duplexing.

Constant Value: 2 (0x00000002)

DUPLEX_MODE_UNKNOWN

Added in API level 28

public static final int DUPLEX_MODE_UNKNOWN

Duplex mode for the phone is unknown.

Constant Value: 0 (0x00000000)

STATE_EMERGENCY_ONLY

Added in API level 1

public static final int STATE_EMERGENCY_ONLY

The phone is registered and locked. Only emergency numbers are allowed.

Constant Value: 2 (0x00000002)

STATE_IN_SERVICE

Added in API level 1

public static final int STATE_IN_SERVICE

Normal operation condition, the phone is registered with an operator either in home network or in roaming.

Constant Value: 0 (0x00000000)

STATE_OUT_OF_SERVICE

Added in API level 1

public static final int STATE_OUT_OF_SERVICE

Phone is not registered with any operator, the phone can be currently searching a new operator to register to, or not searching to registration at all, or registration is denied, or radio signal is not available.

Constant Value: 1 (0x00000001)

STATE_POWER_OFF

Added in API level 1

public static final int STATE_POWER_OFF

Radio of telephony is explicitly powered off.

Constant Value: 3 (0x00000003)

UNKNOWN_ID

Added in API level 28

public static final int UNKNOWN_ID

Unknown ID. Could be returned by getCdmaNetworkId() or getCdmaSystemId()

Constant Value: -1 (0xffffffff)

Fields

CREATOR

Added in API level 1

public static final Creator<ServiceState> CREATOR

Public constructors

ServiceState

Added in API level 1

public ServiceState ()

Empty constructor

ServiceState

Added in API level 1

public ServiceState (ServiceState s)

Copy constructors

Parameters
s	ServiceState: Source service state

ServiceState

Added in API level 1

public ServiceState (Parcel in)

This constructor is deprecated.
The constructor takes parcel should not be public at the beginning. Use ServiceState() instead.

Construct a ServiceState object from the given parcel.

Parameters
in	Parcel

Public methods

describeContents

Added in API level 1

public int describeContents ()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of writeToParcel(android.os.Parcel, int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

Returns
int	a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or CONTENTS_FILE_DESCRIPTOR

equals

Added in API level 1

public boolean equals (Object o)

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

• It is reflexive: for any non-null reference value x, x.equals(x) should return true.
• It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
• It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
• It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
• For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
o	Object: the reference object with which to compare.

Returns
boolean	true if this object is the same as the obj argument; false otherwise.

getCdmaNetworkId

Added in API level 28

public int getCdmaNetworkId ()

Get the CDMA NID (Network Identification Number), a number uniquely identifying a network within a wireless system. (Defined in 3GPP2 C.S0023 3.4.8)

Require at least Manifest.permission.ACCESS_FINE_LOCATION or Manifest.permission.ACCESS_COARSE_LOCATION. Otherwise return UNKNOWN_ID.
Requires Manifest.permission.ACCESS_FINE_LOCATION or Manifest.permission.ACCESS_COARSE_LOCATION

Returns
int	The CDMA NID or UNKNOWN_ID if not available.

getCdmaSystemId

Added in API level 28

public int getCdmaSystemId ()

Get the CDMA SID (System Identification Number), a number uniquely identifying a wireless system. (Defined in 3GPP2 C.S0023 3.4.8)

Require at least Manifest.permission.ACCESS_FINE_LOCATION or Manifest.permission.ACCESS_COARSE_LOCATION. Otherwise return UNKNOWN_ID.
Requires Manifest.permission.ACCESS_FINE_LOCATION or Manifest.permission.ACCESS_COARSE_LOCATION

Returns
int	The CDMA SID or UNKNOWN_ID if not available.

getCellBandwidths

Added in API level 28

public int[] getCellBandwidths ()

Get an array of cell bandwidths (kHz) for the current serving cells

Returns
int[]	Current serving cell bandwidths

getChannelNumber

Added in API level 28

public int getChannelNumber ()

Get the channel number of the current primary serving cell, or -1 if unknown

This is NRARFCN for NR, EARFCN for LTE, UARFCN for UMTS, and ARFCN for GSM.

Returns
int	Channel number of primary serving cell

getDuplexMode

Added in API level 28

public int getDuplexMode ()

Get the current duplex mode

Returns
int	Current DuplexMode for the phone Value is DUPLEX_MODE_UNKNOWN, DUPLEX_MODE_FDD, or DUPLEX_MODE_TDD

See also:

• DUPLEX_MODE_UNKNOWN
• DUPLEX_MODE_FDD
• DUPLEX_MODE_TDD

getIsManualSelection

Added in API level 1

public boolean getIsManualSelection ()

Get current network selection mode.

Returns
boolean	true if manual mode, false if automatic mode

getNetworkRegistrationInfoList

Added in API level 30

public List<NetworkRegistrationInfo> getNetworkRegistrationInfoList ()

Get all of the available network registration info.

Returns
List<NetworkRegistrationInfo>	List of NetworkRegistrationInfo This value cannot be null.

getOperatorAlphaLong

Added in API level 1

public String getOperatorAlphaLong ()

Get current registered operator name in long alphanumeric format. In GSM/UMTS, long format can be up to 16 characters long. In CDMA, returns the ERI text, if set. Otherwise, returns the ONS. Require at least Manifest.permission.ACCESS_FINE_LOCATION or Manifest.permission.ACCESS_COARSE_LOCATION. Otherwise return null if the caller does not hold neither Manifest.permission.ACCESS_FINE_LOCATION nor Manifest.permission.ACCESS_COARSE_LOCATION.
Requires Manifest.permission.ACCESS_FINE_LOCATION or Manifest.permission.ACCESS_COARSE_LOCATION

Returns
String	long name of operator, null if unregistered or unknown

getOperatorAlphaShort

Added in API level 1

public String getOperatorAlphaShort ()

Get current registered operator name in short alphanumeric format. In GSM/UMTS, short format can be up to 8 characters long. Require at least Manifest.permission.ACCESS_FINE_LOCATION or Manifest.permission.ACCESS_COARSE_LOCATION. Otherwise return null if the caller does not hold neither Manifest.permission.ACCESS_FINE_LOCATION nor Manifest.permission.ACCESS_COARSE_LOCATION.
Requires Manifest.permission.ACCESS_FINE_LOCATION or Manifest.permission.ACCESS_COARSE_LOCATION

Returns
String	short name of operator, null if unregistered or unknown

getOperatorNumeric

Added in API level 1

public String getOperatorNumeric ()

Get current registered operator numeric id. In GSM/UMTS, numeric format is 3 digit country code plus 2 or 3 digit network code. Require at least Manifest.permission.ACCESS_FINE_LOCATION or Manifest.permission.ACCESS_COARSE_LOCATION. Otherwise return null if the caller does not hold neither Manifest.permission.ACCESS_FINE_LOCATION nor Manifest.permission.ACCESS_COARSE_LOCATION.
Requires Manifest.permission.ACCESS_FINE_LOCATION or Manifest.permission.ACCESS_COARSE_LOCATION

Returns
String	numeric format of operator, null if unregistered or unknown

getRoaming

Added in API level 1

public boolean getRoaming ()

Get current roaming indicator of phone. This roaming state could be overridden by the carrier config. (note: not just decoding from TS 27.007 7.2)

Returns
boolean	true if TS 27.007 7.2 roaming is true and ONS is different from SPN

See also:

• for visualization purpose.
• CarrierConfigManager.KEY_FORCE_HOME_NETWORK_BOOL
• CarrierConfigManager.KEY_GSM_ROAMING_NETWORKS_STRING_ARRAY
• CarrierConfigManager.KEY_GSM_NONROAMING_NETWORKS_STRING_ARRAY
• CarrierConfigManager.KEY_CDMA_ROAMING_NETWORKS_STRING_ARRAY
• CarrierConfigManager.KEY_CDMA_NONROAMING_NETWORKS_STRING_ARRAY

getState

Added in API level 1

public int getState ()

Get current voice service state

Returns
int

hashCode

Added in API level 1

public int hashCode ()

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by HashMap.

The general contract of hashCode is:

• Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
• If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
• It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns
int	a hash code value for this object.

isSearching

Added in API level 30

public boolean isSearching ()

This indicates whether the device is searching for service. This API reports the modem searching status for AccessNetworkConstants#TRANSPORT_TYPE_WWAN (cellular) service in either NetworkRegistrationInfo#DOMAIN_CS or NetworkRegistrationInfo#DOMAIN_PS. This API will not report searching status for AccessNetworkConstants#TRANSPORT_TYPE_WLAN.

Returns
boolean	true whenever the modem is searching for service.

isUsingNonTerrestrialNetwork

Added in API level 35

public boolean isUsingNonTerrestrialNetwork ()

Get whether device is connected to a non-terrestrial network.

Returns
boolean	true if device is connected to a non-terrestrial network else false.

setIsManualSelection

Added in API level 1

public void setIsManualSelection (boolean isManual)

Parameters
isManual	boolean

setOperatorName

Added in API level 1

public void setOperatorName (String longName, 
                String shortName, 
                String numeric)

Parameters
longName	String
shortName	String
numeric	String

setRoaming

Added in API level 1

public void setRoaming (boolean roaming)

Parameters
roaming	boolean

setState

Added in API level 1

public void setState (int state)

Parameters
state	int

setStateOff

Added in API level 1

public void setStateOff ()

setStateOutOfService

Added in API level 1

public void setStateOutOfService ()

toString

Added in API level 1

public String toString ()

Returns a string representation of the object.

Returns
String	a string representation of the object.

writeToParcel

Added in API level 1

public void writeToParcel (Parcel out, 
                int flags)

Flatten this object in to a Parcel.

Parameters
out	Parcel: The Parcel in which the object should be written. This value cannot be null.
flags	int: Additional flags about how the object should be written. May be 0 or Parcelable.PARCELABLE_WRITE_RETURN_VALUE. Value is either 0 or a combination of Parcelable.PARCELABLE_WRITE_RETURN_VALUE, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES

Protected methods

copyFrom

Added in API level 1

protected void copyFrom (ServiceState s)

Parameters
s	ServiceState