public interface ProxyConfig
Core
. AuthInfo
that stores the credentials, you need toProxyConfig
as well to be able to connect to a proxy server.setServerAddr(java.lang.String)
Core
and be available at the next start.Core.setDefaultProxyConfig(org.linphone.core.ProxyConfig)
will be used as defaultModifier and Type | Method and Description |
---|---|
boolean |
avpfEnabled()
Indicates whether AVPF/SAVPF is being used for calls using this proxy config.
|
int |
done()
Commits modification made to the proxy configuration.
|
void |
edit()
Starts editing a proxy configuration.
|
void |
enablePublish(boolean enable)
Indicates either or not, PUBLISH must be issued for this
ProxyConfig . |
void |
enableQualityReporting(boolean enable)
Indicates whether quality statistics during call should be stored and sent to a
collector according to RFC 6035. |
void |
enableRegister(boolean enable)
Indicates either or not, REGISTRATION must be issued for this
ProxyConfig . |
AuthInfo |
findAuthInfo()
Find authentication info matching proxy config, if any, similarly to
linphone_core_find_auth_info. |
AVPFMode |
getAvpfMode()
Get enablement status of RTCP feedback (also known as AVPF profile).
|
int |
getAvpfRrInterval()
Get the interval between regular RTCP reports when using AVPF/SAVPF.
|
java.lang.String |
getConferenceFactoryUri()
Get the conference factory uri.
|
Address |
getContact()
Return the contact address of the proxy config.
|
java.lang.String |
getContactParameters()
Returns the contact parameters.
|
java.lang.String |
getContactUriParameters()
Returns the contact URI parameters.
|
Core |
getCore()
Get the
Core object to which is associated the ProxyConfig . |
java.lang.String |
getCustomHeader(java.lang.String headerName)
Obtain the value of a header sent by the server in last answer to REGISTER.
|
ProxyConfig |
getDependency()
Get the dependency of a
ProxyConfig . |
boolean |
getDialEscapePlus()
Returns whether or not the + should be replaced by 00.
|
java.lang.String |
getDialPrefix()
Gets the prefix set for this proxy config.
|
java.lang.String |
getDomain()
Get the domain name of the given proxy config.
|
Reason |
getError()
Get the reason why registration failed when the proxy config state is
LinphoneRegistrationFailed. |
ErrorInfo |
getErrorInfo()
Get detailed information why registration failed when the proxy config state is
LinphoneRegistrationFailed. |
int |
getExpires()
Gets the proxy config expires.
|
Address |
getIdentityAddress()
Gets the identity addres of the proxy config.
|
java.lang.String |
getIdkey()
Get the idkey property of a
ProxyConfig . |
long |
getNativePointer()
Gets the native pointer used by this class to make native method calls.
|
NatPolicy |
getNatPolicy()
Get The policy that is used to pass through NATs/firewalls when using this
proxy config. |
int |
getPrivacy()
Get default privacy policy for all calls routed through this proxy.
|
int |
getPublishExpires()
get the publish expiration time in second.
|
java.lang.String |
getQualityReportingCollector()
Get the route of the collector end-point when using quality reporting.
|
int |
getQualityReportingInterval()
Get the interval between interval reports when using quality reporting.
|
java.lang.String |
getRealm()
Get the realm of the given proxy config.
|
java.lang.String |
getRefKey()
Get the persistent reference key associated to the proxy config.
|
java.lang.String[] |
getRoutes()
Gets the list of the routes set for this proxy config.
|
java.lang.String |
getServerAddr()
Gets the proxy config proxy address.
|
RegistrationState |
getState()
Get the registration state of the given proxy config.
|
java.lang.String |
getTransport()
Get the transport from either service route, route or addr.
|
int |
getUnreadChatMessageCount()
Return the unread chat message count for a given proxy config.
|
java.lang.Object |
getUserData()
Gets the object stored in this object user's data
|
boolean |
isPhoneNumber(java.lang.String username)
Detect if the given input is a phone number or not.
|
boolean |
isPushNotificationAllowed()
Indicates whether to add to the contact parameters the push notification
information. |
java.lang.String |
normalizePhoneNumber(java.lang.String username)
Normalize a human readable phone number into a basic string.
|
Address |
normalizeSipUri(java.lang.String username)
Normalize a human readable sip uri into a fully qualified LinphoneAddress.
|
void |
pauseRegister()
Prevent a proxy config from refreshing its registration.
|
boolean |
publishEnabled()
Gets if the PUBLISH is enabled.
|
boolean |
qualityReportingEnabled()
Indicates whether quality statistics during call should be stored and sent to a
collector according to RFC 6035. |
void |
refreshRegister()
Refresh a proxy registration.
|
boolean |
registerEnabled()
Returns whether the proxy config is enabled or not.
|
void |
setAvpfMode(AVPFMode mode)
Enable the use of RTCP feedback (also known as AVPF profile).
|
void |
setAvpfRrInterval(int interval)
Set the interval between regular RTCP reports when using AVPF/SAVPF.
|
void |
setConferenceFactoryUri(java.lang.String uri)
Set the conference factory uri.
|
void |
setContactParameters(java.lang.String contactParams)
Set optional contact parameters that will be added to the contact information
sent in the registration. |
void |
setContactUriParameters(java.lang.String contactUriParams)
Set optional contact parameters that will be added to the contact information
sent in the registration, inside the URI. |
void |
setCustomHeader(java.lang.String headerName,
java.lang.String headerValue)
Set the value of a custom header sent to the server in REGISTERs request.
|
void |
setDependency(ProxyConfig dependsOn)
Mark this proxy configuration as being dependent on the given one.
|
void |
setDialEscapePlus(boolean enable)
Sets whether liblinphone should replace "+" by international calling prefix in
dialed numbers (passed to Core.invite(java.lang.String) ). |
void |
setDialPrefix(java.lang.String prefix)
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 ofthe country where the user is living, without "+". |
void |
setExpires(int expires)
Sets the registration expiration time in seconds.
|
int |
setIdentityAddress(Address identity)
Sets the user identity as a SIP address.
|
void |
setIdkey(java.lang.String idkey)
Set the idkey property on the given proxy configuration.
|
void |
setNatPolicy(NatPolicy policy)
Set the policy to use to pass through NATs/firewalls when using this proxy
config. |
void |
setPrivacy(int privacy)
Set default privacy policy for all calls routed through this proxy.
|
void |
setPublishExpires(int expires)
Set the publish expiration time in second.
|
void |
setPushNotificationAllowed(boolean allow)
Indicates whether to add to the contact parameters the push notification
information. |
void |
setQualityReportingCollector(java.lang.String collector)
Set the route of the collector end-point when using quality reporting.
|
void |
setQualityReportingInterval(int interval)
Set the interval between 2 interval reports sending when using quality
reporting. |
void |
setRealm(java.lang.String realm)
Set the realm of the given proxy config.
|
void |
setRefKey(java.lang.String refkey)
Associate a persistent reference key to the proxy config.
|
int |
setRoute(java.lang.String route)
Deprecated.
08/07/2020 use
setRoutes(java.lang.String[]) instead |
int |
setRoutes(java.lang.String[] routes)
Sets a list of SIP route.
|
int |
setServerAddr(java.lang.String serverAddress)
Sets the proxy address.
|
void |
setUserData(java.lang.Object data)
Sets the object to store in this object user's data
|
java.lang.String |
toString() |
boolean avpfEnabled()
AVPFMode getAvpfMode()
AVPFMode.Default
(useAVPFMode.Enabled
(avpf is enabled), or AVPFMode.Disabled
void setAvpfMode(AVPFMode mode)
mode
- the enablement mode, which can be AVPFMode.Default
(useAVPFMode.Enabled
(avpf is enabled), or AVPFMode.Disabled
int getAvpfRrInterval()
void setAvpfRrInterval(int interval)
interval
- The interval in seconds (between 0 and 5 seconds). @Nullable java.lang.String getConferenceFactoryUri()
void setConferenceFactoryUri(@Nullable java.lang.String uri)
uri
- The uri of the conference factory. @Nullable Address getContact()
Address
correspong to the contact address of the proxy@Nullable java.lang.String getContactParameters()
void setContactParameters(@Nullable java.lang.String contactParams)
contactParams
- a string contaning the additional parameters in text form,@Nullable java.lang.String getContactUriParameters()
void setContactUriParameters(@Nullable java.lang.String contactUriParams)
contactUriParams
- a string containing the additional parameters in text@NonNull Core getCore()
Core
object to which is associated the ProxyConfig
.@Nullable ProxyConfig getDependency()
void setDependency(@Nullable ProxyConfig dependsOn)
setIdkey(java.lang.String)
dependsOn
- The ProxyConfig
this one shall be depend on. boolean getDialEscapePlus()
Core.invite(java.lang.String)
). void setDialEscapePlus(boolean enable)
Core.invite(java.lang.String)
). enable
- true to replace + by the international prefix, false otherwise. @Nullable java.lang.String getDialPrefix()
void setDialPrefix(@Nullable java.lang.String prefix)
Core.invite(java.lang.String)
; This dialing prefix shall usually be the country code ofprefix
- the prefix to set (withouth the +) @Nullable java.lang.String getDomain()
Reason getError()
Reason
why registration failed for this proxy config. @NonNull ErrorInfo getErrorInfo()
ErrorInfo
explaining why registration failed for this proxyint getExpires()
void setExpires(int expires)
expires
- the expiration time to set @Nullable Address getIdentityAddress()
int setIdentityAddress(@Nullable Address identity)
identity
- the Address
of the identity to set @Nullable java.lang.String getIdkey()
void setIdkey(@Nullable java.lang.String idkey)
idkey
- The idkey string to associate to the given ProxyConfig
. boolean isPushNotificationAllowed()
@Nullable NatPolicy getNatPolicy()
NatPolicy
object in use. Core.getNatPolicy()
void setNatPolicy(@Nullable NatPolicy policy)
policy
- NatPolicy
object. Core.setNatPolicy(org.linphone.core.NatPolicy)
int getPrivacy()
void setPrivacy(int privacy)
privacy
- Privacy
to configure privacy boolean publishEnabled()
void enablePublish(boolean enable)
ProxyConfig
. ProxyConfig
has been added to Core
, follows theedit()
rule. enable
- if true, publish will be engaged int getPublishExpires()
void setPublishExpires(int expires)
expires
- in second void setPushNotificationAllowed(boolean allow)
allow
- true to allow push notification information, false otherwise. @Nullable java.lang.String getQualityReportingCollector()
void setQualityReportingCollector(@Nullable java.lang.String collector)
collector
- route of the collector end-point, if null PUBLISH will be sentboolean qualityReportingEnabled()
void enableQualityReporting(boolean enable)
enable
- True to store quality statistics and send them to the collector,int getQualityReportingInterval()
void setQualityReportingInterval(int interval)
interval
- The interval in seconds, 0 means interval reports are disabled. @Nullable java.lang.String getRealm()
void setRealm(@Nullable java.lang.String realm)
realm
- New realm value. @Nullable java.lang.String getRefKey()
void setRefKey(@Nullable java.lang.String refkey)
refkey
- The reference key string to associate to the proxy config. boolean registerEnabled()
void enableRegister(boolean enable)
ProxyConfig
ProxyConfig
has been added to Core
, follows theedit()
rule. enable
- if true, registration will be engaged @Deprecated int setRoute(@Nullable java.lang.String route)
setRoutes(java.lang.String[])
instead Core.setDefaultProxyConfig(org.linphone.core.ProxyConfig)
). route
- the SIP route to set @NonNull java.lang.String[] getRoutes()
int setRoutes(@Nullable java.lang.String[] routes)
Core.setDefaultProxyConfig(org.linphone.core.ProxyConfig)
). routes
- A of routes @Nullable java.lang.String getServerAddr()
int setServerAddr(@Nullable java.lang.String serverAddress)
serverAddress
- the proxy address to set. RegistrationState getState()
RegistrationState
of the proxy config. @NonNull java.lang.String getTransport()
int getUnreadChatMessageCount()
int done()
void edit()
edit()
done()
to commit the changes. @Nullable AuthInfo findAuthInfo()
AuthInfo
matching proxy config criteria if possible, null if@Nullable java.lang.String getCustomHeader(@NonNull java.lang.String headerName)
headerName
- the header name for which to fetch corresponding value boolean isPhoneNumber(@NonNull java.lang.String username)
username
- string to parse. @Nullable java.lang.String normalizePhoneNumber(@NonNull java.lang.String username)
ProxyConfig
username
- the string to parse @Nullable Address normalizeSipUri(@NonNull java.lang.String username)
username
- the string to parse void pauseRegister()
refreshRegister()
. void refreshRegister()
void setCustomHeader(@NonNull java.lang.String headerName, @Nullable java.lang.String headerValue)
headerName
- the header name headerValue
- the header's value void setUserData(java.lang.Object data)
data
- the object to storejava.lang.Object getUserData()
long getNativePointer()
java.lang.String toString()
toString
in class java.lang.Object