Android APIs
public class

SipProfile

extends Object
implements Parcelable Serializable Cloneable
java.lang.Object
   ↳ android.net.sip.SipProfile

Class Overview

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 getLocalProfile() and 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
[Expand]
Inherited Constants
From interface android.os.Parcelable
Fields
public static final Creator<SipProfile> CREATOR
Public Methods
int describeContents()
Describe the kinds of special objects contained in this Parcelable's marshalled 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 writeToParcel(Parcel out, int flags)
Flatten this object in to a Parcel.
[Expand]
Inherited Methods
From class java.lang.Object
From interface android.os.Parcelable

Fields

public static final Creator<SipProfile> CREATOR

Added in API level 9

Public Methods

public int describeContents ()

Added in API level 9

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

Returns
int a bitmask indicating the set of special object types marshalled by the Parcelable.

public String getAuthUserName ()

Added in API level 12

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

Returns
String the authentication username

See also:

public boolean getAutoRegistration ()

Added in API level 9

Gets the flag of 'Auto Registration'.

Returns
boolean the flag of registering the profile automatically.

public String getDisplayName ()

Added in API level 9

Gets the display name of the user.

Returns
String the display name of the user

public String getPassword ()

Added in API level 9

Gets the password.

Returns
String the password

public int getPort ()

Added in API level 9

Gets the port number of the SIP server.

Returns
int the port number of the SIP server

public String getProfileName ()

Added in API level 9

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

Returns
String name of the profile

public String getProtocol ()

Added in API level 9

Gets the protocol used to connect to the server.

Returns
String the protocol

public String getProxyAddress ()

Added in API level 9

Gets the network address of the server outbound proxy.

Returns
String the network address of the server outbound proxy

public boolean getSendKeepAlive ()

Added in API level 9

Gets the flag of 'Sending keep-alive'.

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

public String getSipDomain ()

Added in API level 9

Gets the SIP domain.

Returns
String the SIP domain

public String getUriString ()

Added in API level 9

Gets the SIP URI string of this profile.

Returns
String the SIP URI string of this profile

public String getUserName ()

Added in API level 9

Gets the username.

Returns
String the username

public void writeToParcel (Parcel out, int flags)

Added in API level 9

Flatten this object in to a Parcel.

Parameters
out Parcel: The Parcel in which the object should be written.
flags int: Additional flags about how the object should be written. May be 0 or PARCELABLE_WRITE_RETURN_VALUE.