to top
Android APIs
public static class

SipProfile.Builder

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

Class Overview

Helper class for creating a SipProfile.

Summary

Public Constructors

? Examples 		SipProfile.Builder( SipProfile profile)
Creates a builder based on the given profile.

? Examples 		SipProfile.Builder( String uriString)
Constructor.

? Examples 		SipProfile.Builder( String username, String serverDomain)
Constructor.
Public Methods

? Examples 		SipProfile build()
Builds and returns the SIP profile object.

? Examples 		SipProfile.Builder setAuthUserName( String name)
Sets the username used for authentication.

? Examples 		SipProfile.Builder setAutoRegistration(boolean flag)
Sets the auto.

? Examples 		SipProfile.Builder setDisplayName( String displayName)
Sets the display name of the user.

? Examples 		SipProfile.Builder setOutboundProxy( String outboundProxy)
Sets the outbound proxy of the SIP server.

? Examples 		SipProfile.Builder setPassword( String password)
Sets the password of the SIP account

? Examples 		SipProfile.Builder setPort(int port)
Sets the port number of the server.

? Examples 		SipProfile.Builder setProfileName( String name)
Sets the name of the profile.

? Examples 		SipProfile.Builder setProtocol( String protocol)
Sets the protocol used to connect to the SIP server.

? Examples 		SipProfile.Builder setSendKeepAlive(boolean flag)
Sets the send keep-alive flag.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public SipProfile.Builder (SipProfile profile)

Added in API level 9

Creates a builder based on the given profile.

public SipProfile.Builder (String uriString)

Added in API level 9

Constructor.

Parameters
uriString the URI string as "sip: @ "
Throws
ParseException if the string is not a valid URI

public SipProfile.Builder (String username, String serverDomain)

Added in API level 9

Constructor.

Parameters
username username of the SIP account
serverDomain the SIP server domain; if the network address is different from the domain, use setOutboundProxy(String) to set server address
Throws
ParseException if the parameters are not valid

Public Methods

public SipProfile build ()

Added in API level 9

Builds and returns the SIP profile object.

Returns
  • the profile object created

public SipProfile.Builder setAuthUserName (String name)

Added in API level 12

Sets the username used for authentication.

Parameters
name authentication username of the profile
Returns
  • this builder object

public SipProfile.Builder setAutoRegistration (boolean flag)

Added in API level 9

Sets the auto. registration flag.

Parameters
flag true if the profile will be registered automatically, false otherwise
Returns
  • this builder object

public SipProfile.Builder setDisplayName (String displayName)

Added in API level 9

Sets the display name of the user.

Parameters
displayName display name of the user
Returns
  • this builder object

public SipProfile.Builder setOutboundProxy (String outboundProxy)

Added in API level 9

Sets the outbound proxy of the SIP server.

Parameters
outboundProxy the network address of the outbound proxy
Returns
  • this builder object

public SipProfile.Builder setPassword (String password)

Added in API level 9

Sets the password of the SIP account

Parameters
password password of the SIP account
Returns
  • this builder object

public SipProfile.Builder setPort (int port)

Added in API level 9

Sets the port number of the server. By default, it is 5060.

Parameters
port port number of the server
Returns
  • this builder object
Throws
IllegalArgumentException if the port number is out of range

public SipProfile.Builder setProfileName (String name)

Added in API level 9

Sets the name of the profile. This name is given by user.

Parameters
name name of the profile
Returns
  • this builder object

public SipProfile.Builder setProtocol (String protocol)

Added in API level 9

Sets the protocol used to connect to the SIP server. Currently, only "UDP" and "TCP" are supported.

Parameters
protocol the protocol string
Returns
  • this builder object
Throws
IllegalArgumentException if the protocol is not recognized

public SipProfile.Builder setSendKeepAlive (boolean flag)

Added in API level 9

Sets the send keep-alive flag.

Parameters
flag true if sending keep-alive message is required, false otherwise
Returns
  • this builder object
No examples for this method.
Frequently called with: [Clear]
Portions of this page are reproduced from work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. The original page is available here.