ImsRegistrationAttributes

public final class ImsRegistrationAttributes
extends Object implements Parcelable

java.lang.Object
   ↳ android.telephony.ims.ImsRegistrationAttributes


Contains the attributes associated with the current IMS registration.

Summary

Constants

int ATTR_EPDG_OVER_CELL_INTERNET

Attribute to specify if an EPDG tunnel is setup over the cellular internet APN.

Inherited constants

Fields

public static final Creator<ImsRegistrationAttributes> CREATOR

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 getAttributeFlags()
Set<String> getFeatureTags()

Gets the Set of feature tags associated with the current IMS registration, if the IMS service supports supplying this information.

SipDetails getSipDetails()
int getTransportType()
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

ATTR_EPDG_OVER_CELL_INTERNET

Added in API level 31
public static final int ATTR_EPDG_OVER_CELL_INTERNET

Attribute to specify if an EPDG tunnel is setup over the cellular internet APN.

If IMS is registered through an EPDG tunnel is setup over the cellular internet APN then this bit will be set. If IMS is registered through the IMS APN, then this bit will not be set.

Constant Value: 1 (0x00000001)

Fields

CREATOR

Added in API level 31
public static final Creator<ImsRegistrationAttributes> CREATOR

Public methods

describeContents

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

getAttributeFlags

Added in API level 31
public int getAttributeFlags ()

Returns
int A bit-mask containing attributes associated with the IMS registration. Value is either 0 or a combination of ATTR_EPDG_OVER_CELL_INTERNET, android.telephony.ims.ImsRegistrationAttributes.ATTR_REGISTRATION_TYPE_EMERGENCY, and android.telephony.ims.ImsRegistrationAttributes.ATTR_VIRTUAL_FOR_ANONYMOUS_EMERGENCY_CALL

getFeatureTags

Added in API level 31
public Set<String> getFeatureTags ()

Gets the Set of feature tags associated with the current IMS registration, if the IMS service supports supplying this information.

The format of the set of feature tags will be one feature tag key and value per entry and will potentially contain MMTEL and RCS feature tags, depending the configuration of the IMS service associated with the registration indications. Each feature tag will contain the feature tag name and string value (if applicable), even if they have the same feature tag name. For example, +g.3gpp.icsi-ref="urn%3Aurn-7%3A3gpp-service.ims.icsi.oma.cpm.msg, urn%3Aurn-7%3A3gpp-service.ims.icsi.oma.cpm.session", +g.gsma.callcomposer will be split into three feature tag entries: {+g.3gpp.icsi-ref="urn%3Aurn-7%3A3gpp-service.ims.icsi.oma.cpm.msg", +g.3gpp.icsi-ref="urn%3Aurn-7%3A3gpp-service.ims.icsi.oma.cpm.session", +g.gsma.callcomposer}.

Returns
Set<String> The Set of feature tags associated with the current IMS registration. This value cannot be null.

getSipDetails

Added in API level 34
public SipDetails getSipDetails ()

Returns
SipDetails The SIP information associated with the IMS registration. This value may be null.

getTransportType

Added in API level 31
public int getTransportType ()

Returns
int The access network transport type that IMS has been registered over. Value is android.telephony.AccessNetworkConstants.TRANSPORT_TYPE_INVALID, AccessNetworkConstants.TRANSPORT_TYPE_WWAN, or AccessNetworkConstants.TRANSPORT_TYPE_WLAN

hashCode

Added in API level 31
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 31
public String toString ()

Returns a string representation of the object.

Returns
String a string representation of the object.

writeToParcel

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

Flatten this object in to a Parcel.

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