# SipProfile.Builder Added in[API level 9](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) Deprecated in[API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) Summary:[Ctors](https://developer.android.com/reference/android/net/sip/SipProfile.Builder#pubctors)\|[Methods](https://developer.android.com/reference/android/net/sip/SipProfile.Builder#pubmethods)\|[Inherited Methods](https://developer.android.com/reference/android/net/sip/SipProfile.Builder#inhmethods) # SipProfile.Builder *** ** * ** *** [Kotlin](https://developer.android.com/reference/kotlin/android/net/sip/SipProfile.Builder "View this page in Kotlin")\|Java ` public static class SipProfile.Builder ` ` extends `[Object](https://developer.android.com/reference/java/lang/Object)` `` ` |---|------------------------------------| | [java.lang.Object](https://developer.android.com/reference/java/lang/Object) || | ↳ | android.net.sip.SipProfile.Builder |
*** ** * ** *** Helper class for creating a[SipProfile](https://developer.android.com/reference/android/net/sip/SipProfile). ## Summary | ### Public constructors || |--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---| | ` `[Builder](https://developer.android.com/reference/android/net/sip/SipProfile.Builder#Builder(android.net.sip.SipProfile))`(`[SipProfile](https://developer.android.com/reference/android/net/sip/SipProfile)` profile) ` Creates a builder based on the given profile. | | ` `[Builder](https://developer.android.com/reference/android/net/sip/SipProfile.Builder#Builder(java.lang.String))`(`[String](https://developer.android.com/reference/java/lang/String)` uriString) ` Constructor. | | ` `[Builder](https://developer.android.com/reference/android/net/sip/SipProfile.Builder#Builder(java.lang.String,%20java.lang.String))`(`[String](https://developer.android.com/reference/java/lang/String)` username, `[String](https://developer.android.com/reference/java/lang/String)` serverDomain) ` Constructor. | | ### Public methods || |-----------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ` `[SipProfile](https://developer.android.com/reference/android/net/sip/SipProfile) | ` `[build](https://developer.android.com/reference/android/net/sip/SipProfile.Builder#build())`() ` Builds and returns the SIP profile object. | | ` `[SipProfile.Builder](https://developer.android.com/reference/android/net/sip/SipProfile.Builder) | ` `[setAuthUserName](https://developer.android.com/reference/android/net/sip/SipProfile.Builder#setAuthUserName(java.lang.String))`(`[String](https://developer.android.com/reference/java/lang/String)` name) ` Sets the username used for authentication. | | ` `[SipProfile.Builder](https://developer.android.com/reference/android/net/sip/SipProfile.Builder) | ` `[setAutoRegistration](https://developer.android.com/reference/android/net/sip/SipProfile.Builder#setAutoRegistration(boolean))`(boolean flag) ` Sets the auto. | | ` `[SipProfile.Builder](https://developer.android.com/reference/android/net/sip/SipProfile.Builder) | ` `[setDisplayName](https://developer.android.com/reference/android/net/sip/SipProfile.Builder#setDisplayName(java.lang.String))`(`[String](https://developer.android.com/reference/java/lang/String)` displayName) ` Sets the display name of the user. | | ` `[SipProfile.Builder](https://developer.android.com/reference/android/net/sip/SipProfile.Builder) | ` `[setOutboundProxy](https://developer.android.com/reference/android/net/sip/SipProfile.Builder#setOutboundProxy(java.lang.String))`(`[String](https://developer.android.com/reference/java/lang/String)` outboundProxy) ` Sets the outbound proxy of the SIP server. | | ` `[SipProfile.Builder](https://developer.android.com/reference/android/net/sip/SipProfile.Builder) | ` `[setPassword](https://developer.android.com/reference/android/net/sip/SipProfile.Builder#setPassword(java.lang.String))`(`[String](https://developer.android.com/reference/java/lang/String)` password) ` Sets the password of the SIP account | | ` `[SipProfile.Builder](https://developer.android.com/reference/android/net/sip/SipProfile.Builder) | ` `[setPort](https://developer.android.com/reference/android/net/sip/SipProfile.Builder#setPort(int))`(int port) ` Sets the port number of the server. | | ` `[SipProfile.Builder](https://developer.android.com/reference/android/net/sip/SipProfile.Builder) | ` `[setProfileName](https://developer.android.com/reference/android/net/sip/SipProfile.Builder#setProfileName(java.lang.String))`(`[String](https://developer.android.com/reference/java/lang/String)` name) ` Sets the name of the profile. | | ` `[SipProfile.Builder](https://developer.android.com/reference/android/net/sip/SipProfile.Builder) | ` `[setProtocol](https://developer.android.com/reference/android/net/sip/SipProfile.Builder#setProtocol(java.lang.String))`(`[String](https://developer.android.com/reference/java/lang/String)` protocol) ` Sets the protocol used to connect to the SIP server. | | ` `[SipProfile.Builder](https://developer.android.com/reference/android/net/sip/SipProfile.Builder) | ` `[setSendKeepAlive](https://developer.android.com/reference/android/net/sip/SipProfile.Builder#setSendKeepAlive(boolean))`(boolean flag) ` Sets the send keep-alive flag. | | ### Inherited methods | |-----------------------|---| | From class` `[java.lang.Object](https://developer.android.com/reference/java/lang/Object)` ` |--------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ` `[Object](https://developer.android.com/reference/java/lang/Object) | ` `[clone](https://developer.android.com/reference/java/lang/Object#clone())`() ` Creates and returns a copy of this object. | | ` boolean` | ` `[equals](https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object))`(`[Object](https://developer.android.com/reference/java/lang/Object)` obj) ` Indicates whether some other object is "equal to" this one. | | ` void` | ` `[finalize](https://developer.android.com/reference/java/lang/Object#finalize())`() ` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. | | ` final `[Class](https://developer.android.com/reference/java/lang/Class)`` | ` `[getClass](https://developer.android.com/reference/java/lang/Object#getClass())`() ` Returns the runtime class of this`Object`. | | ` int` | ` `[hashCode](https://developer.android.com/reference/java/lang/Object#hashCode())`() ` Returns a hash code value for the object. | | ` final void` | ` `[notify](https://developer.android.com/reference/java/lang/Object#notify())`() ` Wakes up a single thread that is waiting on this object's monitor. | | ` final void` | ` `[notifyAll](https://developer.android.com/reference/java/lang/Object#notifyAll())`() ` Wakes up all threads that are waiting on this object's monitor. | | ` `[String](https://developer.android.com/reference/java/lang/String) | ` `[toString](https://developer.android.com/reference/java/lang/Object#toString())`() ` Returns a string representation of the object. | | ` final void` | ` `[wait](https://developer.android.com/reference/java/lang/Object#wait(long,%20int))`(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](https://developer.android.com/reference/java/lang/Object#wait(long))`(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](https://developer.android.com/reference/java/lang/Object#wait())`() ` Causes the current thread to wait until it is awakened, typically by being*notified* or*interrupted*. | || ## Public constructors ### Builder Added in[API level 9](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public Builder (SipProfile profile) ``` Creates a builder based on the given profile.
| Parameters || |-----------|---------------------| | `profile` | `SipProfile`
| ### Builder Added in[API level 9](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public Builder (String uriString) ``` Constructor.
| Parameters || |-------------|--------------------------------------------| | `uriString` | `String`: the URI string as "sip:@"
| | Throws || |------------------------------------------------------------------------------------|----------------------------------| | [ParseException](https://developer.android.com/reference/java/text/ParseException) | if the string is not a valid URI | ### Builder Added in[API level 9](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public Builder (String username, String serverDomain) ``` Constructor.
| Parameters || |----------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `username` | `String`: username of the SIP account
| | `serverDomain` | `String`: the SIP server domain; if the network address is different from the domain, use[setOutboundProxy(String)](https://developer.android.com/reference/android/net/sip/SipProfile.Builder#setOutboundProxy(java.lang.String))to set server address
| | Throws || |------------------------------------------------------------------------------------|---------------------------------| | [ParseException](https://developer.android.com/reference/java/text/ParseException) | if the parameters are not valid | ## Public methods ### build Added in[API level 9](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public SipProfile build () ``` Builds and returns the SIP profile object.
| Returns || |----------------------------------------------------------------------------------|-----------------------------------| | [SipProfile](https://developer.android.com/reference/android/net/sip/SipProfile) | the profile object created
| ### setAuthUserName Added in[API level 12](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) Deprecated in[API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public SipProfile.Builder setAuthUserName (String name) ``` Sets the username used for authentication.
| Parameters || |--------|---------------------------------------------------------| | `name` | `String`: authentication username of the profile
| | Returns || |--------------------------------------------------------------------------------------------------|----------------------------| | [SipProfile.Builder](https://developer.android.com/reference/android/net/sip/SipProfile.Builder) | this builder object
| ### setAutoRegistration Added in[API level 9](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public SipProfile.Builder setAutoRegistration (boolean flag) ``` Sets the auto. registration flag.
| Parameters || |--------|-----------------------------------------------------------------------------------------| | `flag` | `boolean`: true if the profile will be registered automatically, false otherwise
| | Returns || |--------------------------------------------------------------------------------------------------|----------------------------| | [SipProfile.Builder](https://developer.android.com/reference/android/net/sip/SipProfile.Builder) | this builder object
| ### setDisplayName Added in[API level 9](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public SipProfile.Builder setDisplayName (String displayName) ``` Sets the display name of the user.
| Parameters || |---------------|-------------------------------------------| | `displayName` | `String`: display name of the user
| | Returns || |--------------------------------------------------------------------------------------------------|----------------------------| | [SipProfile.Builder](https://developer.android.com/reference/android/net/sip/SipProfile.Builder) | this builder object
| ### setOutboundProxy Added in[API level 9](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public SipProfile.Builder setOutboundProxy (String outboundProxy) ``` Sets the outbound proxy of the SIP server.
| Parameters || |-----------------|------------------------------------------------------------| | `outboundProxy` | `String`: the network address of the outbound proxy
| | Returns || |--------------------------------------------------------------------------------------------------|----------------------------| | [SipProfile.Builder](https://developer.android.com/reference/android/net/sip/SipProfile.Builder) | this builder object
| ### setPassword Added in[API level 9](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public SipProfile.Builder setPassword (String password) ``` Sets the password of the SIP account
| Parameters || |------------|----------------------------------------------| | `password` | `String`: password of the SIP account
| | Returns || |--------------------------------------------------------------------------------------------------|----------------------------| | [SipProfile.Builder](https://developer.android.com/reference/android/net/sip/SipProfile.Builder) | this builder object
| ### setPort Added in[API level 9](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public SipProfile.Builder setPort (int port) ``` Sets the port number of the server. By default, it is 5060.
| Parameters || |--------|-----------------------------------------| | `port` | `int`: port number of the server
| | Returns || |--------------------------------------------------------------------------------------------------|----------------------------| | [SipProfile.Builder](https://developer.android.com/reference/android/net/sip/SipProfile.Builder) | this builder object
| | Throws || |--------------------------------------------------------------------------------------------------------|------------------------------------| | [IllegalArgumentException](https://developer.android.com/reference/java/lang/IllegalArgumentException) | if the port number is out of range | ### setProfileName Added in[API level 9](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public SipProfile.Builder setProfileName (String name) ``` Sets the name of the profile. This name is given by user.
| Parameters || |--------|--------------------------------------| | `name` | `String`: name of the profile
| | Returns || |--------------------------------------------------------------------------------------------------|----------------------------| | [SipProfile.Builder](https://developer.android.com/reference/android/net/sip/SipProfile.Builder) | this builder object
| ### setProtocol Added in[API level 9](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public SipProfile.Builder setProtocol (String protocol) ``` Sets the protocol used to connect to the SIP server. Currently, only "UDP" and "TCP" are supported.
| Parameters || |------------|--------------------------------------| | `protocol` | `String`: the protocol string
| | Returns || |--------------------------------------------------------------------------------------------------|----------------------------| | [SipProfile.Builder](https://developer.android.com/reference/android/net/sip/SipProfile.Builder) | this builder object
| | Throws || |--------------------------------------------------------------------------------------------------------|-----------------------------------| | [IllegalArgumentException](https://developer.android.com/reference/java/lang/IllegalArgumentException) | if the protocol is not recognized | ### setSendKeepAlive Added in[API level 9](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public SipProfile.Builder setSendKeepAlive (boolean flag) ``` Sets the send keep-alive flag.
| Parameters || |--------|-----------------------------------------------------------------------------------| | `flag` | `boolean`: true if sending keep-alive message is required, false otherwise
| | Returns || |--------------------------------------------------------------------------------------------------|----------------------------| | [SipProfile.Builder](https://developer.android.com/reference/android/net/sip/SipProfile.Builder) | this builder object
|