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

IAX specific account configuration. More...

#include <IIAXConfig.h>

Inheritance diagram for ZDK::IIAXConfig:
ZDK::IZHandle

Public Member Functions

virtual ZDK::Shared::String Host () const =0
 Gets the server/host address in use. More...
 
virtual void Host (ZDK::Shared::String value)=0
 Configures the server/host address to be used. More...
 
virtual ZDK::Shared::String Context () const =0
 Gets the context in use. More...
 
virtual void Context (ZDK::Shared::String value)=0
 Configures the context to be used. More...
 
virtual ZDK::Shared::String CallerID () const =0
 Gets the caller ID used for identification. More...
 
virtual void CallerID (ZDK::Shared::String value)=0
 Configures the caller ID used for identification. More...
 
virtual ZDK::Shared::String CallerNumber () const =0
 Gets the caller number used for identification. More...
 
virtual void CallerNumber (ZDK::Shared::String value)=0
 Configures the caller number used for identification. More...
 
virtual ZDK::DTMFTypeIAX DTMF () const =0
 Gets the selected DTMF band for the user. More...
 
virtual void DTMF (ZDK::DTMFTypeIAX value)=0
 Selects the DTMF band for the user. More...
 
virtual bool IsEqual (ZDK::Shared::IAXConfig comp) const =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

IAX specific account configuration.

Member Function Documentation

◆ CallerID() [1/2]

virtual ZDK::Shared::String ZDK::IIAXConfig::CallerID ( ) const
pure virtual

Gets the caller ID used for identification.

Returns
The configured caller ID

◆ CallerID() [2/2]

virtual void ZDK::IIAXConfig::CallerID ( ZDK::Shared::String  value)
pure virtual

Configures the caller ID used for identification.

Parameters
[in]valueThe caller ID to be used

◆ CallerNumber() [1/2]

virtual ZDK::Shared::String ZDK::IIAXConfig::CallerNumber ( ) const
pure virtual

Gets the caller number used for identification.

Returns
The configured caller number

◆ CallerNumber() [2/2]

virtual void ZDK::IIAXConfig::CallerNumber ( ZDK::Shared::String  value)
pure virtual

Configures the caller number used for identification.

Parameters
[in]valueThe caller number to be used

◆ Context() [1/2]

virtual ZDK::Shared::String ZDK::IIAXConfig::Context ( ) const
pure virtual

Gets the context in use.

Returns
The context

◆ Context() [2/2]

virtual void ZDK::IIAXConfig::Context ( ZDK::Shared::String  value)
pure virtual

Configures the context to be used.

Parameters
[in]valueThe context

◆ DTMF() [1/2]

virtual ZDK::DTMFTypeIAX ZDK::IIAXConfig::DTMF ( ) const
pure virtual

Gets the selected DTMF band for the user.

Returns
The selected DTMF band
See also
DTMFTypeIAX

◆ DTMF() [2/2]

virtual void ZDK::IIAXConfig::DTMF ( ZDK::DTMFTypeIAX  value)
pure virtual

Selects the DTMF band for the user.

Parameters
[in]valueThe DTMF band to select
See also
DTMFTypeIAX

◆ Host() [1/2]

virtual ZDK::Shared::String ZDK::IIAXConfig::Host ( ) const
pure virtual

Gets the server/host address in use.

Returns
The used server address

◆ Host() [2/2]

virtual void ZDK::IIAXConfig::Host ( ZDK::Shared::String  value)
pure virtual

Configures the server/host address to be used.

Parameters
[in]valueThe server/host address

◆ IsEqual()

virtual bool ZDK::IIAXConfig::IsEqual ( ZDK::Shared::IAXConfig  comp) const
pure virtual

Compares the current configuration with the given one.

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

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