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 getLocalProfile()
and getPeerProfile()
.
For more information about using SIP, read the Session Initiation Protocol developer guide.
Nested classes |
|
---|---|
class |
SipProfile.Builder Helper class for creating a |
Inherited constants |
---|
![]() android.os.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 |
writeToParcel(Parcel out, int flags) Flatten this object in to a Parcel. |
Inherited methods |
|
---|---|
![]() java.lang.Object
|
|
![]() android.os.Parcelable
|
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. |
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:
boolean getAutoRegistration ()
Gets the flag of 'Auto Registration'.
Returns | |
---|---|
boolean |
the flag of registering the profile automatically. |
String getDisplayName ()
Gets the display name of the user.
Returns | |
---|---|
String |
the display name of the user |
String getPassword ()
Gets the password.
Returns | |
---|---|
String |
the password |
int getPort ()
Gets the port number of the SIP server.
Returns | |
---|---|
int |
the port number of the SIP server |
String getProfileName ()
Gets the (user-defined) name of the profile.
Returns | |
---|---|
String |
name of the profile |
String getProtocol ()
Gets the protocol used to connect to the server.
Returns | |
---|---|
String |
the protocol |
String getProxyAddress ()
Gets the network address of the server outbound proxy.
Returns | |
---|---|
String |
the network address of the server outbound proxy |
boolean getSendKeepAlive ()
Gets the flag of 'Sending keep-alive'.
Returns | |
---|---|
boolean |
the flag of sending SIP keep-alive messages. |
String getSipDomain ()
Gets the SIP domain.
Returns | |
---|---|
String |
the SIP domain |
String getUriString ()
Gets the SIP URI string of this profile.
Returns | |
---|---|
String |
the SIP URI string of this profile |
String getUserName ()
Gets the username.
Returns | |
---|---|
String |
the username |
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_WRITE_RETURN_VALUE . |