Added in API level 31

ImsRegistrationAttributes


class ImsRegistrationAttributes : Parcelable
kotlin.Any
   ↳ android.telephony.ims.ImsRegistrationAttributes

Contains the attributes associated with the current IMS registration.

Summary

Constants
static Int

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

static Int

Attribute to specify if ims registration is of type normal or emergency.

static Int

Attribute to specify if virtual registration is required.

Inherited constants
Public methods
Int

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

Boolean
equals(other: Any?)

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

Int

MutableSet<String!>

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

Boolean

Get the attribute flag ATTR_REGISTRATION_TYPE_EMERGENCY.

Boolean

Get the attribute flag ATTR_VIRTUAL_FOR_ANONYMOUS_EMERGENCY_CALL.

String?

SipDetails?

Int

Int

Returns a hash code value for the object.

String

Returns a string representation of the object.

Unit
writeToParcel(dest: Parcel, flags: Int)

Flatten this object in to a Parcel.

Properties
static Parcelable.Creator<ImsRegistrationAttributes!>

Constants

ATTR_EPDG_OVER_CELL_INTERNET

Added in API level 31
static val ATTR_EPDG_OVER_CELL_INTERNET: Int

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.

Value: 1

ATTR_REGISTRATION_TYPE_EMERGENCY

static val ATTR_REGISTRATION_TYPE_EMERGENCY: Int

Attribute to specify if ims registration is of type normal or emergency.

For emergency registration bit will be set. For normal registration bit will not be set. This flag is only applicable when listening to emergency IMS registration state updates via the ImsMmTelManager#registerImsEmergencyRegistrationCallback API

Value: 2

ATTR_VIRTUAL_FOR_ANONYMOUS_EMERGENCY_CALL

static val ATTR_VIRTUAL_FOR_ANONYMOUS_EMERGENCY_CALL: Int

Attribute to specify if virtual registration is required.

If emergency registration is not required for making emergency call, in such cases bit will be set and callback will represent virtual registration status update. This flag is only applicable when listening to emergency IMS registration state updates via the ImsMmTelManager#registerImsEmergencyRegistrationCallback API

Value: 4

Public methods

describeContents

Added in API level 31
fun describeContents(): Int

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.

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

equals

Added in API level 31
fun equals(other: Any?): Boolean

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
obj the reference object with which to compare.
Return
Boolean true if this object is the same as the obj argument; false otherwise.

getAttributeFlags

Added in API level 31
fun getAttributeFlags(): Int
Return
Int A bit-mask containing attributes associated with the IMS registration.
Value is either 0 or a combination of the following:

getFeatureTags

Added in API level 31
fun getFeatureTags(): MutableSet<String!>

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}.

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

getFlagRegistrationTypeEmergency

fun getFlagRegistrationTypeEmergency(): Boolean

Get the attribute flag ATTR_REGISTRATION_TYPE_EMERGENCY.

Return
Boolean true if the ATTR_REGISTRATION_TYPE_EMERGENCY attribute has been set, or false if it has not been set.

getFlagVirtualRegistrationForEmergencyCall

fun getFlagVirtualRegistrationForEmergencyCall(): Boolean

Get the attribute flag ATTR_VIRTUAL_FOR_ANONYMOUS_EMERGENCY_CALL.

Return
Boolean true if the ATTR_VIRTUAL_FOR_ANONYMOUS_EMERGENCY_CALL attribute has been set, or false if it has not been set.

getPcscfAddress

Added in API level 31
fun getPcscfAddress(): String?
Return
String? The current Proxy-CSCF(P-CSCF) address which UE registers with based on the registration procedure in 3GPP TS 24.229; otherwise, null if the address is not set.

getSipDetails

Added in API level 34
fun getSipDetails(): SipDetails?
Return
SipDetails? The SIP information associated with the IMS registration.
This value may be null.

getTransportType

Added in API level 31
fun getTransportType(): Int
Return
Int The access network transport type that IMS has been registered over.
Value is one of the following:

hashCode

Added in API level 31
fun hashCode(): Int

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.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.
Return
Int a hash code value for this object.

toString

Added in API level 31
fun toString(): String

Returns a string representation of the object.

Return
String a string representation of the object.

writeToParcel

Added in API level 31
fun writeToParcel(
    dest: Parcel,
    flags: Int
): Unit

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_WRITE_RETURN_VALUE.
Value is either 0 or a combination of the following:

Properties

CREATOR

Added in API level 31
static val CREATOR: Parcelable.Creator<ImsRegistrationAttributes!>