Liblinphone 5.0.0
|
Object that is used to set the different parameters of a Account. More...
#include <account_params.hh>
Public Member Functions | |
AccountParams (void *ptr, bool takeRef=true) | |
LINPHONECXX_PUBLIC _LinphoneAccountParams * | cPtr () |
LINPHONECXX_PUBLIC linphone::AVPFMode | getAvpfMode () const |
Get enablement status of RTCP feedback (also known as AVPF profile). More... | |
LINPHONECXX_PUBLIC void | setAvpfMode (linphone::AVPFMode mode) |
Enable the use of RTCP feedback (also known as AVPF profile). More... | |
LINPHONECXX_PUBLIC uint8_t | getAvpfRrInterval () const |
Get the interval between regular RTCP reports when using AVPF/SAVPF. More... | |
LINPHONECXX_PUBLIC void | setAvpfRrInterval (uint8_t interval) |
Set the interval between regular RTCP reports when using AVPF/SAVPF. More... | |
LINPHONECXX_PUBLIC std::string | getConferenceFactoryUri () const |
Get the conference factory uri. More... | |
LINPHONECXX_PUBLIC void | setConferenceFactoryUri (const std::string &uri) |
Set the conference factory uri. More... | |
LINPHONECXX_PUBLIC std::string | getContactParameters () const |
Returns the contact parameters. More... | |
LINPHONECXX_PUBLIC void | setContactParameters (const std::string &contactParams) |
Set optional contact parameters that will be added to the contact information sent in the registration. More... | |
LINPHONECXX_PUBLIC std::string | getContactUriParameters () const |
Return the contact URI parameters. More... | |
LINPHONECXX_PUBLIC void | setContactUriParameters (const std::string &contactUriParams) |
Set optional contact parameters that will be added to the contact information sent in the registration, inside the URI. More... | |
LINPHONECXX_PUBLIC bool | getDialEscapePlusEnabled () const |
Return whether or not the + should be replaced by 00. More... | |
LINPHONECXX_PUBLIC void | setDialEscapePlusEnabled (bool enable) |
Set whether liblinphone should replace "+" by international calling prefix in dialed numbers (passed to linphone_core_invite). More... | |
LINPHONECXX_PUBLIC std::string | getDomain () const |
Get the domain name of the given account params. More... | |
LINPHONECXX_PUBLIC int | getExpires () const |
Get the account params expires. More... | |
LINPHONECXX_PUBLIC void | setExpires (int expires) |
Sets the registration expiration time in seconds. More... | |
LINPHONECXX_PUBLIC LINPHONECXX_DEPRECATED std::string | getIdentity () const |
Get the identity of the account params. More... | |
LINPHONECXX_PUBLIC std::shared_ptr< const linphone::Address > | getIdentityAddress () const |
Get the identity address of the account params. More... | |
LINPHONECXX_PUBLIC linphone::Status | setIdentityAddress (const std::shared_ptr< const linphone::Address > &identity) |
Sets the user identity as a SIP address. More... | |
LINPHONECXX_PUBLIC std::string | getIdkey () const |
Get the idkey property of a AccountParams. More... | |
LINPHONECXX_PUBLIC void | setIdkey (const std::string &idkey) |
Set the idkey property on the given account params. More... | |
LINPHONECXX_PUBLIC std::string | getInternationalPrefix () const |
Get the prefix set for this account params. More... | |
LINPHONECXX_PUBLIC void | setInternationalPrefix (const std::string &prefix) |
Set an international prefix to be automatically prepended when inviting a number with Core::invite(); This international prefix shall usually be the country code of the country where the user is living, without "+". More... | |
LINPHONECXX_PUBLIC bool | isPushNotificationAvailable () const |
Gets whether push notifications are available or not (Android & iOS only). More... | |
LINPHONECXX_PUBLIC std::shared_ptr< linphone::NatPolicy > | getNatPolicy () const |
Get The policy that is used to pass through NATs/firewalls when using this account params. More... | |
LINPHONECXX_PUBLIC void | setNatPolicy (const std::shared_ptr< linphone::NatPolicy > &policy) |
Set the policy to use to pass through NATs/firewalls when using this account params. More... | |
LINPHONECXX_PUBLIC bool | getOutboundProxyEnabled () const |
Tell if the proxy is used as the only route. More... | |
LINPHONECXX_PUBLIC void | setOutboundProxyEnabled (bool enable) |
If enabled, the proxy will be used as the only route. More... | |
LINPHONECXX_PUBLIC unsigned int | getPrivacy () const |
Get default privacy policy for all calls routed through this proxy. More... | |
LINPHONECXX_PUBLIC void | setPrivacy (unsigned int privacy) |
Set default privacy policy for all calls routed through this proxy. More... | |
LINPHONECXX_PUBLIC bool | getPublishEnabled () const |
Tell if the PUBLISH is enabled. More... | |
LINPHONECXX_PUBLIC void | setPublishEnabled (bool enable) |
Indicates either or not, PUBLISH must be issued for this AccountParams. More... | |
LINPHONECXX_PUBLIC int | getPublishExpires () const |
Get the publish expiration time in second. More... | |
LINPHONECXX_PUBLIC void | setPublishExpires (int expires) |
Set the publish expiration time in second. More... | |
LINPHONECXX_PUBLIC bool | getPushNotificationAllowed () const |
Indicates whether to add to the contact parameters the push notification information. More... | |
LINPHONECXX_PUBLIC void | setPushNotificationAllowed (bool allow) |
Indicates whether to add to the contact parameters the push notification information. More... | |
LINPHONECXX_PUBLIC std::shared_ptr< linphone::PushNotificationConfig > | getPushNotificationConfig () const |
Returns the push notification configuration. More... | |
LINPHONECXX_PUBLIC void | setPushNotificationConfig (const std::shared_ptr< linphone::PushNotificationConfig > &config) |
Sets the push notification configuration. More... | |
LINPHONECXX_PUBLIC std::string | getQualityReportingCollector () const |
Get the route of the collector end-point when using quality reporting. More... | |
LINPHONECXX_PUBLIC void | setQualityReportingCollector (const std::string &collector) |
Set the route of the collector end-point when using quality reporting. More... | |
LINPHONECXX_PUBLIC bool | getQualityReportingEnabled () const |
Indicates whether quality statistics during call should be stored and sent to a collector according to RFC 6035. More... | |
LINPHONECXX_PUBLIC void | setQualityReportingEnabled (bool enable) |
Indicates whether quality statistics during call should be stored and sent to a collector according to RFC 6035. More... | |
LINPHONECXX_PUBLIC int | getQualityReportingInterval () const |
Get the interval between interval reports when using quality reporting. More... | |
LINPHONECXX_PUBLIC void | setQualityReportingInterval (int interval) |
Set the interval between 2 interval reports sending when using quality reporting. More... | |
LINPHONECXX_PUBLIC std::string | getRealm () const |
Get the realm of the given account params. More... | |
LINPHONECXX_PUBLIC void | setRealm (const std::string &realm) |
Set the realm of the given account params. More... | |
LINPHONECXX_PUBLIC std::string | getRefKey () const |
Get the persistent reference key associated to the account params. More... | |
LINPHONECXX_PUBLIC void | setRefKey (const std::string &refkey) |
Associate a persistent reference key to the account params. More... | |
LINPHONECXX_PUBLIC bool | getRegisterEnabled () const |
Returns whether the account params is enabled or not. More... | |
LINPHONECXX_PUBLIC void | setRegisterEnabled (bool enable) |
Indicates either or not, REGISTRATION must be issued for this AccountParams. More... | |
LINPHONECXX_PUBLIC bool | getRemotePushNotificationAllowed () const |
Indicates whether to add to the contact parameters the push notification information. More... | |
LINPHONECXX_PUBLIC void | setRemotePushNotificationAllowed (bool allow) |
Indicates whether to add to the contact parameters the push notification information. More... | |
LINPHONECXX_PUBLIC std::list< std::shared_ptr< linphone::Address > > | getRoutesAddresses () const |
Gets the list of the routes set for this account params. More... | |
LINPHONECXX_PUBLIC linphone::Status | setRoutesAddresses (const std::list< std::shared_ptr< linphone::Address > > &routes) |
Sets a list of SIP route. More... | |
LINPHONECXX_PUBLIC LINPHONECXX_DEPRECATED std::string | getServerAddr () const |
Get the account params proxy address. More... | |
LINPHONECXX_PUBLIC LINPHONECXX_DEPRECATED linphone::Status | setServerAddr (const std::string &serverAddress) |
Sets the proxy address. More... | |
LINPHONECXX_PUBLIC std::shared_ptr< const linphone::Address > | getServerAddress () const |
Get the account params proxy address. More... | |
LINPHONECXX_PUBLIC linphone::Status | setServerAddress (const std::shared_ptr< const linphone::Address > &serverAddress) |
Sets the proxy address. More... | |
LINPHONECXX_PUBLIC linphone::TransportType | getTransport () const |
Returns the transport type of the server address. More... | |
LINPHONECXX_PUBLIC void | setTransport (linphone::TransportType transport) |
Sets the transport type of the server address. More... | |
LINPHONECXX_PUBLIC bool | getUseInternationalPrefixForCallsAndChats () const |
Return whether or not the international prefix will automaticaly be used for calls and chats. More... | |
LINPHONECXX_PUBLIC void | setUseInternationalPrefixForCallsAndChats (bool enable) |
If enabled, the international prefix will automaticaly be used for calls and chats. More... | |
LINPHONECXX_PUBLIC std::shared_ptr< linphone::AccountParams > | clone () const |
Instantiate a new account params with values from source. More... | |
Static Public Member Functions | |
static LINPHONECXX_PUBLIC std::shared_ptr< linphone::AccountParams > | newWithConfig (const std::shared_ptr< linphone::Core > &lc, int index) |
Create a new AccountParams object from a configuration. More... | |
Object that is used to set the different parameters of a Account.
LINPHONECXX_PUBLIC std::shared_ptr< linphone::AccountParams > linphone::AccountParams::clone | ( | ) | const |
Instantiate a new account params with values from source.
LINPHONECXX_PUBLIC linphone::AVPFMode linphone::AccountParams::getAvpfMode | ( | ) | const |
Get enablement status of RTCP feedback (also known as AVPF profile).
LINPHONECXX_PUBLIC uint8_t linphone::AccountParams::getAvpfRrInterval | ( | ) | const |
Get the interval between regular RTCP reports when using AVPF/SAVPF.
LINPHONECXX_PUBLIC std::string linphone::AccountParams::getConferenceFactoryUri | ( | ) | const |
Get the conference factory uri.
LINPHONECXX_PUBLIC std::string linphone::AccountParams::getContactParameters | ( | ) | const |
Returns the contact parameters.
LINPHONECXX_PUBLIC std::string linphone::AccountParams::getContactUriParameters | ( | ) | const |
Return the contact URI parameters.
LINPHONECXX_PUBLIC bool linphone::AccountParams::getDialEscapePlusEnabled | ( | ) | const |
Return whether or not the + should be replaced by 00.
LINPHONECXX_PUBLIC std::string linphone::AccountParams::getDomain | ( | ) | const |
Get the domain name of the given account params.
LINPHONECXX_PUBLIC int linphone::AccountParams::getExpires | ( | ) | const |
Get the account params expires.
LINPHONECXX_PUBLIC LINPHONECXX_DEPRECATED std::string linphone::AccountParams::getIdentity | ( | ) | const |
Get the identity of the account params.
LINPHONECXX_PUBLIC std::shared_ptr< const linphone::Address > linphone::AccountParams::getIdentityAddress | ( | ) | const |
Get the identity address of the account params.
LINPHONECXX_PUBLIC std::string linphone::AccountParams::getIdkey | ( | ) | const |
Get the idkey property of a AccountParams.
LINPHONECXX_PUBLIC std::string linphone::AccountParams::getInternationalPrefix | ( | ) | const |
Get the prefix set for this account params.
LINPHONECXX_PUBLIC std::shared_ptr< linphone::NatPolicy > linphone::AccountParams::getNatPolicy | ( | ) | const |
Get The policy that is used to pass through NATs/firewalls when using this account params.
If it is set to nullptr, the default NAT policy from the core will be used instead.
LINPHONECXX_PUBLIC bool linphone::AccountParams::getOutboundProxyEnabled | ( | ) | const |
Tell if the proxy is used as the only route.
LINPHONECXX_PUBLIC unsigned int linphone::AccountParams::getPrivacy | ( | ) | const |
Get default privacy policy for all calls routed through this proxy.
LINPHONECXX_PUBLIC bool linphone::AccountParams::getPublishEnabled | ( | ) | const |
Tell if the PUBLISH is enabled.
LINPHONECXX_PUBLIC int linphone::AccountParams::getPublishExpires | ( | ) | const |
Get the publish expiration time in second.
Default value is the registration expiration value.
LINPHONECXX_PUBLIC bool linphone::AccountParams::getPushNotificationAllowed | ( | ) | const |
Indicates whether to add to the contact parameters the push notification information.
For IOS, it indicates for VOIP push notification.
LINPHONECXX_PUBLIC std::shared_ptr< linphone::PushNotificationConfig > linphone::AccountParams::getPushNotificationConfig | ( | ) | const |
Returns the push notification configuration.
LINPHONECXX_PUBLIC std::string linphone::AccountParams::getQualityReportingCollector | ( | ) | const |
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 nullptr, reports will be send to the proxy domain.
LINPHONECXX_PUBLIC bool linphone::AccountParams::getQualityReportingEnabled | ( | ) | const |
Indicates whether quality statistics during call should be stored and sent to a collector according to RFC 6035.
LINPHONECXX_PUBLIC int linphone::AccountParams::getQualityReportingInterval | ( | ) | const |
Get the interval between interval reports when using quality reporting.
LINPHONECXX_PUBLIC std::string linphone::AccountParams::getRealm | ( | ) | const |
Get the realm of the given account params.
LINPHONECXX_PUBLIC std::string linphone::AccountParams::getRefKey | ( | ) | const |
Get the persistent reference key associated to the account params.
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.
LINPHONECXX_PUBLIC bool linphone::AccountParams::getRegisterEnabled | ( | ) | const |
Returns whether the account params is enabled or not.
LINPHONECXX_PUBLIC bool linphone::AccountParams::getRemotePushNotificationAllowed | ( | ) | const |
Indicates whether to add to the contact parameters the push notification information.
LINPHONECXX_PUBLIC std::list< std::shared_ptr< linphone::Address > > linphone::AccountParams::getRoutesAddresses | ( | ) | const |
Gets the list of the routes set for this account params.
LINPHONECXX_PUBLIC LINPHONECXX_DEPRECATED std::string linphone::AccountParams::getServerAddr | ( | ) | const |
Get the account params proxy address.
LINPHONECXX_PUBLIC std::shared_ptr< const linphone::Address > linphone::AccountParams::getServerAddress | ( | ) | const |
Get the account params proxy address.
LINPHONECXX_PUBLIC linphone::TransportType linphone::AccountParams::getTransport | ( | ) | const |
Returns the transport type of the server address.
LINPHONECXX_PUBLIC bool linphone::AccountParams::getUseInternationalPrefixForCallsAndChats | ( | ) | const |
Return whether or not the international prefix will automaticaly be used for calls and chats.
LINPHONECXX_PUBLIC bool linphone::AccountParams::isPushNotificationAvailable | ( | ) | const |
Gets whether push notifications are available or not (Android & iOS only).
|
static |
Create a new AccountParams object from a configuration.
index | The index of the configuration. |
LINPHONECXX_PUBLIC void linphone::AccountParams::setAvpfMode | ( | linphone::AVPFMode | mode | ) |
Enable the use of RTCP feedback (also known as AVPF profile).
mode | the enablement mode, which can be AVPFMode::Default (use LinphoneCore's mode), AVPFMode::Enabled (avpf is enabled), or AVPFMode::Disabled (disabled). |
LINPHONECXX_PUBLIC void linphone::AccountParams::setAvpfRrInterval | ( | uint8_t | interval | ) |
Set the interval between regular RTCP reports when using AVPF/SAVPF.
interval | The interval in seconds (between 0 and 5 seconds). |
LINPHONECXX_PUBLIC void linphone::AccountParams::setConferenceFactoryUri | ( | const std::string & | uri | ) |
Set the conference factory uri.
uri | The uri of the conference factory. |
LINPHONECXX_PUBLIC void linphone::AccountParams::setContactParameters | ( | const std::string & | contactParams | ) |
Set optional contact parameters that will be added to the contact information sent in the registration.
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@1.nosp@m.5.12.nosp@m.8.128.nosp@m..93:50421>;apple-push-id=43143-DFE23F-2323-FA2232. |
LINPHONECXX_PUBLIC void linphone::AccountParams::setContactUriParameters | ( | const std::string & | contactUriParams | ) |
Set optional contact parameters that will be added to the contact information sent in the registration, inside the URI.
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@1.nosp@m.5.12.nosp@m.8.128.nosp@m..93:50421;apple-push-id=43143-DFE23F-2323-FA2232>. |
LINPHONECXX_PUBLIC void linphone::AccountParams::setDialEscapePlusEnabled | ( | bool | enable | ) |
Set whether liblinphone should replace "+" by international calling prefix in dialed numbers (passed to linphone_core_invite).
enable | true to replace + by the international prefix, false otherwise. |
LINPHONECXX_PUBLIC void linphone::AccountParams::setExpires | ( | int | expires | ) |
Sets the registration expiration time in seconds.
expires | The expiration time to set. |
LINPHONECXX_PUBLIC linphone::Status linphone::AccountParams::setIdentityAddress | ( | const std::shared_ptr< const linphone::Address > & | identity | ) |
Sets the user identity as a SIP address.
This identity is normally formed with display name, username and domain, such as: Alice <sip:alice.nosp@m.@exa.nosp@m.mple..nosp@m.net> The REGISTER messages will have from and to set to this identity.
identity | The Address of the identity to set. |
LINPHONECXX_PUBLIC void linphone::AccountParams::setIdkey | ( | const std::string & | idkey | ) |
Set the idkey property on the given account params.
This property can the be referenced by another account params 'depends_on' to create a dependency relation between them.
idkey | The idkey string to associate to the given AccountParams. |
LINPHONECXX_PUBLIC void linphone::AccountParams::setInternationalPrefix | ( | const std::string & | prefix | ) |
Set an international prefix to be automatically prepended when inviting a number with Core::invite(); This international prefix shall usually be the country code of the country where the user is living, without "+".
prefix | The prefix to set (withouth the +). |
LINPHONECXX_PUBLIC void linphone::AccountParams::setNatPolicy | ( | const std::shared_ptr< linphone::NatPolicy > & | policy | ) |
Set the policy to use to pass through NATs/firewalls when using this account params.
If it is set to nullptr, the default NAT policy from the core will be used instead.
policy | The NatPolicy object. |
LINPHONECXX_PUBLIC void linphone::AccountParams::setOutboundProxyEnabled | ( | bool | enable | ) |
If enabled, the proxy will be used as the only route.
enable | true to enable, false otherwise. |
LINPHONECXX_PUBLIC void linphone::AccountParams::setPrivacy | ( | unsigned int | privacy | ) |
Set default privacy policy for all calls routed through this proxy.
privacy | Privacy to configure privacy |
LINPHONECXX_PUBLIC void linphone::AccountParams::setPublishEnabled | ( | bool | enable | ) |
Indicates either or not, PUBLISH must be issued for this AccountParams.
enable | If true, publish will be engaged. |
LINPHONECXX_PUBLIC void linphone::AccountParams::setPublishExpires | ( | int | expires | ) |
Set the publish expiration time in second.
expires | The expire time in seconds. |
LINPHONECXX_PUBLIC void linphone::AccountParams::setPushNotificationAllowed | ( | bool | allow | ) |
Indicates whether to add to the contact parameters the push notification information.
For IOS, it indicates for VOIP push notification.
allow | true to allow push notification information, false otherwise. |
LINPHONECXX_PUBLIC void linphone::AccountParams::setPushNotificationConfig | ( | const std::shared_ptr< linphone::PushNotificationConfig > & | config | ) |
Sets the push notification configuration.
config | The PushNotificationConfig object. |
LINPHONECXX_PUBLIC void linphone::AccountParams::setQualityReportingCollector | ( | const std::string & | collector | ) |
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 nullptr, reports will be send to the proxy domain.
collector | route of the collector end-point, if nullptr PUBLISH will be sent to the proxy domain. |
LINPHONECXX_PUBLIC void linphone::AccountParams::setQualityReportingEnabled | ( | bool | enable | ) |
Indicates whether quality statistics during call should be stored and sent to a collector according to RFC 6035.
enable | true to store quality statistics and send them to the collector, false to disable it. |
LINPHONECXX_PUBLIC void linphone::AccountParams::setQualityReportingInterval | ( | int | interval | ) |
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.
interval | The interval in seconds, 0 means interval reports are disabled. |
LINPHONECXX_PUBLIC void linphone::AccountParams::setRealm | ( | const std::string & | realm | ) |
Set the realm of the given account params.
realm | New realm value. |
LINPHONECXX_PUBLIC void linphone::AccountParams::setRefKey | ( | const std::string & | refkey | ) |
Associate a persistent reference key to the account params.
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.
refkey | The reference key string to associate to the account params. |
LINPHONECXX_PUBLIC void linphone::AccountParams::setRegisterEnabled | ( | bool | enable | ) |
Indicates either or not, REGISTRATION must be issued for this AccountParams.
enable | If true, registration will be engaged. |
LINPHONECXX_PUBLIC void linphone::AccountParams::setRemotePushNotificationAllowed | ( | bool | allow | ) |
Indicates whether to add to the contact parameters the push notification information.
allow | true to allow remote push notification information, false otherwise. |
LINPHONECXX_PUBLIC linphone::Status linphone::AccountParams::setRoutesAddresses | ( | const std::list< std::shared_ptr< linphone::Address > > & | routes | ) |
Sets a list of SIP route.
When a route is set, all outgoing calls will go to the route's destination if this account is the default one (see Core::setDefaultAccount()).
routes | A list of routes. |
LINPHONECXX_PUBLIC LINPHONECXX_DEPRECATED linphone::Status linphone::AccountParams::setServerAddr | ( | const std::string & | serverAddress | ) |
Sets the proxy address.
Examples of valid sip proxy address are:
serverAddress | The proxy address to set. |
LINPHONECXX_PUBLIC linphone::Status linphone::AccountParams::setServerAddress | ( | const std::shared_ptr< const linphone::Address > & | serverAddress | ) |
Sets the proxy address.
Examples of valid sip proxy address are:
serverAddress | The proxy as Address to set. |
LINPHONECXX_PUBLIC void linphone::AccountParams::setTransport | ( | linphone::TransportType | transport | ) |
Sets the transport type of the server address.
transport | The TransportType to set. |
LINPHONECXX_PUBLIC void linphone::AccountParams::setUseInternationalPrefixForCallsAndChats | ( | bool | enable | ) |
If enabled, the international prefix will automaticaly be used for calls and chats.
enable | true to use the international prefix for calls, false otherwise. |