lightbulb_outline Please take our October 2018 developer survey. Start survey

SipProfile

public class SipProfile
extends Object implements Parcelable, Serializable, Cloneable

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


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

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 writeToParcel(Parcel out, int flags)

Flatten this object in to a Parcel.

Inherited methods

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

getAuthUserName

added in API level 12
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:

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

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.

flags int: Additional flags about how the object should be written. May be 0 or Parcelable.PARCELABLE_WRITE_RETURN_VALUE.