Account information and control provider. More...

#import <ZDKAccountProvider.h>

Inheritance diagram for <ZDKAccountProvider>:

Instance Methods
(id< ZDKAccount >)	- createUserAccount
	Creates a new user account. More...

(void)	- deleteUserAccount:
	Destroys an user account. More...

(id< ZDKAccount > _Nullable)	- getAccount:
	Gets the account with the specified ID. More...

(BOOL)	- setAsDefaultAccount:
	Sets the default account. More...

(void)	- unregisterAllAccounts
	Unregisters all accounts. More...

(id< ZDKAccountConfig >)	- createAccountConfiguration
	Creates a new empty account configuration. More...

(id< ZDKMSRPConfig >)	- createMSRPConfiguration
	Creates a new empty MSRP configuration. More...

(id< ZDKStunConfig >)	- createStunConfiguration
	Creates a new empty STUN configuration. More...

(id< ZDKIAXConfig >)	- createIAXConfiguration
	Creates a new empty IAX configuration. More...

(id< ZDKSIPConfig >)	- createSIPConfiguration
	Creates a new empty SIP configuration. More...

(id< ZDKZRTPConfig >)	- createZRTPConfiguration
	Creates a new empty ZRTP configuration. More...

(id< ZDKPushConfig >)	- createPushConfiguration
	Creates a new empty Push configuration. More...

(id< ZDKHeaderField >)	- createSIPHeaderField:values:method:
	Creates a SIP header. More...

(void)	- addAccountProviderListener:
	Adds a new account provider event listener. More...

(void)	- dropAccountProviderListener:
	Removes a specific already added account provider event listener. More...

(NSString *)	- handlesDescription

Instance Methods inherited from <ZDKZHandle>
(long int)	- handle

(void)	- initialize

(void)	- releaseReference

(NSString *)	- handlesDescription

Properties
NSArray< id< ZDKAccount > > *	listAccounts
	Gets a list with all active accounts. More...

int	accountsCount
	Gets the count of all active accounts. More...

id< ZDKAccount > _Nullable	defaultAccount
	Gets the default account. More...

Detailed Description

Account information and control provider.

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

Method Documentation

◆ addAccountProviderListener:

- (void) addAccountProviderListener: (id< ZDKAccountProviderEventsHandler >) 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: ZDKAccountProviderEventsHandler, dropAccountProviderListener()

◆ createAccountConfiguration

- (id< ZDKAccountConfig >) createAccountConfiguration

Creates a new empty account configuration.

Returns: The newly created account configuration

See also: ZDKAccountConfig

◆ createIAXConfiguration

- (id< ZDKIAXConfig >) createIAXConfiguration

Creates a new empty IAX configuration.

Returns: The newly created IAX configuration

See also: ZDKIAXConfig

◆ createMSRPConfiguration

- (id< ZDKMSRPConfig >) createMSRPConfiguration

Creates a new empty MSRP configuration.

Returns: The newly created MSRP configuration

See also: ZDKMSRPConfig

◆ createPushConfiguration

- (id< ZDKPushConfig >) createPushConfiguration

Creates a new empty Push configuration.

Returns: The newly created Push configuration

See also: ZDKPushConfig

◆ createSIPConfiguration

- (id< ZDKSIPConfig >) createSIPConfiguration

Creates a new empty SIP configuration.

Returns: The newly created SIP configuration

See also: ZDKSIPConfig

◆ createSIPHeaderField:values:method:

- (id< ZDKHeaderField >) createSIPHeaderField:	(NSString *)	name
values:	(NSArray *)	values
method:	(ZDKSipMethodTypes)	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

- (id< ZDKStunConfig >) createStunConfiguration

Creates a new empty STUN configuration.

Returns: The newly created STUN configuration

See also: ZDKStunConfig

◆ createUserAccount

- (id< ZDKAccount >) 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: ZDKAccount

◆ createZRTPConfiguration

- (id< ZDKZRTPConfig >) createZRTPConfiguration

Creates a new empty ZRTP configuration.

Returns: The newly created ZRTP configuration

See also: ZDKZRTPConfig

◆ deleteUserAccount:

- (void) deleteUserAccount: (id< ZDKAccount >) 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) dropAccountProviderListener: (id< ZDKAccountProviderEventsHandler >) 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: ZDKAccountProviderEventsHandler, addConferenceProviderListener()

◆ getAccount:

- (id< ZDKAccount > _Nullable) getAccount: (long int) 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

◆ handlesDescription

- (NSString *) handlesDescription

Reimplemented from <ZDKZHandle>.

◆ setAsDefaultAccount:

- (BOOL) setAsDefaultAccount: (id< ZDKAccount > _Nullable) account

Sets the default account.

Parameters

[in] account The default account

Returns: Whether or not the set was successful

◆ unregisterAllAccounts

- (void) 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: ZDKAccountEventsHandler

Property Documentation

◆ accountsCount

- (int) accountsCount

readnonatomicassign

Gets the count of all active accounts.

Returns: The number of all accounts

◆ defaultAccount

- (id<ZDKAccount> _Nullable) defaultAccount

readnonatomicassign

Gets the default account.

Returns: The default account

◆ listAccounts

- (NSArray<id<ZDKAccount> >*) listAccounts

readnonatomicassign

Gets a list with all active accounts.

Returns: List with all accounts

See also: ZDKAccount

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

Providers/ZDKAccountProvider.h

Instance Methods

Properties

Detailed Description

Method Documentation

◆ addAccountProviderListener:

◆ createAccountConfiguration

◆ createIAXConfiguration

◆ createMSRPConfiguration

◆ createPushConfiguration

◆ createSIPConfiguration

◆ createSIPHeaderField:values:method:

◆ createStunConfiguration

◆ createUserAccount

◆ createZRTPConfiguration

◆ deleteUserAccount:

◆ dropAccountProviderListener:

◆ getAccount:

◆ handlesDescription

◆ setAsDefaultAccount:

◆ unregisterAllAccounts

Property Documentation

◆ accountsCount

◆ defaultAccount

◆ listAccounts