LinphoneProxyConfig

```
public interface LinphoneProxyConfig
```
The LinphoneProxyConfig object represents a proxy configuration to be used by the LinphoneCore object. Its fields must not be used directly in favour of the accessors methods. Once created and filled properly the LinphoneProxyConfig can be given to LinphoneCore with LinphoneCore.addProxyConfig(LinphoneProxyConfig). This will automatically triggers the registration, if enabled.
The proxy configuration are persistent to restarts because they are saved in the configuration file. As a consequence, after LinphoneCoreFactory.createLinphoneCore(LinphoneCoreListener, String, String, Object, Object) there might already be a default proxy that can be examined with LinphoneCore.getDefaultProxyConfig() .

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`avpfEnabled()` Whether AVPF is used for calls through this proxy.
`void`	`done()` Commits modification made to the proxy configuration.
`LinphoneProxyConfig`	`edit()` Starts editing a proxy configuration.
`void`	`enableAvpf(boolean enable)` Indicates whether AVPF/SAVPF must be used for calls using this proxy config.
`void`	`enablePublish(boolean enable)` Indicates either or not, PUBLISH must be issued for this #LinphoneProxyConfig .
`void`	`enableQualityReporting(boolean enable)` Indicates whether quality reporting must be used for calls using this proxy config.
`LinphoneProxyConfig`	`enableRegister(boolean value)` Enable register for this proxy config.
`LinphoneAddress`	`getAddress()` get linphoneAddress that belongs to this proxy configuration.
`int`	`getAvpfRRInterval()` Get the interval between regular RTCP reports when using AVPF/SAVPF.
`String`	`getContactParameters()` Get the contact's parameters.
`String`	`getContactUriParameters()` Get the contact's URI parameters.
`String`	`getCustomHeader(String name)` Return the value of a header
`boolean`	`getDialEscapePlus()` Whether liblinphone should replace "+" by "00" in dialed numbers (passed to `LinphoneCore.invite(String)`).
`String`	`getDialPrefix()` Returns the automatically added international prefix to e164 phone numbers
`String`	`getDomain()` get domain host name or ip
`Reason`	`getError()` Return reason error code.
`ErrorInfo`	`getErrorInfo()` Get full error information about last error occured on the proxy config.
`int`	`getExpires()` Gets the registration expiration time.
`String`	`getIdentity()` get the SIP identity that belongs to this proxy configuration.
`int`	`getPrivacy()` Get the privacy mask requested for this proxy config.
`String`	`getProxy()` get the proxy's SIP address.
`int`	`getPublishExpires()`
`String`	`getQualityReportingCollector()` Get the collector SIP URI collecting reports when using quality reporting.
`int`	`getQualityReportingInterval()` Get the interval between quality interval reports during a call when using quality reporting.
`String`	`getRealm()` Get the outbound proxy realm.
`String`	`getRoute()`
`LinphoneCore.RegistrationState`	`getState()`
`Object`	`getUserData()` Returns user data from a proxy config. return null if any
`boolean`	`isPhoneNumber(String username)` Detect if the given input is a phone number or not.
`boolean`	`isRegistered()`
`int`	`lookupCCCFromE164(String e164)` Return the international prefix for the given country
`int`	`lookupCCCFromIso(String iso)` Return the international prefix for the given country
`String`	`normalizePhoneNumber(String number)` normalize a human readable phone number into a basic string. 888-444-222 becomes 888444222
`LinphoneAddress`	`normalizeSipUri(String username)` Normalize a human readable sip uri into a fully qualified LinphoneAddress.
`boolean`	`publishEnabled()` returns publish state for this proxy config (see `enablePublish(boolean)` )
`boolean`	`qualityReportingEnabled()` Whether quality reporting is used for calls through this proxy.
`boolean`	`registerEnabled()`
`void`	`setAddress(LinphoneAddress address)` Sets the address of the proxy configuration
`void`	`setAvpfRRInterval(int interval)` Set the interval between regular RTCP reports when using AVPF/SAVPF.
`void`	`setContactParameters(String contact_params)` Set optional contact parameters that will be added to the contact information sent in the registration.
`void`	`setContactUriParameters(String params)` Set optional contact parameters that will be added to the contact information sent in the registration, inside the URI.
`void`	`setCustomHeader(String name, String value)` Set a custom header
`void`	`setDialEscapePlus(boolean value)` * Sets whether liblinphone should replace "+" by "00" in dialed numbers (passed to `LinphoneCore.invite(String)`).
`void`	`setDialPrefix(String prefix)` Useful function to automatically add international prefix to e164 phone numbers
`void`	`setExpires(int delay)` Sets the registration expiration time.
`void`	`setIdentity(String identity)` Sets the user identity as a SIP address.
`void`	`setPrivacy(int privacy_mask)` Set the privacy for all calls or chat sessions using the identity exposed by this LinphoneProxyConfig
`void`	`setProxy(String proxyUri)` Sets the proxy address Examples of valid sip proxy address are: IP address: sip:87.98.157.38 IP address with port: sip:87.98.157.38:5062 hostnames : sip:sip.example.net
`void`	`setPublishExpires(int expires)` Set the publish expiration time in second.
`void`	`setQualityReportingCollector(String collector)` Set the collector SIP URI to collect reports when using quality reporting.
`void`	`setQualityReportingInterval(int interval)` Set the interval between quality interval reports during a call when using quality reporting.
`void`	`setRealm(String realm)` Set the outbound proxy realm.
`void`	`setRoute(String routeUri)` Sets a SIP route.
`void`	`setUserData(Object obj)` attached a user data to a proxy config

- Method Detail
  - edit
```
LinphoneProxyConfig edit()
```
    Starts editing a proxy configuration. Because proxy configuration must be consistent, applications MUST call edit() before doing any attempts to modify proxy configuration (such as identity, proxy address and so on). Once the modifications are done, then the application must call done() to commit the changes.
  - done
```
void done()
```
    Commits modification made to the proxy configuration.
  - setIdentity
```
void setIdentity(String identity)
                 throws LinphoneCoreException
```
    Sets the user identity as a SIP address.
    
    Parameters:
    identity - This identity is normally formed with display name, username and domain, such as: Alice <sip:alice@example.net> The REGISTER messages will have from and to set to this identity.
    
    Throws:
    
    LinphoneCoreException
  - getIdentity
```
String getIdentity()
```
    get the SIP identity that belongs to this proxy configuration.
    
    Returns:
    The SIP identity is a SIP address (Display Name <sip:username> )
  - setAddress
```
void setAddress(LinphoneAddress address)
                throws LinphoneCoreException
```
    Sets the address of the proxy configuration
    
    Parameters:
    address -
    
    Throws:
    
    LinphoneCoreException
  - getAddress
```
LinphoneAddress getAddress()
```
    get linphoneAddress that belongs to this proxy configuration.
    
    Returns:
    LinphoneAddress
  - setProxy
```
void setProxy(String proxyUri)
              throws LinphoneCoreException
```
    Sets the proxy address Examples of valid sip proxy address are:
    - IP address: sip:87.98.157.38
    - IP address with port: sip:87.98.157.38:5062
    - hostnames : sip:sip.example.net
    Parameters:
    proxyUri -
    
    Throws:
    
    LinphoneCoreException
  - getProxy
```
String getProxy()
```
    get the proxy's SIP address.
  - enableRegister
```
LinphoneProxyConfig enableRegister(boolean value)
```
    Enable register for this proxy config. Register message is issued after call to done()
    
    Parameters:
    value -
  - registerEnabled
```
boolean registerEnabled()
```
    Returns:
    true if registration to the proxy is enabled.
  - normalizePhoneNumber
```
String normalizePhoneNumber(String number)
```
    normalize a human readable phone number into a basic string. 888-444-222 becomes 888444222
    
    Parameters:
    number -
    
    Returns:
  - normalizeSipUri
```
LinphoneAddress normalizeSipUri(String username)
```
    Normalize a human readable sip uri into a fully qualified LinphoneAddress. A sip address should look like DisplayName <sip:username\@domain:port>.
    
    Parameters:
    username - the string to parse
    
    Returns:
    NULL if invalid input, normalized sip address otherwise.
  - setDialPrefix
```
void setDialPrefix(String prefix)
```
    Useful function to automatically add international prefix to e164 phone numbers
    
    Parameters:
    prefix -
  - getDialPrefix
```
String getDialPrefix()
```
    Returns the automatically added international prefix to e164 phone numbers
  - setDialEscapePlus
```
void setDialEscapePlus(boolean value)
```
    * Sets whether liblinphone should replace "+" by "00" in dialed numbers (passed to LinphoneCore.invite(String)).
    
    Parameters:
    value - default value is false
  - getDialEscapePlus
```
boolean getDialEscapePlus()
```
    Whether liblinphone should replace "+" by "00" in dialed numbers (passed to LinphoneCore.invite(String)).
  - getDomain
```
String getDomain()
```
    get domain host name or ip
    
    Returns:
    may be null
  - isRegistered
```
boolean isRegistered()
```
    Returns:
    a boolean indicating that the user is successfully registered on the proxy.
  - setRoute
```
void setRoute(String routeUri)
              throws LinphoneCoreException
```
    Sets a SIP route. When a route is set, all outgoing calls will go to the route's destination if this proxy is the default one (see LinphoneCore.getDefaultProxyConfig() ).
    
    Parameters:
    routeUri - ex sip:git.linphone.org
    
    Throws:
    
    LinphoneCoreException
  - getRoute
```
String getRoute()
```
    Returns:
    the route set for this proxy configuration.
  - enablePublish
```
void enablePublish(boolean enable)
```
    Indicates either or not, PUBLISH must be issued for this #LinphoneProxyConfig .
    In case this #LinphoneProxyConfig has been added to #LinphoneCore, follows the linphone_proxy_config_edit() rule.
    
    Parameters:
    enable - if true, publish will be engaged
  - publishEnabled
```
boolean publishEnabled()
```
    returns publish state for this proxy config (see enablePublish(boolean) )
  - getState
```
LinphoneCore.RegistrationState getState()
```
  - setExpires
```
void setExpires(int delay)
```
    Sets the registration expiration time.
    
    Parameters:
    delay - expiration time in seconds
  - getExpires
```
int getExpires()
```
    Gets the registration expiration time.
    
    Returns:
    delay expiration time in seconds.
  - setPrivacy
```
void setPrivacy(int privacy_mask)
```
    Set the privacy for all calls or chat sessions using the identity exposed by this LinphoneProxyConfig
    
    Parameters:
    privacy_mask - a or'd int of values defined in interface Privacy
  - getPrivacy
```
int getPrivacy()
```
    Get the privacy mask requested for this proxy config.
    
    Returns:
    the privacy mask as defined in interface Privacy
  - enableAvpf
```
void enableAvpf(boolean enable)
```
    Indicates whether AVPF/SAVPF must be used for calls using this proxy config.
    
    Parameters:
    enable - True to enable AVPF/SAVF, false to disable it.
  - avpfEnabled
```
boolean avpfEnabled()
```
    Whether AVPF is used for calls through this proxy.
    
    Returns:
  - setAvpfRRInterval
```
void setAvpfRRInterval(int interval)
```
    Set the interval between regular RTCP reports when using AVPF/SAVPF.
    
    Parameters:
    interval - The interval in seconds (between 0 and 5 seconds).
  - getAvpfRRInterval
```
int getAvpfRRInterval()
```
    Get the interval between regular RTCP reports when using AVPF/SAVPF.
    
    Returns:
    The interval in seconds.
  - enableQualityReporting
```
void enableQualityReporting(boolean enable)
```
    Indicates whether quality reporting must be used for calls using this proxy config.
    
    Parameters:
    enable - True to enable quality reporting, false to disable it.
  - qualityReportingEnabled
```
boolean qualityReportingEnabled()
```
    Whether quality reporting is used for calls through this proxy.
    
    Returns:
  - setQualityReportingInterval
```
void setQualityReportingInterval(int interval)
```
    Set the interval between quality interval reports during a call when using quality reporting.
    
    Parameters:
    interval - The interval in seconds (should be greater than 120 seconds to avoid too much).
  - getQualityReportingInterval
```
int getQualityReportingInterval()
```
    Get the interval between quality interval reports during a call when using quality reporting.
    
    Returns:
    The interval in seconds.
  - setQualityReportingCollector
```
void setQualityReportingCollector(String collector)
```
    Set the collector SIP URI to collect reports when using quality reporting.
    
    Parameters:
    collector - The collector SIP URI which should be configured server side too.
  - getQualityReportingCollector
```
String getQualityReportingCollector()
```
    Get the collector SIP URI collecting reports when using quality reporting.
    
    Returns:
    The SIP URI collector address.
  - setRealm
```
void setRealm(String realm)
```
    Set the outbound proxy realm. It is used in digest authentication to avoid re-authentication if a previous token has already been provided.
    
    Parameters:
    realm - The new outbound proxy realm.
  - getRealm
```
String getRealm()
```
    Get the outbound proxy realm.
    
    Returns:
    The outbound proxy realm.
  - setContactParameters
```
void setContactParameters(String contact_params)
```
    Set optional contact parameters that will be added to the contact information sent in the registration.
    
    Parameters:
    contact_params - a string containing the additional parameters in text form, like "myparam=something;myparam2=something_else" The main use case for this function is provide the proxy additional information regarding the user agent, like for example unique identifier or android push id. As an example, the contact address in the SIP register sent will look like <sip:joe@15.128.128.93:50421>;android-push-id=43143-DFE23F-2323-FA2232.
  - getContactParameters
```
String getContactParameters()
```
    Get the contact's parameters.
    
    Returns:
  - setContactUriParameters
```
void setContactUriParameters(String params)
```
    Set optional contact parameters that will be added to the contact information sent in the registration, inside the URI.
    
    Parameters:
    params - a string containing the additional parameters in text form, like "myparam=something;myparam2=something_else" The main use case for this function is provide the proxy additional information regarding the user agent, like for example unique identifier or apple push id. As an example, the contact address in the SIP register sent will look like <sip:joe@15.128.128.93:50421;apple-push-id=43143-DFE23F-2323-FA2232>.
  - getContactUriParameters
```
String getContactUriParameters()
```
    Get the contact's URI parameters.
    
    Returns:
  - lookupCCCFromIso
```
int lookupCCCFromIso(String iso)
```
    Return the international prefix for the given country
    
    Parameters:
    iso - code
  - lookupCCCFromE164
```
int lookupCCCFromE164(String e164)
```
    Return the international prefix for the given country
    
    Parameters:
    e164 - phone number
  - getError
```
Reason getError()
```
    Return reason error code.
    
    Returns:
    reason code.
  - getErrorInfo
```
ErrorInfo getErrorInfo()
```
    Get full error information about last error occured on the proxy config.
    
    Returns:
    an ErrorInfo.
  - setPublishExpires
```
void setPublishExpires(int expires)
```
    Set the publish expiration time in second.
    
    Parameters:
    expires - in second
  - getPublishExpires
```
int getPublishExpires()
```
    Returns:
    the publish expiration time in second. Default value is the registration expiration value.
  - setUserData
```
void setUserData(Object obj)
```
    attached a user data to a proxy config
  - isPhoneNumber
```
boolean isPhoneNumber(String username)
```
    Detect if the given input is a phone number or not.
    
    Parameters:
    username - string to parse.
    
    Returns:
    TRUE if input is a phone number, FALSE otherwise.
  - getUserData
```
Object getUserData()
```
    Returns user data from a proxy config. return null if any
    
    Returns:
    an Object.
  - setCustomHeader
```
void setCustomHeader(String name,
                   String value)
```
    Set a custom header
    
    Parameters:
    name - a string containing the name of the header
    value - a string containing the value of the header
  - getCustomHeader
```
String getCustomHeader(String name)
```
    Return the value of a header
    
    Parameters:
    name - a string containing the name of the header
    
    Returns:
    the value of the header

Interface LinphoneProxyConfig

Method Summary

Method Detail

edit

done

setIdentity

getIdentity

setAddress

getAddress

setProxy

getProxy

enableRegister

registerEnabled

normalizePhoneNumber

normalizeSipUri

setDialPrefix

getDialPrefix

setDialEscapePlus

getDialEscapePlus

getDomain

isRegistered

setRoute

getRoute

enablePublish

publishEnabled

getState

setExpires

getExpires

setPrivacy

getPrivacy

enableAvpf

avpfEnabled

setAvpfRRInterval

getAvpfRRInterval

enableQualityReporting

qualityReportingEnabled

setQualityReportingInterval

getQualityReportingInterval

setQualityReportingCollector

getQualityReportingCollector

setRealm

getRealm

setContactParameters

getContactParameters

setContactUriParameters

getContactUriParameters

lookupCCCFromIso

lookupCCCFromE164

getError

getErrorInfo

setPublishExpires

getPublishExpires

setUserData

isPhoneNumber

getUserData

setCustomHeader

getCustomHeader