Package org.linphone.core
Interface ProxyConfig
public interface ProxyConfig
Represents an account configuration to be used by
In addition to the
configure a
A minimal proxy config consists of an identity address
(sip:username@domain.tld) and the proxy server address, see:
.
If any, it will be stored inside the default configuration file, so it will
survive the destruction of the
The account set with
for outgoing calls & chat messages unless specified otherwise.
deprecated: 06/04/2020 Use
Core. In addition to the
AuthInfo that stores the credentials, you need toconfigure a
ProxyConfig as well to be able to connect to a proxy server.A minimal proxy config consists of an identity address
(sip:username@domain.tld) and the proxy server address, see:
setServerAddr(java.lang.String).
If any, it will be stored inside the default configuration file, so it will
survive the destruction of the
Core and be available at the next start.The account set with
Core.setDefaultProxyConfig(org.linphone.core.ProxyConfig) will be used as defaultfor outgoing calls & chat messages unless specified otherwise.
deprecated: 06/04/2020 Use
Account object instead -
Method Summary
Modifier and TypeMethodDescriptionintdone()Deprecated.voidedit()Deprecated.Deprecated.Deprecated.intDeprecated.Deprecated.Deprecated.Deprecated.Deprecated.getCore()Deprecated.getCustomHeader(String headerName) Deprecated.Deprecated.booleanDeprecated.Deprecated.Deprecated.getError()Deprecated.Deprecated.intDeprecated.Deprecated.getIdkey()Deprecated.longGets the native pointer used by this class to make native method calls.Deprecated.intDeprecated.intDeprecated.Deprecated.Deprecated.intDeprecated.getRealm()Deprecated.Deprecated.String[]Deprecated.Deprecated.getState()Deprecated.Deprecated.intDeprecated.Gets the object stored in this object user's databooleanDeprecated.booleanDeprecated.booleanDeprecated.booleanDeprecated.booleanDeprecated.booleanDeprecated.booleanDeprecated.normalizePhoneNumber(String username) Deprecated.normalizeSipUri(String username) Deprecated.voidDeprecated.voidDeprecated.voidsetAvpfMode(AVPFMode mode) Deprecated.voidsetAvpfRrInterval(int interval) Deprecated.voidDeprecated.voidsetContactParameters(String contactParams) Deprecated.voidsetContactUriParameters(String contactUriParams) Deprecated.voidsetCustomHeader(String headerName, String headerValue) Deprecated.voidsetDependency(ProxyConfig dependsOn) Deprecated.voidsetDialEscapePlus(boolean enable) Deprecated.voidsetDialPrefix(String prefix) Deprecated.voidsetExpires(int expires) Deprecated.intsetIdentityAddress(Address identity) Deprecated.voidDeprecated.voidsetNatPolicy(NatPolicy policy) Deprecated.voidsetPrivacy(int privacy) Deprecated.voidsetPublishEnabled(boolean enable) Deprecated.voidsetPublishExpires(int expires) Deprecated.voidsetPushNotificationAllowed(boolean allow) Deprecated.voidDeprecated.voidsetQualityReportingCollector(String collector) Deprecated.voidsetQualityReportingEnabled(boolean enable) Deprecated.voidsetQualityReportingInterval(int interval) Deprecated.voidDeprecated.voidDeprecated.voidsetRegisterEnabled(boolean enable) Deprecated.voidsetRemotePushNotificationAllowed(boolean allow) Deprecated.intDeprecated.intDeprecated.intsetServerAddr(String serverAddress) Deprecated.voidsetUserData(Object data) Sets the object to store in this object user's datatoString()
-
Method Details
-
isAvpfEnabled
Deprecated.Indicates whether AVPF/SAVPF is being used for calls using this proxy config.
- Returns:
- True if AVPF/SAVPF is enabled, false otherwise.
deprecated: 06/04/2020 UseAccountobject instead
-
getAvpfMode
Deprecated.Get enablement status of RTCP feedback (also known as AVPF profile).
- Returns:
- the enablement mode, which can be
AVPFMode.Default(use
LinphoneCore's mode),AVPFMode.Enabled(avpf is enabled), orAVPFMode.Disabled
(disabled).
deprecated: 06/04/2020 UseAccountobject instead
-
setAvpfMode
Deprecated.Enable the use of RTCP feedback (also known as AVPF profile).
- Parameters:
mode- the enablement mode, which can beAVPFMode.Default(use
LinphoneCore's mode),AVPFMode.Enabled(avpf is enabled), orAVPFMode.Disabled
(disabled).
deprecated: 06/04/2020 UseAccountobject instead
-
getAvpfRrInterval
Deprecated.Get the interval between regular RTCP reports when using AVPF/SAVPF.
- Returns:
- The interval in seconds.
deprecated: 06/04/2020 UseAccountobject instead
-
setAvpfRrInterval
Deprecated.Set the interval between regular RTCP reports when using AVPF/SAVPF.
- Parameters:
interval- The interval in seconds (between 0 and 5 seconds).
deprecated: 06/04/2020 UseAccountobject instead
-
getConferenceFactoryUri
Deprecated.Get the conference factory uri.
- Returns:
- The uri of the conference factory.
deprecated: 06/04/2020 UseAccountobject instead
-
setConferenceFactoryUri
Deprecated.Set the conference factory uri.
- Parameters:
uri- The uri of the conference factory.
deprecated: 06/04/2020 UseAccountobject instead
-
getContact
Deprecated.Return the contact address of the proxy config.
-
getContactParameters
Deprecated.Returns the contact parameters.
- Returns:
- previously set contact parameters.
deprecated: 06/04/2020 UseAccountobject instead
-
setContactParameters
Deprecated.Set optional contact parameters that will be added to the contact information
sent in the registration.
- Parameters:
contactParams- a string contaning 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.
deprecated: 06/04/2020 UseAccountobject instead
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.
deprecated: 06/04/2020 UseAccountobject instead
-
getContactUriParameters
Deprecated.Returns the contact URI parameters.
- Returns:
- previously set contact URI parameters.
deprecated: 06/04/2020 UseAccountobject instead
-
setContactUriParameters
Deprecated.Set optional contact parameters that will be added to the contact information
sent in the registration, inside the URI.
- Parameters:
contactUriParams- 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>.
deprecated: 06/04/2020 UseAccountobject instead
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>.
deprecated: 06/04/2020 UseAccountobject instead
-
getCore
Deprecated.- Returns:
- The
Coreobject to which is associated theProxyConfig.
deprecated: 06/04/2020 UseAccountobject instead
-
getDependency
Deprecated.- Returns:
- The proxy config this one is dependent upon, or null if not marked
dependent.
deprecated: 06/04/2020 UseAccountobject instead
-
setDependency
Deprecated.Mark this proxy configuration as being dependent on the given one.
The dependency must refer to a proxy config previously added to the core and
which idkey property is defined.
see:setIdkey(java.lang.String)
The proxy configuration marked as dependent will wait for successful
registration on its dependency before triggering its own.
Once registered, both proxy configurations will share the same contact address
(the 'dependency' one).
This mecanism must be enabled before the proxy configuration is added to the
core- Parameters:
dependsOn- TheProxyConfigthis one shall be depend on.
deprecated: 06/04/2020 UseAccountobject instead
-
getDialEscapePlus
Deprecated.Returns whether or not the + should be replaced by 00.
- Returns:
- whether liblinphone should replace "+" by "00" in dialed numbers
(passed toCore.invite(java.lang.String)).
deprecated: 06/04/2020 UseAccountobject instead
-
setDialEscapePlus
Deprecated.Sets whether liblinphone should replace "+" by international calling prefix in
dialed numbers (passed toCore.invite(java.lang.String)).
- Parameters:
enable- true to replace + by the international prefix, false otherwise.
deprecated: 06/04/2020 UseAccountobject instead
-
getDialPrefix
Deprecated.Gets the prefix set for this proxy config.
- Returns:
- dialing prefix.
deprecated: 06/04/2020 UseAccountobject instead
-
setDialPrefix
Deprecated.Sets a dialing prefix to be automatically prepended when inviting a number with
Core.invite(java.lang.String); This dialing prefix shall usually be the country code of
the country where the user is living, without "+".
- Parameters:
prefix- the prefix to set (withouth the +)
deprecated: 06/04/2020 UseAccountobject instead
-
getDomain
Deprecated.Get the domain name of the given proxy config.
- Returns:
- The domain name of the proxy config.
deprecated: 06/04/2020 UseAccountobject instead
-
getError
Deprecated.Get the reason why registration failed when the proxy config state is
LinphoneRegistrationFailed.
-
getErrorInfo
Deprecated.Get detailed information why registration failed when the proxy config state is
LinphoneRegistrationFailed.
-
getExpires
Deprecated.Gets the proxy config expires.
- Returns:
- the duration of registration.
deprecated: 06/04/2020 UseAccountobject instead
-
setExpires
Deprecated.Sets the registration expiration time in seconds.
- Parameters:
expires- the expiration time to set
deprecated: 06/04/2020 UseAccountobject instead
-
getIdentityAddress
Deprecated.Gets the identity addres of the proxy config.
- Returns:
- the SIP identity that belongs to this proxy configuration.
deprecated: 06/04/2020 UseAccountobject instead
-
setIdentityAddress
Deprecated.Sets the user identity as a SIP address.
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.
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. -
getIdkey
Deprecated.- Returns:
- The idkey string, or null.
deprecated: 06/04/2020 UseAccountobject instead
-
setIdkey
Deprecated.Set the idkey property on the given proxy configuration.
This property can the be referenced by another proxy config 'depends_on' to
create a dependency relation between them. see:
linphone_proxy_config_set_depends_on()- Parameters:
idkey- The idkey string to associate to the givenProxyConfig.
deprecated: 06/04/2020 UseAccountobject instead
-
isPushNotificationAllowed
Deprecated.Indicates whether to add to the contact parameters the push notification
information.
For IOS, it indicates to VOIP push notification.- Returns:
- true if push notification informations should be added, false
otherwise.
deprecated: 06/04/2020 UseAccountobject instead
-
isPushNotificationAvailable
Deprecated.Gets whether push notifications are available or not (Android & iOS only).
- Returns:
- true if push notifications are available, false otherwise
deprecated: 06/04/2020 UseAccountobject instead
-
isRemotePushNotificationAllowed
Deprecated.Indicates whether to add to the contact parameters the remote push notification
information (IOS only).
Default value is false.- Returns:
- true if remote push notification informations should be added, false
otherwise.
deprecated: 06/04/2020 UseAccountobject instead
-
getNatPolicy
Deprecated.Get The policy that is used to pass through NATs/firewalls when using this
proxy config.
If it is set to null, the default NAT policy from the core will be used
instead.- Returns:
NatPolicyobject in use.
see:Core.getNatPolicy()
deprecated: 06/04/2020 UseAccountobject instead
-
setNatPolicy
Deprecated.Set the policy to use to pass through NATs/firewalls when using this proxy
config.
If it is set to null, the default NAT policy from the core will be used
instead.- Parameters:
policy-NatPolicyobject.
see:Core.setNatPolicy(org.linphone.core.NatPolicy)
deprecated: 06/04/2020 UseAccountobject instead
-
getPrivacy
Deprecated.Get default privacy policy for all calls routed through this proxy.
- Returns:
- Privacy mode as LinphonePrivacyMask
deprecated: 06/04/2020 UseAccountobject instead
-
setPrivacy
Deprecated.Set default privacy policy for all calls routed through this proxy.
-
isPublishEnabled
Deprecated.Gets if the PUBLISH is enabled.
- Returns:
- true if PUBLISH request is enabled for this proxy.
deprecated: 06/04/2020 UseAccountobject instead
-
setPublishEnabled
Deprecated.Indicates either or not, PUBLISH must be issued for thisProxyConfig.
In case thisProxyConfighas been added toCore, follows the
edit()rule.- Parameters:
enable- if true, publish will be engaged
deprecated: 06/04/2020 UseAccountobject instead
-
getPublishExpires
Deprecated.get the publish expiration time in second.
Default value is the registration expiration value.- Returns:
- expires in second
deprecated: 06/04/2020 UseAccountobject instead
-
setPublishExpires
Deprecated.Set the publish expiration time in second.
- Parameters:
expires- in second
deprecated: 06/04/2020 UseAccountobject instead
-
setPushNotificationAllowed
Deprecated.Indicates whether to add to the contact parameters the push notification
information.
For IOS, it indicates to VOIP push notification.- Parameters:
allow- true to allow push notification information, false otherwise.
deprecated: 06/04/2020 UseAccountobject instead
-
getPushNotificationConfig
Deprecated.Retrieves the push notification configuration.
- Returns:
- The
PushNotificationConfig.
deprecated: 06/04/2020 UseAccountobject instead
-
setPushNotificationConfig
Deprecated.Sets the push notification configuration.
- Parameters:
pushCfg-PushNotificationConfigto set.
deprecated: 06/04/2020 UseAccountobject instead
-
getQualityReportingCollector
Deprecated.Get the route of the collector end-point when using quality reporting.
This SIP address should be used on server-side to process packets directly
before discarding packets. Collector address should be a non existing account
and will not receive any messages. If null, reports will be send to the proxy
domain.- Returns:
- The SIP address of the collector end-point.
deprecated: 06/04/2020 UseAccountobject instead
-
setQualityReportingCollector
Deprecated.Set the route of the collector end-point when using quality reporting.
This SIP address should be used on server-side to process packets directly
before discarding packets. Collector address should be a non existing account
and will not receive any messages. If null, reports will be send to the proxy
domain.- Parameters:
collector- route of the collector end-point, if null PUBLISH will be sent
to the proxy domain.
deprecated: 06/04/2020 UseAccountobject instead
-
isQualityReportingEnabled
Deprecated.Indicates whether quality statistics during call should be stored and sent to a
collector according to RFC 6035.
- Returns:
- True if quality repotring is enabled, false otherwise.
deprecated: 06/04/2020 UseAccountobject instead
-
setQualityReportingEnabled
Deprecated.Indicates whether quality statistics during call should be stored and sent to a
collector according to RFC 6035.
- Parameters:
enable- True to store quality statistics and send them to the collector,
false to disable it.
deprecated: 06/04/2020 UseAccountobject instead
-
getQualityReportingInterval
Deprecated.Get the interval between interval reports when using quality reporting.
- Returns:
- The interval in seconds, 0 means interval reports are disabled.
deprecated: 06/04/2020 UseAccountobject instead
-
setQualityReportingInterval
Deprecated.Set the interval between 2 interval reports sending when using quality
reporting.
If call exceed interval size, an interval report will be sent to the collector.
On call termination, a session report will be sent for the remaining period.
Value must be 0 (disabled) or positive.- Parameters:
interval- The interval in seconds, 0 means interval reports are disabled.
deprecated: 06/04/2020 UseAccountobject instead
-
getRealm
Deprecated.Get the realm of the given proxy config.
- Returns:
- The realm of the proxy config.
deprecated: 06/04/2020 UseAccountobject instead
-
setRealm
Deprecated.Set the realm of the given proxy config.
- Parameters:
realm- New realm value.
deprecated: 06/04/2020 UseAccountobject instead
-
getRefKey
Deprecated.Get the persistent reference key associated to the proxy config.
The reference key can be for example an id to an external database. It is
stored in the config file, thus can survive to process exits/restarts.- Returns:
- The reference key string that has been associated to the proxy config,
or null if none has been associated.
deprecated: 06/04/2020 UseAccountobject instead
-
setRefKey
Deprecated.Associate a persistent reference key to the proxy config.
The reference key can be for example an id to an external database. It is
stored in the config file, thus can survive to process exits/restarts.- Parameters:
refkey- The reference key string to associate to the proxy config.
deprecated: 06/04/2020 UseAccountobject instead
-
isRegisterEnabled
Deprecated.Returns whether the proxy config is enabled or not.
- Returns:
- true if registration to the proxy is enabled.
deprecated: 06/04/2020 UseAccountobject instead
-
setRegisterEnabled
Deprecated.Indicates either or not, REGISTRATION must be issued for thisProxyConfig
.
In case thisProxyConfighas been added toCore, follows the
edit()rule.- Parameters:
enable- if true, registration will be engaged
deprecated: 06/04/2020 UseAccountobject instead
-
setRemotePushNotificationAllowed
Deprecated.Indicates whether to add to the contact parameters the remote push notification
information (IOS only).
- Parameters:
allow- true to allow remote push notification information, false
otherwise.
deprecated: 06/04/2020 UseAccountobject instead
-
setRoute
Deprecated.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 (seeCore.setDefaultProxyConfig(org.linphone.core.ProxyConfig)).- Parameters:
route- the SIP route to set- Returns:
- -1 if route is invalid, 0 otherwise.
deprecated: 08/07/2020 usesetRoutes(java.lang.String[])instead
-
getRoutes
Deprecated.Gets the list of the routes set for this proxy config.
- Returns:
- The list of routes as string.
deprecated: 06/04/2020 UseAccountobject instead
-
setRoutes
Deprecated.Sets a list of SIP route.
When a route is set, all outgoing calls will go to the route's destination if
this proxy is the default one (seeCore.setDefaultProxyConfig(org.linphone.core.ProxyConfig)).- Parameters:
routes- A of routes- Returns:
- -1 if routes are invalid, 0 otherwise.
deprecated: 06/04/2020 UseAccountobject instead
-
getServerAddr
Deprecated.Gets the proxy config proxy address.
- Returns:
- the proxy's SIP address.
deprecated: 06/04/2020 UseAccountobject instead
-
setServerAddr
Deprecated.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:
serverAddress- the proxy address to set.
deprecated: 06/04/2020 UseAccountobject instead
-
getState
Deprecated.Get the registration state of the given proxy config.
- Returns:
- The
RegistrationStateof the proxy config.
deprecated: 06/04/2020 UseAccountobject instead
-
getTransport
Deprecated.Get the transport from either service route, route or addr.
- Returns:
- The transport as a string (I.E udp, tcp, tls, dtls)
deprecated: 06/04/2020 UseAccountobject instead
-
getUnreadChatMessageCount
Deprecated.Return the unread chat message count for a given proxy config.
- Returns:
- The unread chat message count.
deprecated: 06/04/2020 UseAccountobject instead
-
done
Deprecated.Commits modification made to the proxy configuration.
- Returns:
- 0 if successful, -1 otherwise
deprecated: 06/04/2020 UseAccountobject instead
-
edit
Deprecated.Starts editing a proxy configuration.
Because proxy configuration must be consistent, applications MUST calledit()
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 calldone()to commit the changes.
deprecated: 06/04/2020 UseAccountobject instead -
findAuthInfo
Deprecated.Find authentication info matching proxy config, if any, similarly to
linphone_core_find_auth_info.
-
getCustomHeader
Deprecated.Obtain the value of a header sent by the server in last answer to REGISTER.
- Parameters:
headerName- the header name for which to fetch corresponding value- Returns:
- the value of the queried header.
deprecated: 06/04/2020 UseAccountobject instead
-
normalizePhoneNumber
Deprecated.Normalize a human readable phone number into a basic string.
888-444-222 becomes 888444222 or +33888444222 depending on theProxyConfig
object. This function will always generate a normalized username if input is a
phone number.- Parameters:
username- the string to parse- Returns:
- null if input is an invalid phone number, normalized phone number from
username input otherwise.
deprecated: 06/04/2020 UseAccountobject instead
-
normalizeSipUri
Deprecated.Normalize a human readable sip uri into a fully qualified LinphoneAddress.
A sip address should look like DisplayName <sip:username@domain:port> .
Basically this function performs the following tasks
-if a phone number is entered, prepend country prefix and eventually escape the
'+' by 00 of the proxy config.
-if no domain part is supplied, append the domain name of the proxy config.
Returns null if no proxy is provided at this point.
-if no sip: is present, prepend it.
The result is a syntactically correct SIP address.- Parameters:
username- the string to parse- Returns:
- null if invalid input, normalized sip address otherwise.
deprecated: 06/04/2020 UseAccountobject instead
-
pauseRegister
Deprecated.Prevent a proxy config from refreshing its registration.
This is useful to let registrations to expire naturally (or) when the
application wants to keep control on when refreshes are sent. However,
linphone_core_set_network_reachable(lc,true) will always request the proxy
configs to refresh their registrations. The refreshing operations can be
resumed withrefreshRegister().
deprecated: 06/04/2020 UseAccountobject instead -
refreshRegister
Deprecated.Refresh a proxy registration.
This is useful if for example you resuming from suspend, thus IP address may
have changed.
deprecated: 06/04/2020 UseAccountobject instead -
setCustomHeader
Deprecated.Set the value of a custom header sent to the server in REGISTERs request.
- Parameters:
headerName- the header nameheaderValue- the header's value
deprecated: 06/04/2020 UseAccountobject instead
-
setUserData
Sets the object to store in this object user's data- Parameters:
data- the object to store
-
getUserData
Object getUserData()Gets the object stored in this object user's data- Returns:
- the object store if any, null otherwise
-
getNativePointer
long getNativePointer()Gets the native pointer used by this class to make native method calls.- Returns:
- the nativer pointer, as long
-
toString
String toString()
-