com.zoiper.zdk.Providers

Class AccountProvider

java.lang.Object

com.zoiper.zdk.Providers.AccountProvider

public class AccountProvider
extends java.lang.Object

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
int	accountsCount() Gets the count of all active accounts
void	addAccountProviderListener(AccountProviderEventsHandler value) Adds a new account provider event listener All added listeners will be notified for each event.
AccountConfig	createAccountConfiguration() Creates a new empty account configuration
IAXConfig	createIAXConfiguration() Creates a new empty IAX configuration
MSRPConfig	createMSRPConfiguration() Creates a new empty MSRP configuration
PushConfig	createPushConfiguration() Creates a new empty Push configuration
SIPConfig	createSIPConfiguration() Creates a new empty SIP configuration
HeaderField	createSIPHeaderField(java.lang.String name, java.util.List<java.lang.String> values, SipMethodTypes method) Creates a SIP header
StunConfig	createStunConfiguration() Creates a new empty STUN configuration
Account	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.
ZRTPConfig	createZRTPConfiguration() Creates a new empty ZRTP configuration
Account	defaultAccount() Gets the default account
void	deleteUserAccount(Account account) Destroys an user account Destroys an user account object and all related structures.
void	dropAccountProviderListener(AccountProviderEventsHandler value) Removes a specific already added account provider event listener All added/left listeners will be notified for each event.
protected void	finalize() Ensures the underlying native object destruction
Account	getAccount(long hAccountId) Gets the account with the specified ID Returns the account with the specified ID if exist, otherwise a null pointer is returned.
long	handle() Gets the pointer/address to the underlying native object
java.util.List<Account>	listAccounts() Gets a list with all active accounts
boolean	setAsDefaultAccount(Account account) Sets the default account
void	unregisterAllAccounts() Unregisters all accounts If the user account is in the process of registration this function will cancel it.

Methods inherited from class java.lang.Object

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

Constructor Detail

AccountProvider

public AccountProvider(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

listAccounts

public java.util.List<Account> listAccounts()

Gets a list with all active accounts

Returns:

List with all accounts

See Also:

Account

accountsCount

public int accountsCount()

Gets the count of all active accounts

Returns:

The number of all accounts

defaultAccount

public Account defaultAccount()

Gets the default account

Returns:

The default account

createUserAccount

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

deleteUserAccount

public void deleteUserAccount(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:

account - The account to be destroyed

getAccount

public Account getAccount(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:

hAccountId - The ID of the requested account

Returns:

The requested account if exists or null pointer otherwise

setAsDefaultAccount

public boolean setAsDefaultAccount(Account account)

Sets the default account

Parameters:

account - The default account

Returns:

Whether or not the set was successful

unregisterAllAccounts

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

AccountEventsHandler

createAccountConfiguration

public AccountConfig createAccountConfiguration()

Creates a new empty account configuration

Returns:

The newly created account configuration

See Also:

AccountConfig

createMSRPConfiguration

public MSRPConfig createMSRPConfiguration()

Creates a new empty MSRP configuration

Returns:

The newly created MSRP configuration

See Also:

MSRPConfig

createStunConfiguration

public StunConfig createStunConfiguration()

Creates a new empty STUN configuration

Returns:

The newly created STUN configuration

See Also:

StunConfig

createIAXConfiguration

public IAXConfig createIAXConfiguration()

Creates a new empty IAX configuration

Returns:

The newly created IAX configuration

See Also:

IAXConfig

createSIPConfiguration

public SIPConfig createSIPConfiguration()

Creates a new empty SIP configuration

Returns:

The newly created SIP configuration

See Also:

SIPConfig

createZRTPConfiguration

public ZRTPConfig createZRTPConfiguration()

Creates a new empty ZRTP configuration

Returns:

The newly created ZRTP configuration

See Also:

ZRTPConfig

createPushConfiguration

public PushConfig createPushConfiguration()

Creates a new empty Push configuration

Returns:

The newly created Push configuration

See Also:

PushConfig

createSIPHeaderField

public HeaderField createSIPHeaderField(java.lang.String name,
                                        java.util.List<java.lang.String> values,
                                        SipMethodTypes method)

Creates a SIP header

Parameters:

name - The NAME of the header

values - List with header VALUES

method - SIP METHOD this header to be added to

Returns:

The newly created SIP Header

See Also:

SipMethodTypes

addAccountProviderListener

public void addAccountProviderListener(AccountProviderEventsHandler value)

Adds a new account provider event listener All added listeners will be notified for each event.

Parameters:

value - The account provider event listener to be added

See Also:

dropAccountProviderListener

dropAccountProviderListener

public void dropAccountProviderListener(AccountProviderEventsHandler value)

Removes a specific already added account provider event listener All added/left listeners will be notified for each event.

Parameters:

value - The account provider event listener to be removed

See Also:

addConferenceProviderListener