Added in API level 34

Summary: Constants | Inherited Constants | Fields | Methods | Inherited Methods

SipDetails

Kotlin |Java

public final class SipDetails
extends Object implements Parcelable

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

Contains the information for SIP.

Summary

Constants
`int`	`METHOD_PUBLISH` Indicates information related to the SIP publication method.
`int`	`METHOD_REGISTER` Indicates information related to the SIP registration method.
`int`	`METHOD_SUBSCRIBE` Indicates information related to the SIP subscription method.
`int`	`METHOD_UNKNOWN`

Inherited constants

From interface android.os.Parcelable

`int`	`CONTENTS_FILE_DESCRIPTOR` Descriptor bit used with `describeContents()`: indicates that the Parcelable object's flattened representation includes a file descriptor.
`int`	`PARCELABLE_WRITE_RETURN_VALUE` Flag for use with `writeToParcel(Parcel, int)`: the object being written is a return value, that is the result of a function such as "`Parcelable someFunction()`", "`void someFunction(out Parcelable)`", or "`void someFunction(inout Parcelable)`".

Fields
`public static final Creator<SipDetails>`	`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`	`getCSeq()` Get the value of CSeq header field.
`String`	`getCallId()` Get the value of the Call-ID header field for this SIP method.
`int`	`getMethod()` Get the method type of this instance.
`int`	`getReasonHeaderCause()` Get the "cause" parameter of the "reason" header.
`String`	`getReasonHeaderText()` Get the "text" parameter of the "reason" header in the SIP message.
`int`	`getResponseCode()` Get the value of response code from the SIP response.
`String`	`getResponsePhrase()` Get the value of reason from the SIP response.
`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

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

From interface


        
          android.os.Parcelable

`abstract int`	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
`abstract void`	`writeToParcel(Parcel dest, int flags)` Flatten this object in to a Parcel.

Constants

METHOD_PUBLISH

Added in API level 34

public static final int METHOD_PUBLISH

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

Constant Value: 2 (0x00000002)

METHOD_REGISTER

Added in API level 34

public static final int METHOD_REGISTER

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

Constant Value: 1 (0x00000001)

METHOD_SUBSCRIBE

Added in API level 34

public static final int METHOD_SUBSCRIBE

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

Constant Value: 3 (0x00000003)

METHOD_UNKNOWN

Added in API level 34

public static final int METHOD_UNKNOWN

Constant Value: 0 (0x00000000)

Fields

CREATOR

Added in API level 34

public static final Creator<SipDetails> CREATOR

Public methods

describeContents

Added in API level 34

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 34

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.

getCSeq

Added in API level 34

public int getCSeq ()

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

Returns
`int`	The command sequence value associated with this SIP information.

getCallId

Added in API level 34

public String getCallId ()

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

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

public int getMethod ()

Get the method type of this instance.

Returns
`int`	The method type associated with this SIP information. Value is `METHOD_UNKNOWN`, `METHOD_REGISTER`, `METHOD_PUBLISH`, or `METHOD_SUBSCRIBE`

getReasonHeaderCause

Added in API level 34

public int getReasonHeaderCause ()

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

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

public String getReasonHeaderText ()

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

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

public int getResponseCode ()

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

Returns
`int`	The SIP response code associated with this SIP information.

getResponsePhrase

Added in API level 34

public String getResponsePhrase ()

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.

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

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 34

public String toString ()

Returns a string representation of the object.

Returns
`String`	a string representation of the object.

writeToParcel

Added in API level 34

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