ZDK
Public Member Functions | List of all members
ZDK::IAccountConfig Class Referenceabstract

General account configuration. More...

#include <IAccountConfig.h>

Inheritance diagram for ZDK::IAccountConfig:
ZDK::IZHandle

Public Member Functions

virtual ZDK::Shared::String UserName () const =0
 Gets the Account's username (SIP, IAX, XMPP, etc, depending on the Account Type) More...
 
virtual void UserName (ZDK::Shared::String value)=0
 Sets the Account's username (SIP, IAX, XMPP, etc, depending on the Account Type) More...
 
virtual ZDK::Shared::String Password () const =0
 Gets the Account's password (SIP, IAX, XMPP, etc, depending on the Account Type) More...
 
virtual void Password (ZDK::Shared::String value)=0
 Sets the Account's password (SIP, IAX, XMPP, etc, depending on the Account Type) More...
 
virtual ZDK::ProtocolType Type () const =0
 Gets the Account's type (SIP, IAX, XMPP, etc.) More...
 
virtual void Type (ZDK::ProtocolType value)=0
 Sets the Account's type (SIP, IAX, XMPP, etc.) More...
 
virtual int ReregistrationTime () const =0
 Get the Account's registration refresh time. More...
 
virtual void ReregistrationTime (int value)=0
 Set the Account's registration refresh time. More...
 
virtual ZDK::Shared::SIPConfig SIP ()=0
 Gets the SIP specific account configuration. More...
 
virtual void SIP (ZDK::Shared::SIPConfig value)=0
 Sets the SIP specific account configuration. More...
 
virtual ZDK::Shared::IAXConfig IAX ()=0
 Gets the IAX specific account configuration. More...
 
virtual void IAX (ZDK::Shared::IAXConfig value)=0
 Sets the IAX specific account configuration. More...
 
virtual ZDK::Shared::String DeviceGUID () const =0
 NOT USED! MIGHT BE REMOVED ANYTIME!
 
virtual void DeviceGUID (ZDK::Shared::String value)=0
 NOT USED! MIGHT BE REMOVED ANYTIME!
 
virtual ZDK::Shared::String RegistrationGUID () const =0
 NOT USED! MIGHT BE REMOVED ANYTIME!
 
virtual void RegistrationGUID (ZDK::Shared::String value)=0
 NOT USED! MIGHT BE REMOVED ANYTIME!
 
virtual bool EnableIPv6Detection () const =0
 NOT USED! MIGHT BE REMOVED ANYTIME! More...
 
virtual void EnableIPv6Detection (bool value)=0
 NOT USED! MIGHT BE REMOVED ANYTIME! More...
 
virtual bool IsEqual (ZDK::Shared::AccountConfig comp)=0
 Compares the current configuration with the given one. More...
 
- Public Member Functions inherited from ZDK::IZHandle
virtual ZDK::ZDKHandle Handle () const =0
 
virtual operator ZDK::ZDKHandle () const =0
 
virtual void Initialize ()=0
 
virtual void ReleaseReference ()=0
 

Detailed Description

General account configuration.

Member Function Documentation

◆ EnableIPv6Detection() [1/2]

virtual bool ZDK::IAccountConfig::EnableIPv6Detection ( ) const
pure virtual

NOT USED! MIGHT BE REMOVED ANYTIME!

IPv6 is is a global option and there are no plans making it configurable per account!

◆ EnableIPv6Detection() [2/2]

virtual void ZDK::IAccountConfig::EnableIPv6Detection ( bool  value)
pure virtual

NOT USED! MIGHT BE REMOVED ANYTIME!

IPv6 is is a global option and there are no plans making it configurable per account!

◆ IAX() [1/2]

virtual ZDK::Shared::IAXConfig ZDK::IAccountConfig::IAX ( )
pure virtual

Gets the IAX specific account configuration.

Gets the IAX specific account configuration that is used in case the Account's type is IAX. Note the IAX configuration is not used if the Account's type is not IAX!

Returns
The IAX configuration
See also
IIAXConfig, Type()

◆ IAX() [2/2]

virtual void ZDK::IAccountConfig::IAX ( ZDK::Shared::IAXConfig  value)
pure virtual

Sets the IAX specific account configuration.

Sets the IAX specific account configuration being used in case the Account's type is IAX. Note the IAX configuration is not used if the Account's type is not IAX!

Parameters
[in]valueThe IAX configuration
See also
IIAXConfig, Type()

◆ IsEqual()

virtual bool ZDK::IAccountConfig::IsEqual ( ZDK::Shared::AccountConfig  comp)
pure virtual

Compares the current configuration with the given one.

Parameters
[in]compAccount configuration to be compared
Returns
  • 0 - not equal
  • 1 - equal

◆ Password() [1/2]

virtual ZDK::Shared::String ZDK::IAccountConfig::Password ( ) const
pure virtual

Gets the Account's password (SIP, IAX, XMPP, etc, depending on the Account Type)

Returns
The Account's password
See also
Type()

◆ Password() [2/2]

virtual void ZDK::IAccountConfig::Password ( ZDK::Shared::String  value)
pure virtual

Sets the Account's password (SIP, IAX, XMPP, etc, depending on the Account Type)

Parameters
[in]valueThe Account's password
See also
Type()

◆ ReregistrationTime() [1/2]

virtual int ZDK::IAccountConfig::ReregistrationTime ( ) const
pure virtual

Get the Account's registration refresh time.

Gets the desired registration refresh period in seconds. Note that the server might enforce different (shorter) refresh time. The stack will not wait for the full period to refresh the registration. It will try to refresh it after 90% of the negotiated time has elapsed.

Returns
The registration refresh period in seconds

◆ ReregistrationTime() [2/2]

virtual void ZDK::IAccountConfig::ReregistrationTime ( int  value)
pure virtual

Set the Account's registration refresh time.

Sets the desired registration refresh period in seconds. Note that the server might enforce different (shorter) refresh time. The stack will not wait for the full period to refresh the registration. It will try to refresh it after 90% of the negotiated time has elapsed.

Parameters
[in]valueThe registration refresh period in seconds

◆ SIP() [1/2]

virtual ZDK::Shared::SIPConfig ZDK::IAccountConfig::SIP ( )
pure virtual

Gets the SIP specific account configuration.

Gets the SIP specific account configuration that is used in case the Account's type is SIP. Note the SIP configuration is not used if the Account's type is not SIP!

Returns
The SIP configuration
See also
SIPConfig, Type()

◆ SIP() [2/2]

virtual void ZDK::IAccountConfig::SIP ( ZDK::Shared::SIPConfig  value)
pure virtual

Sets the SIP specific account configuration.

Sets the SIP specific account configuration being used in case the Account's type is SIP. Note the SIP configuration is not used if the Account's type is not SIP!

Parameters
[in]valueThe SIP configuration
See also
SIPConfig, Type()

◆ Type() [1/2]

virtual ZDK::ProtocolType ZDK::IAccountConfig::Type ( ) const
pure virtual

Gets the Account's type (SIP, IAX, XMPP, etc.)

Returns
The Account's type
See also
ProtocolType

◆ Type() [2/2]

virtual void ZDK::IAccountConfig::Type ( ZDK::ProtocolType  value)
pure virtual

Sets the Account's type (SIP, IAX, XMPP, etc.)

Parameters
[in]valueThe Account's type
See also
ProtocolType

◆ UserName() [1/2]

virtual ZDK::Shared::String ZDK::IAccountConfig::UserName ( ) const
pure virtual

Gets the Account's username (SIP, IAX, XMPP, etc, depending on the Account Type)

Returns
The Account's username
See also
Type()

◆ UserName() [2/2]

virtual void ZDK::IAccountConfig::UserName ( ZDK::Shared::String  value)
pure virtual

Sets the Account's username (SIP, IAX, XMPP, etc, depending on the Account Type)

Parameters
[in]valueThe Account's username
See also
Type()

The documentation for this class was generated from the following file: