ZDK_NET::AccountConfig Class Reference

General account configuration. More...

#include <AccountConfig.h>

Inheritance diagram for ZDK_NET::AccountConfig:

Public Member Functions
	AccountConfig (ZDK::Shared::AccountConfig src)
bool	IsEqual (ZDK_NET::AccountConfig^ comp)
	Compares the current configuration with the given one. More...
virtual long long	Handle () override
virtual void	Initialize () override
virtual void	ReleaseReference () override

Public Attributes
ZDK::IAccountConfig *	cppRef = nullptr

Properties
System::String^	UserName [get, set]
	Sets the Account's username (SIP, IAX, XMPP, etc, depending on the Account Type) More...
System::String^	Password [get, set]
	Sets the Account's password (SIP, IAX, XMPP, etc, depending on the Account Type) More...
ZDK_NET::ProtocolType	Type [get, set]
	Sets the Account's type (SIP, IAX, XMPP, etc.) More...
int	ReregistrationTime [get, set]
	Set the Account's registration refresh time. More...
ZDK_NET::SIPConfig^	SIP [get, set]
	Sets the SIP specific account configuration. More...
ZDK_NET::IAXConfig^	IAX [get, set]
	Sets the IAX specific account configuration. More...
System::String^	DeviceGUID [get, set]
	Sets per account Device GUID. More...
System::String^	RegistrationGUID [get, set]
	Sets per account Registration GUID. More...
bool	EnableIPv6Detection [get, set]
	NOT USED! MIGHT BE REMOVED ANYTIME! More...
ZDK_NET::DTMFType	DTMFBand [get, set]
	Selects the DTMF band for the user. More...
ZDK_NET::AudioOutputDeviceType	DTMFAutoplayDevice [get, set]
	Automatically play DTMF sounds to the user. More...

Detailed Description

General account configuration.

Member Function Documentation

IsEqual()

bool ZDK_NET::AccountConfig::IsEqual

(

ZDK_NET::AccountConfig^

comp

)

Compares the current configuration with the given one.

Parameters

[in]

comp

Account configuration to be compared

Returns

• 0 - not equal
• 1 - equal

Property Documentation

DeviceGUID

System:: String^ ZDK_NET::AccountConfig::DeviceGUID

getset

Sets per account Device GUID.

!!!NOTE!!! NOT used internally!

Parameters

[in]

value

The account's Device GUID

DTMFAutoplayDevice

ZDK_NET:: AudioOutputDeviceType ZDK_NET::AccountConfig::DTMFAutoplayDevice

getset

Automatically play DTMF sounds to the user.

Controls whether to automatically play the DTMF sounds to the user when sending DTMFs with Call::SendDTMF().

The default behaviour is to not play anything (ZDK::AudioOutputDeviceType::Disable).

Parameters

[in]

value

The DTMF autoplay device

See also

Call::SendDTMF(), AudioOutputDeviceType

DTMFBand

ZDK_NET:: DTMFType ZDK_NET::AccountConfig::DTMFBand

getset

Selects the DTMF band for the user.

Parameters

[in]

value

The DTMF band to select

See also

DTMFType

EnableIPv6Detection

bool ZDK_NET::AccountConfig::EnableIPv6Detection

getset

NOT USED! MIGHT BE REMOVED ANYTIME!

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

IAX

ZDK_NET:: IAXConfig^ ZDK_NET::AccountConfig::IAX

getset

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]

value

The IAX configuration

See also

IAXConfig, Type()

Password

System:: String^ ZDK_NET::AccountConfig::Password

getset

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

Parameters

[in]

value

The Account's password

See also

Type()

RegistrationGUID

System:: String^ ZDK_NET::AccountConfig::RegistrationGUID

getset

Sets per account Registration GUID.

!!!NOTE!!! NOT used internally!

Parameters

[in]

value

The account's Registration GUID

ReregistrationTime

int ZDK_NET::AccountConfig::ReregistrationTime

getset

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]

value

The registration refresh period in seconds

SIP

ZDK_NET:: SIPConfig^ ZDK_NET::AccountConfig::SIP

getset

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]

value

The SIP configuration

See also

SIPConfig, Type()

Type

ZDK_NET:: ProtocolType ZDK_NET::AccountConfig::Type

getset

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

Parameters

[in]

value

The Account's type

See also

ProtocolType

UserName

System:: String^ ZDK_NET::AccountConfig::UserName

getset

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

Parameters

[in]

value

The Account's username

See also

Type()

---

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

• Configurations/AccountConfig.h