Account information and control provider. More...

#include <AccountProvider.h>

Inheritance diagram for ZDK_NET::AccountProvider:

Public Member Functions
	AccountProvider (ZDK::Shared::AccountProvider src)

ZDK_NET::Account ^	CreateUserAccount ()
	Creates a new user account. More...

void	DeleteUserAccount (ZDK_NET::Account^ account)
	Destroys an user account. More...

ZDK_NET::Account ^	GetAccount (long long hAccountId)
	Gets the account with the specified ID. More...

bool	SetAsDefaultAccount (ZDK_NET::Account^ account)
	Sets the default account. More...

void	UnregisterAllAccounts ()
	Unregisters all accounts. More...

ZDK_NET::AccountConfig ^	CreateAccountConfiguration ()
	Creates a new empty account configuration. More...

ZDK_NET::MSRPConfig ^	CreateMSRPConfiguration ()
	Creates a new empty MSRP configuration. More...

ZDK_NET::StunConfig ^	CreateStunConfiguration ()
	Creates a new empty STUN configuration. More...

ZDK_NET::IAXConfig ^	CreateIAXConfiguration ()
	Creates a new empty IAX configuration. More...

ZDK_NET::SIPConfig ^	CreateSIPConfiguration ()
	Creates a new empty SIP configuration. More...

ZDK_NET::ZRTPConfig ^	CreateZRTPConfiguration ()
	Creates a new empty ZRTP configuration. More...

ZDK_NET::PushConfig ^	CreatePushConfiguration ()
	Creates a new empty Push configuration. More...

ZDK_NET::HeaderField ^	CreateSIPHeaderField (System::String^ name, List< System::String^>^ values, ZDK_NET::SipMethodTypes method)
	Creates a SIP header. More...

void	AddAccountProviderListener (ZDK_NET::AccountProviderEventsHandler^ value)
	Adds a new account provider event listener. More...

void	DropAccountProviderListener (ZDK_NET::AccountProviderEventsHandler^ value)
	Removes a specific already added account provider event listener. More...

virtual long long	Handle () override

virtual void	Initialize () override

virtual void	ReleaseReference () override

Public Attributes
ZDK::IAccountProvider *	cppRef = nullptr

Properties
List< Account^>^	ListAccounts `[get]`
	Gets a list with all active accounts. More...

int	AccountsCount `[get]`
	Gets the count of all active accounts. More...

ZDK_NET::Account^	DefaultAccount `[get]`
	Gets the default account. More...

Detailed Description

Account information and control provider.

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

Member Function Documentation

◆ AddAccountProviderListener()

void ZDK_NET::AccountProvider::AddAccountProviderListener ( ZDK_NET::AccountProviderEventsHandler^ value )

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: AccountProviderEventsHandler, DropAccountProviderListener()

◆ CreateAccountConfiguration()

ZDK_NET::AccountConfig ^ ZDK_NET::AccountProvider::CreateAccountConfiguration ( )

Creates a new empty account configuration.

Returns: The newly created account configuration

See also: AccountConfig

◆ CreateIAXConfiguration()

ZDK_NET::IAXConfig ^ ZDK_NET::AccountProvider::CreateIAXConfiguration ( )

Creates a new empty IAX configuration.

Returns: The newly created IAX configuration

See also: IAXConfig

◆ CreateMSRPConfiguration()

ZDK_NET::MSRPConfig ^ ZDK_NET::AccountProvider::CreateMSRPConfiguration ( )

Creates a new empty MSRP configuration.

Returns: The newly created MSRP configuration

See also: MSRPConfig

◆ CreatePushConfiguration()

ZDK_NET::PushConfig ^ ZDK_NET::AccountProvider::CreatePushConfiguration ( )

Creates a new empty Push configuration.

Returns: The newly created Push configuration

See also: PushConfig

◆ CreateSIPConfiguration()

ZDK_NET::SIPConfig ^ ZDK_NET::AccountProvider::CreateSIPConfiguration ( )

Creates a new empty SIP configuration.

Returns: The newly created SIP configuration

See also: SIPConfig

◆ CreateSIPHeaderField()

ZDK_NET::HeaderField ^ ZDK_NET::AccountProvider::CreateSIPHeaderField	(	System::String^	name,
		List< System::String^>^	values,
		ZDK_NET::SipMethodTypes	method
	)

Creates a SIP header.

Parameters

[in]	name	The NAME of the header
[in]	values	List with header VALUES
[in]	method	SIP METHOD this header to be added to

Returns: The newly created SIP Header

See also: SipMethodTypes

◆ CreateStunConfiguration()

ZDK_NET::StunConfig ^ ZDK_NET::AccountProvider::CreateStunConfiguration ( )

Creates a new empty STUN configuration.

Returns: The newly created STUN configuration

See also: StunConfig

◆ CreateUserAccount()

ZDK_NET::Account ^ ZDK_NET::AccountProvider::CreateUserAccount ( )

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: Account

◆ CreateZRTPConfiguration()

ZDK_NET::ZRTPConfig ^ ZDK_NET::AccountProvider::CreateZRTPConfiguration ( )

Creates a new empty ZRTP configuration.

Returns: The newly created ZRTP configuration

See also: ZRTPConfig

◆ DeleteUserAccount()

void ZDK_NET::AccountProvider::DeleteUserAccount ( ZDK_NET::Account^ account )

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

void ZDK_NET::AccountProvider::DropAccountProviderListener ( ZDK_NET::AccountProviderEventsHandler^ value )

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: AccountProviderEventsHandler, AddConferenceProviderListener()

◆ GetAccount()

ZDK_NET::Account ^ ZDK_NET::AccountProvider::GetAccount ( long long hAccountId )

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

◆ SetAsDefaultAccount()

bool ZDK_NET::AccountProvider::SetAsDefaultAccount ( ZDK_NET::Account^ account )

Sets the default account.

Parameters

[in] account The default account

Returns: Whether or not the set was successful

◆ UnregisterAllAccounts()

void ZDK_NET::AccountProvider::UnregisterAllAccounts ( )

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: AccountEventsHandler

Property Documentation

◆ AccountsCount

int ZDK_NET::AccountProvider::AccountsCount

get

Gets the count of all active accounts.

Returns: The number of all accounts

◆ DefaultAccount

ZDK_NET:: Account^ ZDK_NET::AccountProvider::DefaultAccount

get

Gets the default account.

Returns: The default account

◆ ListAccounts

List< Account^>^ ZDK_NET::AccountProvider::ListAccounts

get

Gets a list with all active accounts.

Returns: List with all accounts

See also: Account

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

Providers/AccountProvider.h

Public Member Functions

Public Attributes

Properties

Detailed Description

Member Function Documentation

◆ AddAccountProviderListener()

◆ CreateAccountConfiguration()

◆ CreateIAXConfiguration()

◆ CreateMSRPConfiguration()

◆ CreatePushConfiguration()

◆ CreateSIPConfiguration()

◆ CreateSIPHeaderField()

◆ CreateStunConfiguration()

◆ CreateUserAccount()

◆ CreateZRTPConfiguration()

◆ DeleteUserAccount()

◆ DropAccountProviderListener()

◆ GetAccount()

◆ SetAsDefaultAccount()

◆ UnregisterAllAccounts()

Property Documentation

◆ AccountsCount

◆ DefaultAccount

◆ ListAccounts