AvailableNetworkInfo

public final class AvailableNetworkInfo
extends Object implements Parcelable

java.lang.Object
   ↳ android.telephony.AvailableNetworkInfo


Defines available network information which includes corresponding subscription id, network plmns and corresponding priority to be used for network selection by Opportunistic Network Service when passed through TelephonyManager#updateAvailableNetworks

Summary

Nested classes

class AvailableNetworkInfo.Builder

Provides a convenient way to set the fields of a AvailableNetworkInfo when creating a new instance. 

Constants

int PRIORITY_HIGH

int PRIORITY_LOW

int PRIORITY_MED

Inherited constants

Fields

public static final Creator<AvailableNetworkInfo> CREATOR

Public constructors

AvailableNetworkInfo(int subId, int priority, List<String> mccMncs, List<Integer> bands)

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.

List<Integer> getBands()

Returns the frequency bands that need to be scanned by opportunistic network service The returned value is defined in either of AccessNetworkConstants.GeranBand, AccessNetworkConstants.UtranBand and AccessNetworkConstants.EutranBand See AccessNetworkConstants.AccessNetworkType for details regarding different network types.

List<String> getMccMncs()

Return List of PLMN ids (MCC-MNC) associated with the sub ID.

int getPriority()

Return priority for the subscription id.

List<RadioAccessSpecifier> getRadioAccessSpecifiers()

Returns a list of RadioAccessSpecifier associated with the available network.

int getSubId()

Return subscription Id of the available network.

int hashCode()

Returns a hash code value for the object.

String toString()

Returns a string representation of the object.

void writeToParcel(Parcel dest, int flags)

Flatten this object in to a Parcel.

Inherited methods

Constants

PRIORITY_HIGH

Added in API level 29
public static final int PRIORITY_HIGH

Constant Value: 1 (0x00000001)

PRIORITY_LOW

Added in API level 29
public static final int PRIORITY_LOW

Constant Value: 3 (0x00000003)

PRIORITY_MED

Added in API level 29
public static final int PRIORITY_MED

Constant Value: 2 (0x00000002)

Fields

CREATOR

Added in API level 29
public static final Creator<AvailableNetworkInfo> CREATOR

Public constructors

AvailableNetworkInfo

Added in API level 29
public AvailableNetworkInfo (int subId, 
                int priority, 
                List<String> mccMncs, 
                List<Integer> bands)

Parameters
subId int

priority int

mccMncs List: This value cannot be null.

bands List: This value cannot be null.

Public methods

describeContents

Added in API level 29
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 29
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.

getBands

Added in API level 29
public List<Integer> getBands ()

Returns the frequency bands that need to be scanned by opportunistic network service The returned value is defined in either of AccessNetworkConstants.GeranBand, AccessNetworkConstants.UtranBand and AccessNetworkConstants.EutranBand See AccessNetworkConstants.AccessNetworkType for details regarding different network types. When no specific bands are specified (empty array or null) CBRS band AccessNetworkConstants.EutranBand#BAND_48 will be used for network scan.

Returns
List<Integer>

getMccMncs

Added in API level 29
public List<String> getMccMncs ()

Return List of PLMN ids (MCC-MNC) associated with the sub ID. Opportunistic Network Service will scan and verify specified PLMNs are available. If this entry is left empty, then the Opportunistic Network Service will not scan the network to validate the network availability.

Returns
List<String> list of PLMN ids This value cannot be null.

getPriority

Added in API level 29
public int getPriority ()

Return priority for the subscription id. Priorities are in the range of AvailableNetworkInfo#PRIORITY_LOW to AvailableNetworkInfo#PRIORITY_HIGH Among all networks available after network scan, subId with highest priority is chosen for network selection. If there are more than one subId with highest priority then the network with highest RSRP is chosen.

Returns
int priority level Value is PRIORITY_HIGH, PRIORITY_MED, or PRIORITY_LOW

getRadioAccessSpecifiers

Added in API level 33
public List<RadioAccessSpecifier> getRadioAccessSpecifiers ()

Returns a list of RadioAccessSpecifier associated with the available network. Opportunistic network service will use this to determine which bands to scan for.

Returns
List<RadioAccessSpecifier> the access network type associated with the available network. This value cannot be null.

getSubId

Added in API level 29
public int getSubId ()

Return subscription Id of the available network. This value must be one of the entry retrieved from SubscriptionManager#getOpportunisticSubscriptions

Returns
int subscription id

hashCode

Added in API level 29
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.

toString

Added in API level 29
public String toString ()

Returns a string representation of the object.

Returns
String a string representation of the object.

writeToParcel

Added in API level 29
public void writeToParcel (Parcel dest, 
                int flags)

Flatten this object in to a Parcel.

Parameters
dest 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