Android APIs
public class

ServiceState

extends Object
implements Parcelable
java.lang.Object
   ↳ android.telephony.ServiceState

Class Overview

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
  • Roaming indicator
  • Operator name, short name and numeric id
  • Network selection mode

Summary

Constants
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.
[Expand]
Inherited Constants
From interface android.os.Parcelable
Fields
public static final Creator<ServiceState> CREATOR
Public Constructors
ServiceState()
Empty constructor
ServiceState(ServiceState s)
Copy constructors
ServiceState(Parcel in)
Construct a ServiceState object from the given parcel.
Public Methods
int describeContents()
Describe the kinds of special objects contained in this Parcelable's marshalled representation.
boolean equals(Object o)
Compares this instance with the specified object and indicates if they are equal.
boolean getIsManualSelection()
Get current network selection mode.
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 (note: not just decoding from TS 27.007 7.2)
int getState()
Get current voice service state
int hashCode()
Returns an integer hash code for this object.
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 containing a concise, human-readable description of this object.
void writeToParcel(Parcel out, int flags)
Flatten this object in to a Parcel.
Protected Methods
void copyFrom(ServiceState s)
[Expand]
Inherited Methods
From class java.lang.Object
From interface android.os.Parcelable

Constants

public static final int STATE_EMERGENCY_ONLY

Added in API level 1

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

Constant Value: 2 (0x00000002)

public static final int STATE_IN_SERVICE

Added in API level 1

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

Constant Value: 0 (0x00000000)

public static final int STATE_OUT_OF_SERVICE

Added in API level 1

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)

public static final int STATE_POWER_OFF

Added in API level 1

Radio of telephony is explicitly powered off.

Constant Value: 3 (0x00000003)

Fields

public static final Creator<ServiceState> CREATOR

Added in API level 1

Public Constructors

public ServiceState ()

Added in API level 1

Empty constructor

public ServiceState (ServiceState s)

Added in API level 1

Copy constructors

Parameters
s ServiceState: Source service state

public ServiceState (Parcel in)

Added in API level 1

Construct a ServiceState object from the given parcel.

Parameters
in Parcel

Public Methods

public int describeContents ()

Added in API level 1

Describe the kinds of special objects contained in this Parcelable's marshalled representation.

Returns
int a bitmask indicating the set of special object types marshalled by the Parcelable.

public boolean equals (Object o)

Added in API level 1

Compares this instance with the specified object and indicates if they are equal. In order to be equal, o must represent the same object as this instance using a class-specific comparison. The general contract is that this comparison should be reflexive, symmetric, and transitive. Also, no object reference other than null is equal to null.

The default implementation returns true only if this == o. See Writing a correct equals method if you intend implementing your own equals method.

The general contract for the equals and hashCode() methods is that if equals returns true for any two objects, then hashCode() must return the same value for these objects. This means that subclasses of Object usually override either both methods or neither of them.

Parameters
o Object: the object to compare this instance with.
Returns
boolean true if the specified object is equal to this Object; false otherwise.

public boolean getIsManualSelection ()

Added in API level 1

Get current network selection mode.

Returns
boolean true if manual mode, false if automatic mode

public String getOperatorAlphaLong ()

Added in API level 1

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.

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

public String getOperatorAlphaShort ()

Added in API level 1

Get current registered operator name in short alphanumeric format. In GSM/UMTS, short format can be up to 8 characters long.

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

public String getOperatorNumeric ()

Added in API level 1

Get current registered operator numeric id. In GSM/UMTS, numeric format is 3 digit country code plus 2 or 3 digit network code.

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

public boolean getRoaming ()

Added in API level 1

Get current roaming indicator of phone (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

public int getState ()

Added in API level 1

Get current voice service state

Returns
int

public int hashCode ()

Added in API level 1

Returns an integer hash code for this object. By contract, any two objects for which equals(Object) returns true must return the same hash code value. This means that subclasses of Object usually override both methods or neither method.

Note that hash values must not change over time unless information used in equals comparisons also changes.

See Writing a correct hashCode method if you intend implementing your own hashCode method.

Returns
int this object's hash code.

public void setIsManualSelection (boolean isManual)

Added in API level 1

Parameters
isManual boolean

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

Added in API level 1

Parameters
longName String
shortName String
numeric String

public void setRoaming (boolean roaming)

Added in API level 1

Parameters
roaming boolean

public void setState (int state)

Added in API level 1

Parameters
state int

public void setStateOff ()

Added in API level 1

public void setStateOutOfService ()

Added in API level 1

public String toString ()

Added in API level 1

Returns a string containing a concise, human-readable description of this object. Subclasses are encouraged to override this method and provide an implementation that takes into account the object's type and data. The default implementation is equivalent to the following expression:

   getClass().getName() + '@' + Integer.toHexString(hashCode())

See Writing a useful toString method if you intend implementing your own toString method.

Returns
String a printable representation of this object.

public void writeToParcel (Parcel out, int flags)

Added in API level 1

Flatten this object in to a Parcel.

Parameters
out Parcel: The Parcel in which the object should be written.
flags int: Additional flags about how the object should be written. May be 0 or PARCELABLE_WRITE_RETURN_VALUE.

Protected Methods

protected void copyFrom (ServiceState s)

Added in API level 1

Parameters
s ServiceState