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

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

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

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

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

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 one of the following:

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

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 34
fun toString(): String

Returns a string representation of the object.

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 the following:

Properties

CREATOR

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