Added in API level 34

SipDetails

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

Contains the information for SIP.

Summary

Constants
static Int

Indicates information related to the SIP publication method.
static Int

Indicates information related to the SIP registration method.
static Int

Indicates information related to the SIP subscription method.
static Int

Inherited constants
Public methods
Int

Boolean
equals(other: Any?)
Int

Get the value of CSeq header field.
String?

Get the value of the Call-ID header field for this SIP method.
Int

Get the method type of this instance.
Int

Get the "cause" parameter of the "reason" header.
String

Get the "text" parameter of the "reason" header in the SIP message.
Int

Get the value of response code from the SIP response.
String

Get the value of reason from the SIP response.
Int

String

Unit
writeToParcel(dest: Parcel, flags: Int)

Flatten this object in to a Parcel.
Properties
static Parcelable.Creator<SipDetails!>

Constants

METHOD_PUBLISH

Added in API level 34
static val METHOD_PUBLISH: Int

Indicates information related to the SIP publication method. See RFC 3903 for details.

Value: 2

METHOD_REGISTER

Added in API level 34
static val METHOD_REGISTER: Int

Indicates information related to the SIP registration method. See RFC 3261 for details.

Value: 1

METHOD_SUBSCRIBE

Added in API level 34
static val METHOD_SUBSCRIBE: Int

Indicates information related to the SIP subscription method. See RFC 3856 for details.

Value: 3

METHOD_UNKNOWN

Added in API level 34
static val METHOD_UNKNOWN: Int
Value: 0

Public methods

describeContents

Added in API level 34
fun describeContents(): Int
Return
Int a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or android.os.Parcelable#CONTENTS_FILE_DESCRIPTOR

equals

Added in API level 34
fun equals(other: Any?): Boolean
Parameters
obj the reference object with which to compare.
Return
Boolean true if this object is the same as the obj argument; false otherwise.

getCSeq

Added in API level 34
fun getCSeq(): Int

Get the value of CSeq header field. The CSeq header field serves as a way to identify and order transactions.

Return
Int The command sequence value associated with this SIP information.

getCallId

Added in API level 34
fun getCallId(): String?

Get the value of the Call-ID header field for this SIP method.

Return
String? The Call-ID value associated with this SIP information. If the Call-ID value is not set when ImsService notifies the framework, this value will be null.

getMethod

Added in API level 34
fun getMethod(): Int

Get the method type of this instance.

Return
Int The method type associated with this SIP information. Value is android.telephony.ims.SipDetails#METHOD_UNKNOWN, android.telephony.ims.SipDetails#METHOD_REGISTER, android.telephony.ims.SipDetails#METHOD_PUBLISH, or android.telephony.ims.SipDetails#METHOD_SUBSCRIBE

getReasonHeaderCause

Added in API level 34
fun getReasonHeaderCause(): Int

Get the "cause" parameter of the "reason" header.

Return
Int The "cause" parameter of the reason header. If the SIP message from the network does not have a reason header, it should be 0.

getReasonHeaderText

Added in API level 34
fun getReasonHeaderText(): String

Get the "text" parameter of the "reason" header in the SIP message.

Return
String The "text" parameter of the reason header. If the SIP message from the network does not have a reason header, it can be empty. This value cannot be null.

getResponseCode

Added in API level 34
fun getResponseCode(): Int

Get the value of response code from the SIP response. The SIP response code sent from the network for the operation token specified.

Return
Int The SIP response code associated with this SIP information.

getResponsePhrase

Added in API level 34
fun getResponsePhrase(): String

Get the value of reason from the SIP response. The optional reason response from the network. If there is a reason header included in the response, that should take precedence over the reason provided in the status line.

Return
String The optional reason response associated with this SIP information. If the network provided no reason with the SIP code, the string should be empty. This value cannot be null.

hashCode

Added in API level 34
fun hashCode(): Int
Return
Int a hash code value for this object.

toString

Added in API level 34
fun toString(): String
Return
String a string representation of the object.

writeToParcel

Added in API level 34
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 android.os.Parcelable#PARCELABLE_WRITE_RETURN_VALUE, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES

Properties

CREATOR

Added in API level 34
static val CREATOR: Parcelable.Creator<SipDetails!>