public interface AccountParams
Modifier and Type | Method and Description |
---|---|
AccountParams |
clone()
Instantiate a new account params with values from source.
|
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.
|
java.lang.String |
getContactParameters()
Returns the contact parameters.
|
java.lang.String |
getContactUriParameters()
Return the contact URI parameters.
|
java.lang.String |
getDomain()
Get the domain name of the given account params.
|
int |
getExpires()
Get the account params expires.
|
java.lang.String |
getIdentity()
Deprecated.
01/03/2021 Use
getIdentityAddress() instead. |
Address |
getIdentityAddress()
Get the identity address of the account params.
|
java.lang.String |
getIdkey()
Get the idkey property of a
AccountParams . |
java.lang.String |
getInternationalPrefix()
Get the prefix set for this account params.
|
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
account params. |
int |
getPrivacy()
Get default privacy policy for all calls routed through this proxy.
|
int |
getPublishExpires()
Get the publish expiration time in second.
|
boolean |
getPushNotificationAllowed()
Indicates whether to add to the contact parameters the push notification
information. |
PushNotificationConfig |
getPushNotificationConfig()
Returns the push notification configuration.
|
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 account params.
|
java.lang.String |
getRefKey()
Get the persistent reference key associated to the account params.
|
boolean |
getRemotePushNotificationAllowed()
Indicates whether to add to the contact parameters the push notification
information. |
Address[] |
getRoutesAddresses()
Gets the list of the routes set for this account params.
|
java.lang.String |
getServerAddr()
Deprecated.
01/03/2021 Use
getServerAddress() instead. |
Address |
getServerAddress()
Get the account params proxy address.
|
TransportType |
getTransport()
Returns the transport type of the server address.
|
boolean |
getUseInternationalPrefixForCallsAndChats()
Return whether or not the international prefix will automaticaly be used for
calls and chats. |
java.lang.Object |
getUserData()
Gets the object stored in this object user's data
|
boolean |
isCpimInBasicChatRoomEnabled()
Indicates whether chat messages sent by this account in a
ChatRoomBackend.Basic chat room will be using CPIM format or not. |
boolean |
isDialEscapePlusEnabled()
Return whether or not the + should be replaced by 00.
|
boolean |
isOutboundProxyEnabled()
Tell if the proxy is used as the only route.
|
boolean |
isPublishEnabled()
Tell if the PUBLISH is enabled.
|
boolean |
isPushNotificationAvailable()
Gets whether push notifications are available or not (Android & iOS only).
|
boolean |
isQualityReportingEnabled()
Indicates whether quality statistics during call should be stored and sent to a
collector according to RFC 6035. |
boolean |
isRegisterEnabled()
Returns whether the account params is enabled or not.
|
AccountParams |
newWithConfig(Core lc,
int index)
Create a new
AccountParams object from a configuration. |
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 |
setCpimInBasicChatRoomEnabled(boolean enable)
Indicates whether chat messages sent by this account in a
ChatRoomBackend.Basic chat room will be using CPIM format or not. |
void |
setDialEscapePlusEnabled(boolean enable)
Set whether liblinphone should replace "+" by international calling prefix in
dialed numbers (passed to linphone_core_invite). |
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 account params.
|
void |
setInternationalPrefix(java.lang.String prefix)
Set an international prefix to be automatically prepended when inviting a
number with Core.invite(java.lang.String) ; This international prefix shall usually be thecountry code of the country where the user is living, without "+". |
void |
setNatPolicy(NatPolicy policy)
Set the policy to use to pass through NATs/firewalls when using this account
params. |
void |
setOutboundProxyEnabled(boolean enable)
If enabled, the proxy will be used as the only route.
|
void |
setPrivacy(int privacy)
Set default privacy policy for all calls routed through this proxy.
|
void |
setPublishEnabled(boolean enable)
Indicates either or not, PUBLISH must be issued for this
AccountParams . |
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 |
setPushNotificationConfig(PushNotificationConfig config)
Sets the push notification configuration.
|
void |
setQualityReportingCollector(java.lang.String collector)
Set the route of the collector end-point when using quality reporting.
|
void |
setQualityReportingEnabled(boolean enable)
Indicates whether quality statistics during call should be stored and sent to a
collector according to RFC 6035. |
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 account params.
|
void |
setRefKey(java.lang.String refkey)
Associate a persistent reference key to the account params.
|
void |
setRegisterEnabled(boolean enable)
Indicates either or not, REGISTRATION must be issued for this
AccountParams . |
void |
setRemotePushNotificationAllowed(boolean allow)
Indicates whether to add to the contact parameters the push notification
information. |
int |
setRoutesAddresses(Address[] routes)
Sets a list of SIP route.
|
int |
setServerAddr(java.lang.String serverAddress)
Deprecated.
01/03/2021 Use
setServerAddress(org.linphone.core.Address) instead. |
int |
setServerAddress(Address serverAddress)
Sets the proxy address.
|
void |
setTransport(TransportType transport)
Sets the transport type of the server address.
|
void |
setUseInternationalPrefixForCallsAndChats(boolean enable)
If enabled, the international prefix will automaticaly be used for calls and
chats. |
void |
setUserData(java.lang.Object data)
Sets the object to store in this object user's data
|
java.lang.String |
toString() |
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 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 textboolean isCpimInBasicChatRoomEnabled()
ChatRoomBackend.Basic
ChatRoomBackend.FlexisipChat
chat rooms. see:void setCpimInBasicChatRoomEnabled(boolean enable)
ChatRoomBackend.Basic
enable
- true to send messages in CPIM format, false to keep using the SIPboolean isDialEscapePlusEnabled()
Core.invite(java.lang.String)
). void setDialEscapePlusEnabled(boolean enable)
enable
- true to replace + by the international prefix, false otherwise. @Nullable java.lang.String getDomain()
int getExpires()
void setExpires(int expires)
expires
- The expiration time to set. @Deprecated @Nullable java.lang.String getIdentity()
getIdentityAddress()
instead. @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 AccountParams
. @Nullable java.lang.String getInternationalPrefix()
void setInternationalPrefix(@Nullable java.lang.String prefix)
Core.invite(java.lang.String)
; This international prefix shall usually be theprefix
- The prefix to set (withouth the +). boolean isPushNotificationAvailable()
@Nullable NatPolicy getNatPolicy()
NatPolicy
object in use. Core.getNatPolicy()
void setNatPolicy(@Nullable NatPolicy policy)
policy
- The NatPolicy
object. Core.setNatPolicy(org.linphone.core.NatPolicy)
boolean isOutboundProxyEnabled()
void setOutboundProxyEnabled(boolean enable)
enable
- true to enable, false otherwise. int getPrivacy()
void setPrivacy(int privacy)
privacy
- Privacy
to configure privacy boolean isPublishEnabled()
void setPublishEnabled(boolean enable)
enable
- If true, publish will be engaged. int getPublishExpires()
void setPublishExpires(int expires)
expires
- The expire time in seconds. boolean getPushNotificationAllowed()
void setPushNotificationAllowed(boolean allow)
allow
- true to allow push notification information, false otherwise. @NonNull PushNotificationConfig getPushNotificationConfig()
PushNotificationConfig
object. void setPushNotificationConfig(@NonNull PushNotificationConfig config)
config
- The PushNotificationConfig
object. @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 isQualityReportingEnabled()
void setQualityReportingEnabled(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 account params. boolean isRegisterEnabled()
void setRegisterEnabled(boolean enable)
enable
- If true, registration will be engaged. boolean getRemotePushNotificationAllowed()
void setRemotePushNotificationAllowed(boolean allow)
allow
- true to allow remote push notification information, false@NonNull Address[] getRoutesAddresses()
int setRoutesAddresses(@Nullable Address[] routes)
Core.setDefaultAccount(org.linphone.core.Account)
).routes
- A list of routes. @Deprecated @Nullable java.lang.String getServerAddr()
getServerAddress()
instead. @Deprecated int setServerAddr(@Nullable java.lang.String serverAddress)
setServerAddress(org.linphone.core.Address)
instead. serverAddress
- The proxy address to set. @Nullable Address getServerAddress()
Address
. int setServerAddress(@Nullable Address serverAddress)
serverAddress
- The proxy as Address
to set. TransportType getTransport()
TransportType
of the server address. void setTransport(TransportType transport)
transport
- The TransportType
to set. boolean getUseInternationalPrefixForCallsAndChats()
void setUseInternationalPrefixForCallsAndChats(boolean enable)
enable
- true to use the international prefix for calls, false otherwise. @NonNull AccountParams clone()
AccountParams
object. @NonNull AccountParams newWithConfig(@NonNull Core lc, int index)
lc
- The Core
object. index
- The index of the configuration. AccountParams
object. 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