Account information and control provider. More...

#include <IAccountProvider.h>

Inheritance diagram for ZDK::IAccountProvider:

Public Member Functions
virtual ZDK::Shared::Account	CreateUserAccount ()=0
	Creates a new user account. More...

virtual void	DeleteUserAccount (ZDK::Shared::Account account)=0
	Destroys an user account. More...

virtual ZDK::Shared::ItemList< ZDK::Shared::Account >	ListAccounts () const =0
	Gets a list with all active accounts. More...

virtual int	AccountsCount () const =0
	Gets the count of all active accounts. More...

virtual ZDK::Shared::Account	GetAccount (ZDK::ZDKHandle hAccountId) const =0
	Gets the account with the specified ID. More...

virtual ZDK::Shared::Account	DefaultAccount () const =0

virtual bool	SetAsDefaultAccount (ZDK::Shared::Account account)=0

virtual void	UnregisterAllAccounts ()=0
	Unregisters all accounts. More...

virtual ZDK::Shared::AccountConfig	CreateAccountConfiguration ()=0
	Creates a new empty account configuration. More...

virtual ZDK::Shared::MSRPConfig	CreateMSRPConfiguration ()=0
	Creates a new empty MSRP configuration. More...

virtual ZDK::Shared::StunConfig	CreateStunConfiguration ()=0
	Creates a new empty STUN configuration. More...

virtual ZDK::Shared::IAXConfig	CreateIAXConfiguration ()=0
	Creates a new empty IAX configuration. More...

virtual ZDK::Shared::SIPConfig	CreateSIPConfiguration ()=0
	Creates a new empty SIP configuration. More...

virtual ZDK::Shared::ZRTPConfig	CreateZRTPConfiguration ()=0
	Creates a new empty ZRTP configuration. More...

virtual void	AddAccountProviderListener (ZDK::Shared::AccountProviderEventsHandler value)=0
	Adds a new account provider event listener. More...

virtual void	DropAccountProviderListener (ZDK::Shared::AccountProviderEventsHandler value)=0
	Removes a specific already added account provider event listener. 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

Account information and control provider.

Manages creation and destruction of user accounts and provides information regarding them.

Member Function Documentation

◆ AccountsCount()

virtual int ZDK::IAccountProvider::AccountsCount ( ) const

pure virtual

Gets the count of all active accounts.

Returns: The number of all accounts

◆ AddAccountProviderListener()

virtual void ZDK::IAccountProvider::AddAccountProviderListener ( ZDK::Shared::AccountProviderEventsHandler value )

pure virtual

Adds a new account provider event listener.

All added listeners will be notified for each event.

Parameters

[in] value The account provider event listener to be added

See also: IAccountProviderEventsHandler, DropAccountProviderListener()

◆ CreateAccountConfiguration()

virtual ZDK::Shared::AccountConfig ZDK::IAccountProvider::CreateAccountConfiguration ( )

pure virtual

Creates a new empty account configuration.

Returns: The newly created account configuration

See also: IAccountConfig

◆ CreateIAXConfiguration()

virtual ZDK::Shared::IAXConfig ZDK::IAccountProvider::CreateIAXConfiguration ( )

pure virtual

Creates a new empty IAX configuration.

Returns: The newly created IAX configuration

See also: IIAXConfig

◆ CreateMSRPConfiguration()

virtual ZDK::Shared::MSRPConfig ZDK::IAccountProvider::CreateMSRPConfiguration ( )

pure virtual

Creates a new empty MSRP configuration.

Returns: The newly created MSRP configuration

See also: IMSRPConfig

◆ CreateSIPConfiguration()

virtual ZDK::Shared::SIPConfig ZDK::IAccountProvider::CreateSIPConfiguration ( )

pure virtual

Creates a new empty SIP configuration.

Returns: The newly created SIP configuration

See also: ISIPConfig

◆ CreateStunConfiguration()

virtual ZDK::Shared::StunConfig ZDK::IAccountProvider::CreateStunConfiguration ( )

pure virtual

Creates a new empty STUN configuration.

Returns: The newly created STUN configuration

See also: IStunConfig

◆ CreateUserAccount()

virtual ZDK::Shared::Account ZDK::IAccountProvider::CreateUserAccount ( )

pure virtual

Creates a new user account.

Creates a new user that can be used to register on a server for incoming calls, create outgoing calls, subscribe for presence, etc. This is a mandatory operation before using most of the library's functions.

This call will only prepare the structures for the user account. It will not be registered to the server until RegisterAccount() is called (note that registration is not a mandatory operation).

Returns: The newly created user account

See also: IAccount

◆ CreateZRTPConfiguration()

virtual ZDK::Shared::ZRTPConfig ZDK::IAccountProvider::CreateZRTPConfiguration ( )

pure virtual

Creates a new empty ZRTP configuration.

Returns: The newly created ZRTP configuration

See also: IZRTPConfig

◆ DeleteUserAccount()

virtual void ZDK::IAccountProvider::DeleteUserAccount ( ZDK::Shared::Account account )

pure virtual

Destroys an user account.

Destroys an user account object and all related structures. If the user has active calls, they will be terminated first.

Parameters

[in] account The account to be destroyed

◆ DropAccountProviderListener()

virtual void ZDK::IAccountProvider::DropAccountProviderListener ( ZDK::Shared::AccountProviderEventsHandler value )

pure virtual

Removes a specific already added account provider event listener.

All added/left listeners will be notified for each event.

Parameters

[in] value The account provider event listener to be removed

See also: IAccountProviderEventsHandler, AddConferenceProviderListener()

◆ GetAccount()

virtual ZDK::Shared::Account ZDK::IAccountProvider::GetAccount ( ZDK::ZDKHandle hAccountId ) const

pure virtual

Gets the account with the specified ID.

Returns the account with the specified ID if exist, otherwise a null pointer is returned.

Parameters

[in] hAccountId The ID of the requested account

Returns: The requested account if exists or null pointer otherwise

◆ ListAccounts()

virtual ZDK::Shared::ItemList<ZDK::Shared::Account> ZDK::IAccountProvider::ListAccounts ( ) const

pure virtual

Gets a list with all active accounts.

Returns: List with all accounts

See also: IAccount

◆ UnregisterAllAccounts()

virtual void ZDK::IAccountProvider::UnregisterAllAccounts ( )

pure virtual

Unregisters all accounts.

If the user account is in the process of registration this function will cancel it. If the user was already registered an unregistration process will start. If there is no error the function will return immediately and the final result will be delivered via a callback.

See also: IAccountEventsHandler

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

Providers/IAccountProvider.h

Public Member Functions

Detailed Description

Member Function Documentation

◆ AccountsCount()

◆ AddAccountProviderListener()

◆ CreateAccountConfiguration()

◆ CreateIAXConfiguration()

◆ CreateMSRPConfiguration()

◆ CreateSIPConfiguration()

◆ CreateStunConfiguration()

◆ CreateUserAccount()

◆ CreateZRTPConfiguration()

◆ DeleteUserAccount()

◆ DropAccountProviderListener()

◆ GetAccount()

◆ ListAccounts()

◆ UnregisterAllAccounts()