Added in API level 9
Deprecated in API level 31

Summary: Nested Classes | Inherited Constants | Fields | Methods | Inherited Methods

SipProfile

---

Kotlin |Java

public class SipProfile
extends Object implements Parcelable, Serializable, Cloneable

java.lang.Object
↳	android.net.sip.SipProfile

---

This class was deprecated in API level 31.
SipManager and associated classes are no longer supported and should not be used as the basis of future VOIP apps.

Defines a SIP profile, including a SIP account, domain and server information.

You can create a SipProfile using SipProfile.Builder. You can also retrieve one from a SipSession, using SipSession.getLocalProfile() and SipSession#getPeerProfile.

Developer Guides

For more information about using SIP, read the Session Initiation Protocol developer guide.

Summary

Nested classes
class	SipProfile.Builder Helper class for creating a SipProfile.

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

Public methods
int	describeContents() Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
String	getAuthUserName() Gets the username for authentication.
boolean	getAutoRegistration() Gets the flag of 'Auto Registration'.
String	getDisplayName() Gets the display name of the user.
String	getPassword() Gets the password.
int	getPort() Gets the port number of the SIP server.
String	getProfileName() Gets the (user-defined) name of the profile.
String	getProtocol() Gets the protocol used to connect to the server.
String	getProxyAddress() Gets the network address of the server outbound proxy.
boolean	getSendKeepAlive() Gets the flag of 'Sending keep-alive'.
String	getSipDomain() Gets the SIP domain.
String	getUriString() Gets the SIP URI string of this profile.
String	getUserName() Gets the username.
void	setCallingUid(int uid) Sets the calling process's Uid in the sip service.
void	writeToParcel(Parcel out, 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.

Fields

CREATOR

Added in API level 9

public static final Creator<SipProfile> CREATOR

Public methods

describeContents

Added in API level 9

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

getAuthUserName

Added in API level 12
Deprecated in API level 31

public String getAuthUserName ()

Gets the username for authentication. If it is null, then the username is used in authentication instead.

Returns
String	the authentication username

See also:

• getUserName()

getAutoRegistration

Added in API level 9

public boolean getAutoRegistration ()

Gets the flag of 'Auto Registration'.

Returns
boolean	the flag of registering the profile automatically.

getDisplayName

Added in API level 9

public String getDisplayName ()

Gets the display name of the user.

Returns
String	the display name of the user

getPassword

Added in API level 9

public String getPassword ()

Gets the password.

Returns
String	the password

getPort

Added in API level 9

public int getPort ()

Gets the port number of the SIP server.

Returns
int	the port number of the SIP server

getProfileName

Added in API level 9

public String getProfileName ()

Gets the (user-defined) name of the profile.

Returns
String	name of the profile

getProtocol

Added in API level 9

public String getProtocol ()

Gets the protocol used to connect to the server.

Returns
String	the protocol

getProxyAddress

Added in API level 9

public String getProxyAddress ()

Gets the network address of the server outbound proxy.

Returns
String	the network address of the server outbound proxy

getSendKeepAlive

Added in API level 9

public boolean getSendKeepAlive ()

Gets the flag of 'Sending keep-alive'.

Returns
boolean	the flag of sending SIP keep-alive messages.

getSipDomain

Added in API level 9

public String getSipDomain ()

Gets the SIP domain.

Returns
String	the SIP domain

getUriString

Added in API level 9

public String getUriString ()

Gets the SIP URI string of this profile.

Returns
String	the SIP URI string of this profile

getUserName

Added in API level 9

public String getUserName ()

Gets the username.

Returns
String	the username

setCallingUid

Added in API level 30
Deprecated in API level 31

public void setCallingUid (int uid)

Sets the calling process's Uid in the sip service.

Parameters
uid	int

writeToParcel

Added in API level 9

public void writeToParcel (Parcel out, 
                int flags)

Flatten this object in to a Parcel.

Parameters
out	Parcel: The Parcel in which the object should be written. 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