<ZDKAccountConfig> Protocol Reference

General account configuration. More...

#import <ZDKAccountConfig.h>

Inheritance diagram for <ZDKAccountConfig>:

Instance Methods
(BOOL)	- isEqual:
	Compares the current configuration with the given one. More...
(NSString *)	- handlesDescription
Instance Methods inherited from <ZDKZHandle>
(long int)	- handle
(void)	- initialize
(void)	- releaseReference
(NSString *)	- handlesDescription

Properties
NSString *	userName
	Sets the Account's username (SIP, IAX, XMPP, etc, depending on the Account type) More...
NSString *_Nullable	password
	Sets the Account's password (SIP, IAX, XMPP, etc, depending on the Account type) More...
ZDKProtocolType	type
	Sets the Account's type (SIP, IAX, XMPP, etc.) More...
int	reregistrationTime
	Set the Account's registration refresh time. More...
id< ZDKSIPConfig > _Nullable	sip
	Sets the SIP specific account configuration. More...
id< ZDKIAXConfig > _Nullable	iax
	Sets the IAX specific account configuration. More...
NSString *_Nullable	deviceGUID
	Sets per account Device GUID. More...
NSString *_Nullable	registrationGUID
	Sets per account Registration GUID. More...
BOOL	enableIPv6Detection
	NOT USED! MIGHT BE REMOVED ANYTIME! More...
ZDKDTMFType	dtmfBand
	Selects the DTMF band for the user. More...
ZDKAudioOutputDeviceType	dtmfAutoplayDevice
	Automatically play DTMF sounds to the user. More...

Detailed Description

General account configuration.

Method Documentation

handlesDescription

- (NSString *) handlesDescription

Reimplemented from <ZDKZHandle>.

isEqual:

- (BOOL) isEqual:

(id< ZDKAccountConfig >)

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

- (NSString* _Nullable) deviceGUID

readwritenonatomicassign

Sets per account Device GUID.

!!!NOTE!!! NOT used internally!

Parameters

[in]

value

The account's Device GUID

dtmfAutoplayDevice

- (ZDKAudioOutputDeviceType) dtmfAutoplayDevice

readwritenonatomicassign

Automatically play DTMF sounds to the user.

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

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

Parameters

[in]

value

The DTMF autoplay device

See also

zdkCall::SendDTMF(), AudioOutputDeviceType

dtmfBand

- (ZDKDTMFType) dtmfBand

readwritenonatomicassign

Selects the DTMF band for the user.

Parameters

[in]

value

The DTMF band to select

See also

DTMFType

enableIPv6Detection

- (BOOL) enableIPv6Detection

readwritenonatomicassign

NOT USED! MIGHT BE REMOVED ANYTIME!

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

iax

- (id<ZDKIAXConfig> _Nullable) iax

readwritenonatomicassign

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

ZDKIAXConfig, type()

password

- (NSString* _Nullable) password

readwritenonatomicassign

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

- (NSString* _Nullable) registrationGUID

readwritenonatomicassign

Sets per account Registration GUID.

!!!NOTE!!! NOT used internally!

Parameters

[in]

value

The account's Registration GUID

reregistrationTime

- (int) reregistrationTime

readwritenonatomicassign

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

- (id<ZDKSIPConfig> _Nullable) sip

readwritenonatomicassign

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

ZDKSIPConfig, type()

type

- (ZDKProtocolType) type

readwritenonatomicassign

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

Parameters

[in]

value

The Account's type

See also

ProtocolType

userName

- (NSString*) userName

readwritenonatomicassign

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 protocol was generated from the following file:

• Configurations/ZDKAccountConfig.h