com.zoiper.zdk.Configurations

Class AccountConfig

java.lang.Object

com.zoiper.zdk.Configurations.AccountConfig

public class AccountConfig
extends java.lang.Object

General account configuration

Constructor Summary

Constructors

Constructor and Description
AccountConfig(long handle) Constructor storing the pointer/address to the underlying native object

Method Summary

Modifier and Type	Method and Description
java.lang.String	deviceGUID() Gets the previously stored per account Device GUID !!!NOTE!!! NOT used internally!
void	deviceGUID(java.lang.String value) Sets per account Device GUID !!!NOTE!!! NOT used internally!
AudioOutputDeviceType	dtmfAutoplayDevice() Automatically play DTMF sounds to the user Controls whether to automatically play the DTMF sounds to the user when sending DTMFs with call::SendDTMF.
void	dtmfAutoplayDevice(AudioOutputDeviceType value) Automatically play DTMF sounds to the user Controls whether to automatically play the DTMF sounds to the user when sending DTMFs with call::SendDTMF.
DTMFType	dtmfBand() Gets the selected DTMF band for the user
void	dtmfBand(DTMFType value) Selects the DTMF band for the user
boolean	enableIPv6Detection() NOT USED! MIGHT BE REMOVED ANYTIME! Pv6 is a global option and there are no plans making it configurable per account!
void	enableIPv6Detection(boolean value) NOT USED! MIGHT BE REMOVED ANYTIME! Pv6 is a global option and there are no plans making it configurable per account!
protected void	finalize() Ensures the underlying native object destruction
long	handle() Gets the pointer/address to the underlying native object
IAXConfig	iax() Gets the IAX specific account configuration Gets the IAX specific account configuration that is used in case the Account's type is IAX.
void	iax(IAXConfig value) Sets the IAX specific account configuration Sets the IAX specific account configuration being used in case the Account's type is IAX.
boolean	isEqual(AccountConfig comp) Compares the current configuration with the given one
java.lang.String	password() Gets the Account's password (SIP, IAX, XMPP, etc, depending on the Account type)
void	password(java.lang.String value) Sets the Account's password (SIP, IAX, XMPP, etc, depending on the Account type)
java.lang.String	registrationGUID() Gets the previously stored per account Registration GUID !!!NOTE!!! NOT used internally!
void	registrationGUID(java.lang.String value) Sets per account Registration GUID !!!NOTE!!! NOT used internally!
int	reregistrationTime() Get the Account's registration refresh time Gets the desired registration refresh period in seconds.
void	reregistrationTime(int value) Set the Account's registration refresh time Sets the desired registration refresh period in seconds.
SIPConfig	sip() Gets the SIP specific account configuration Gets the SIP specific account configuration that is used in case the Account's type is SIP.
void	sip(SIPConfig value) Sets the SIP specific account configuration Sets the SIP specific account configuration being used in case the Account's type is SIP.
ProtocolType	type() Gets the Account's type (SIP, IAX, XMPP, etc.)
void	type(ProtocolType value) Sets the Account's type (SIP, IAX, XMPP, etc.)
java.lang.String	userName() Gets the Account's username (SIP, IAX, XMPP, etc, depending on the Account type)
void	userName(java.lang.String value) Sets the Account's username (SIP, IAX, XMPP, etc, depending on the Account type)

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AccountConfig

public AccountConfig(long handle)

Constructor storing the pointer/address to the underlying native object

Parameters:

handle - Pointer/address to the underlying native object

Method Detail

handle

public long handle()

Gets the pointer/address to the underlying native object

Returns:

Pointer/address to the underlying native object

finalize

protected void finalize()

Ensures the underlying native object destruction

Overrides:

finalize in class java.lang.Object

userName

public java.lang.String userName()

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

Returns:

The Account's username

See Also:

type

userName

public void userName(java.lang.String value)

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

Parameters:

value - The Account's username

See Also:

type

password

public java.lang.String password()

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

Returns:

The Account's password

See Also:

type

password

public void password(java.lang.String value)

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

Parameters:

value - The Account's password

See Also:

type

type

public ProtocolType type()

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

Returns:

The Account's type

See Also:

ProtocolType

type

public void type(ProtocolType value)

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

Parameters:

value - The Account's type

See Also:

ProtocolType

reregistrationTime

public int reregistrationTime()

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

public void reregistrationTime(int value)

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:

value - The registration refresh period in seconds

sip

public SIPConfig sip()

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:

type

sip

public void sip(SIPConfig value)

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:

value - The SIP configuration

See Also:

type

iax

public IAXConfig iax()

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:

type

iax

public void iax(IAXConfig value)

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:

value - The IAX configuration

See Also:

type

deviceGUID

public java.lang.String deviceGUID()

Gets the previously stored per account Device GUID !!!NOTE!!! NOT used internally!

Returns:

The account's Device GUID

deviceGUID

public void deviceGUID(java.lang.String value)

Sets per account Device GUID !!!NOTE!!! NOT used internally!

Parameters:

value - The account's Device GUID

registrationGUID

public java.lang.String registrationGUID()

Gets the previously stored per account Registration GUID !!!NOTE!!! NOT used internally!

Returns:

The account's Registration GUID

registrationGUID

public void registrationGUID(java.lang.String value)

Sets per account Registration GUID !!!NOTE!!! NOT used internally!

Parameters:

value - The account's Registration GUID

enableIPv6Detection

public boolean enableIPv6Detection()

NOT USED! MIGHT BE REMOVED ANYTIME! Pv6 is a global option and there are no plans making it configurable per account!

enableIPv6Detection

public void enableIPv6Detection(boolean value)

NOT USED! MIGHT BE REMOVED ANYTIME! Pv6 is a global option and there are no plans making it configurable per account!

dtmfBand

public DTMFType dtmfBand()

Gets the selected DTMF band for the user

Returns:

The selected DTMF band

See Also:

DTMFType

dtmfBand

public void dtmfBand(DTMFType value)

Selects the DTMF band for the user

Parameters:

value - The DTMF band to select

See Also:

DTMFType

dtmfAutoplayDevice

public AudioOutputDeviceType dtmfAutoplayDevice()

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).

Returns:

The selected DTMF autoplay device

See Also:

AudioOutputDeviceType

dtmfAutoplayDevice

public void dtmfAutoplayDevice(AudioOutputDeviceType value)

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:

value - The DTMF autoplay device

See Also:

AudioOutputDeviceType

isEqual

public boolean isEqual(AccountConfig comp)

Compares the current configuration with the given one

Parameters:

comp - Account configuration to be compared

Returns:

• 0 - not equal
• 1 - equal