Package org.linphone.core

Interface AccountCreator

public interface AccountCreator

The object used to configure an account on a server via XML-RPC, see
https://wiki.linphone.org/xwiki/wiki/public/view/Lib/Features/Override%20account%20creator%20request/.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	AccountCreator.ActivationCodeStatus
static enum	AccountCreator.AlgoStatus
static enum	AccountCreator.Backend
static enum	AccountCreator.DomainStatus
static enum	AccountCreator.EmailStatus
static enum	AccountCreator.LanguageStatus
static enum	AccountCreator.PasswordStatus
static enum	AccountCreator.PhoneNumberStatus
static enum	AccountCreator.Status
static enum	AccountCreator.TransportStatus
static enum	AccountCreator.UsernameStatus

Method Summary

Modifier and Type	Method	Description
AccountCreator.Status	activateAccount()	Deprecated. 11/06/2024 use AccountManagerServices instead
AccountCreator.Status	activateAlias()	Deprecated. 11/06/2024 use AccountManagerServices instead
void	addListener(AccountCreatorListener listener)
AccountCreator	create(Core core)	Deprecated. 11/06/2024 use AccountManagerServices instead
AccountCreator.Status	createAccount()	Deprecated. 11/06/2024 use AccountManagerServices instead
Account	createAccountInCore()	Deprecated. 11/06/2024 use AccountManagerServices instead
ProxyConfig	createProxyConfig()	Deprecated. 05/05/2023 Use createAccountInCore() instead.
AccountCreator.Status	createPushAccount()	Deprecated. 11/06/2024 use AccountManagerServices instead
String	getAccountCreationRequestToken()	Deprecated. 11/06/2024 use AccountManagerServices instead
String	getActivationCode()	Deprecated. 11/06/2024 use AccountManagerServices instead
String	getAlgorithm()	Deprecated. 11/06/2024 use AccountManagerServices instead
String	getDisplayName()	Deprecated. 11/06/2024 use AccountManagerServices instead
String	getDomain()	Deprecated. 11/06/2024 use AccountManagerServices instead
String	getEmail()	Deprecated. 11/06/2024 use AccountManagerServices instead
String	getHa1()	Deprecated. 11/06/2024 use AccountManagerServices instead
String	getLanguage()	Deprecated. 11/06/2024 use AccountManagerServices instead
long	getNativePointer()	Gets the native pointer used by this class to make native method calls.
String	getPassword()	Deprecated. 11/06/2024 use AccountManagerServices instead
String	getPhoneCountryCode()	Deprecated. 11/06/2024 use AccountManagerServices instead
String	getPhoneNumber()	Deprecated. 11/06/2024 use AccountManagerServices instead
String	getPnParam()	Deprecated. 11/06/2024 use AccountManagerServices instead
String	getPnPrid()	Deprecated. 11/06/2024 use AccountManagerServices instead
String	getPnProvider()	Deprecated. 11/06/2024 use AccountManagerServices instead
String	getRoute()	Get the route.
boolean	getSetAsDefault()	Deprecated. 11/06/2024 use AccountManagerServices instead
String	getToken()	Deprecated. 11/06/2024 use AccountManagerServices instead
TransportType	getTransport()	Deprecated. 11/06/2024 use AccountManagerServices instead
Object	getUserData()	Gets the object stored in this object user's data
String	getUsername()	Deprecated. 11/06/2024 use AccountManagerServices instead
AccountCreator.Status	isAccountActivated()	Deprecated. 11/06/2024 use AccountManagerServices instead
AccountCreator.Status	isAccountExist()	Deprecated. 11/06/2024 use AccountManagerServices instead
AccountCreator.Status	isAccountLinked()	Deprecated. 11/06/2024 use AccountManagerServices instead
AccountCreator.Status	isAliasUsed()	Deprecated. 11/06/2024 use AccountManagerServices instead
AccountCreator.Status	linkAccount()	Deprecated. 11/06/2024 use AccountManagerServices instead
AccountCreator.Status	loginLinphoneAccount()	Deprecated. 11/06/2024 use AccountManagerServices instead
AccountCreator.Status	recoverAccount()	Deprecated. 11/06/2024 use AccountManagerServices instead
void	removeListener(AccountCreatorListener listener)
AccountCreator.Status	requestAccountCreationRequestToken()	Deprecated. 11/06/2024 use AccountManagerServices instead
AccountCreator.Status	requestAccountCreationTokenUsingRequestToken()	Deprecated. 11/06/2024 use AccountManagerServices instead
AccountCreator.Status	requestAuthToken()	Deprecated. 11/06/2024 use AccountManagerServices instead
void	reset()	Deprecated. 11/06/2024 use AccountManagerServices instead
void	setAccount(Account account)	Deprecated. 11/06/2024 use AccountManagerServices instead
void	setAccountCreationRequestToken(String token)	Deprecated. 11/06/2024 use AccountManagerServices instead
AccountCreator.ActivationCodeStatus	setActivationCode(String activationCode)	Deprecated. 11/06/2024 use AccountManagerServices instead
AccountCreator.AlgoStatus	setAlgorithm(String algorithm)	Deprecated. 11/06/2024 use AccountManagerServices instead
AccountCreator.Status	setAsDefault(boolean setAsDefault)	Deprecated. 11/06/2024 use AccountManagerServices instead
AccountCreator.UsernameStatus	setDisplayName(String displayName)	Deprecated. 11/06/2024 use AccountManagerServices instead
AccountCreator.DomainStatus	setDomain(String domain)	Deprecated. 11/06/2024 use AccountManagerServices instead
AccountCreator.EmailStatus	setEmail(String email)	Deprecated. 11/06/2024 use AccountManagerServices instead
AccountCreator.PasswordStatus	setHa1(String ha1)	Deprecated. 11/06/2024 use AccountManagerServices instead
AccountCreator.LanguageStatus	setLanguage(String lang)	Deprecated. 11/06/2024 use AccountManagerServices instead
AccountCreator.PasswordStatus	setPassword(String password)	Deprecated. 11/06/2024 use AccountManagerServices instead
int	setPhoneNumber(String phoneNumber, String countryCode)	Deprecated. 11/06/2024 use AccountManagerServices instead
void	setPnParam(String pnParam)	Deprecated. 11/06/2024 use AccountManagerServices instead
void	setPnPrid(String pnPrid)	Deprecated. 11/06/2024 use AccountManagerServices instead
void	setPnProvider(String pnProvider)	Deprecated. 11/06/2024 use AccountManagerServices instead
void	setProxyConfig(ProxyConfig cfg)	Deprecated. 11/06/2024 use AccountManagerServices instead
AccountCreator.Status	setRoute(String route)	Set the route.
void	setToken(String token)	Deprecated. 11/06/2024 use AccountManagerServices instead
AccountCreator.TransportStatus	setTransport(TransportType transport)	Deprecated. 11/06/2024 use AccountManagerServices instead
void	setUserData(Object data)	Sets the object to store in this object user's data
AccountCreator.UsernameStatus	setUsername(String username)	Deprecated. 11/06/2024 use AccountManagerServices instead
String	toString()
AccountCreator.Status	updateAccount()	Deprecated. 11/06/2024 use AccountManagerServices instead
void	useTestAdminAccount()	Deprecated. 11/06/2024 use AccountManagerServices instead

Method Details

setAccount

@Deprecated
void setAccount(@Nullable
 Account account)

Deprecated.

11/06/2024 use AccountManagerServices instead

Assign a proxy config pointer to the LinphoneAccountCreator.

Parameters:

account - The LinphoneAccount to associate with the
LinphoneAccountCreator.

getAccountCreationRequestToken

@Deprecated
@Nullable
String getAccountCreationRequestToken()

Deprecated.

11/06/2024 use AccountManagerServices instead

Get the account creation request token received to be used to check user
validation.

Returns:

The token set, if any

setAccountCreationRequestToken

@Deprecated
void setAccountCreationRequestToken(@Nullable
 String token)

Deprecated.

11/06/2024 use AccountManagerServices instead

Set the account creation request token received to be used to check user
validation.

Parameters:

token - The token to set

getActivationCode

@Deprecated
@Nullable
String getActivationCode()

Deprecated.

11/06/2024 use AccountManagerServices instead

Get the activation code.

Returns:

The activation code of the AccountCreator.

setActivationCode

@Deprecated
AccountCreator.ActivationCodeStatus setActivationCode(@Nullable
 String activationCode)

Deprecated.

11/06/2024 use AccountManagerServices instead

Set the activation code.

Parameters:

activationCode - The activation code to set

Returns:

AccountCreator.ActivationCodeStatus.Ok if everything is OK, or a specific
error otherwise.

getAlgorithm

@Deprecated
@Nullable
String getAlgorithm()

Deprecated.

11/06/2024 use AccountManagerServices instead

Get the algorithm configured in the account creator.

Returns:

The algorithm of the AccountCreator.

setAlgorithm

@Deprecated
AccountCreator.AlgoStatus setAlgorithm(@Nullable
 String algorithm)

Deprecated.

11/06/2024 use AccountManagerServices instead

Set the supported algorithm.

Parameters:

algorithm - The algorithm to use

Returns:

LinphoneAccountCreatorAlgoStatusOk if everything is OK, or a specific
error otherwise.

setAsDefault

@Deprecated
AccountCreator.Status setAsDefault(boolean setAsDefault)

Deprecated.

11/06/2024 use AccountManagerServices instead

Set the set_as_default property.

Parameters:

setAsDefault - true for the created proxy config to be set as default in
Core, false otherwise

Returns:

AccountCreator.Status.RequestOk if everything is OK, or a specific error
otherwise.

getDisplayName

@Deprecated
@Nullable
String getDisplayName()

Deprecated.

11/06/2024 use AccountManagerServices instead

Get the display name.

Returns:

The display name of the AccountCreator.

setDisplayName

@Deprecated
AccountCreator.UsernameStatus setDisplayName(@Nullable
 String displayName)

Deprecated.

11/06/2024 use AccountManagerServices instead

Set the display name.

Parameters:

displayName - The display name to set

Returns:

AccountCreator.UsernameStatus.Ok if everything is OK, or a specific error
otherwise.

getDomain

@Deprecated
@Nullable
String getDomain()

Deprecated.

11/06/2024 use AccountManagerServices instead

Get the domain.

Returns:

The domain of the AccountCreator.

setDomain

@Deprecated
AccountCreator.DomainStatus setDomain(@Nullable
 String domain)

Deprecated.

11/06/2024 use AccountManagerServices instead

Set the domain.

Parameters:

domain - The domain to set

Returns:

AccountCreator.DomainStatus.Ok if everything is OK, or a specific error
otherwise.

getEmail

@Deprecated
@Nullable
String getEmail()

Deprecated.

11/06/2024 use AccountManagerServices instead

Get the email.

Returns:

The email of the AccountCreator.

setEmail

@Deprecated
AccountCreator.EmailStatus setEmail(@Nullable
 String email)

Deprecated.

11/06/2024 use AccountManagerServices instead

Set the email.

Parameters:

email - The email to set

Returns:

AccountCreator.EmailStatus.Ok if everything is OK, or a specific error
otherwise.

getHa1

@Deprecated
@Nullable
String getHa1()

Deprecated.

11/06/2024 use AccountManagerServices instead

Get the ha1.

Returns:

The ha1 of the AccountCreator.

setHa1

@Deprecated
AccountCreator.PasswordStatus setHa1(@Nullable
 String ha1)

Deprecated.

11/06/2024 use AccountManagerServices instead

Set the ha1.

Parameters:

ha1 - The ha1 to set

Returns:

AccountCreator.PasswordStatus.Ok if everything is OK, or a specific error
otherwise.

getLanguage

@Deprecated
@Nullable
String getLanguage()

Deprecated.

11/06/2024 use AccountManagerServices instead

Get the language use in email of SMS.

Returns:

The language of the AccountCreator.

setLanguage

@Deprecated
AccountCreator.LanguageStatus setLanguage(@Nullable
 String lang)

Deprecated.

11/06/2024 use AccountManagerServices instead

Set the language to use in email or SMS if supported.

Parameters:

lang - The language to use

Returns:

AccountCreator.LanguageStatus.Ok if everything is OK, or a specific error
otherwise.

getPassword

@Deprecated
@Nullable
String getPassword()

Deprecated.

11/06/2024 use AccountManagerServices instead

Get the password.

Returns:

The password of the AccountCreator.

setPassword

@Deprecated
AccountCreator.PasswordStatus setPassword(@Nullable
 String password)

Deprecated.

11/06/2024 use AccountManagerServices instead

Set the password.

Parameters:

password - The password to set

Returns:

AccountCreator.PasswordStatus.Ok if everything is OK, or specific(s) error(s)
otherwise.

getPhoneCountryCode

@Deprecated
@Nullable
String getPhoneCountryCode()

Deprecated.

11/06/2024 use AccountManagerServices instead

Get the international prefix.

Returns:

The international prefix (or phone country code) of the AccountCreator
.

getPhoneNumber

@Deprecated
@Nullable
String getPhoneNumber()

Deprecated.

11/06/2024 use AccountManagerServices instead

Get the RFC 3966 normalized phone number.

Returns:

The phone number of the AccountCreator.

getPnParam

@Deprecated
@Nullable
String getPnParam()

Deprecated.

11/06/2024 use AccountManagerServices instead

Get the param to be used by the backend to send the push notification to the
device asking for an auth token.

Returns:

The pn_param set, if any

setPnParam

@Deprecated
void setPnParam(@Nullable
 String pnParam)

Deprecated.

11/06/2024 use AccountManagerServices instead

Set the param to be used by the backend to send the push notification to the
device asking for an auth token.

Parameters:

pnParam - The pn_param to set

getPnPrid

@Deprecated
@Nullable
String getPnPrid()

Deprecated.

11/06/2024 use AccountManagerServices instead

Get the prid to be used by the backend to send the push notification to the
device asking for an auth token.

Returns:

The pn_prid set, if any

setPnPrid

@Deprecated
void setPnPrid(@Nullable
 String pnPrid)

Deprecated.

11/06/2024 use AccountManagerServices instead

Set the prid to be used by the backend to send the push notification to the
device asking for an auth token.

Parameters:

pnPrid - The pn_prid to set

getPnProvider

@Deprecated
@Nullable
String getPnProvider()

Deprecated.

11/06/2024 use AccountManagerServices instead

Get the provider to be used by the backend to send the push notification to the
device asking for an auth token.

Returns:

The pn_provider set, if any

setPnProvider

@Deprecated
void setPnProvider(@Nullable
 String pnProvider)

Deprecated.

11/06/2024 use AccountManagerServices instead

Set the provider to be used by the backend to send the push notification to the
device asking for an auth token.

Parameters:

pnProvider - The pn_provider to set

setProxyConfig

@Deprecated
void setProxyConfig(@Nullable
 ProxyConfig cfg)

Deprecated.

11/06/2024 use AccountManagerServices instead

Assign a proxy config pointer to the LinphoneAccountCreator.

Parameters:

cfg - The LinphoneProxyConfig to associate with the
LinphoneAccountCreator.

getRoute

@Nullable
String getRoute()

Get the route.

Returns:

The route of the AccountCreator.

setRoute

AccountCreator.Status setRoute(@Nullable
 String route)

Set the route.

Parameters:

route - The route to set

Returns:

AccountCreator.Status.RequestOk if everything is OK, or a specific error
otherwise.

getSetAsDefault

@Deprecated
boolean getSetAsDefault()

Deprecated.

11/06/2024 use AccountManagerServices instead

Get the set_as_default property.

Returns:

true if account will be set as default, false otherwise.

getToken

@Deprecated
@Nullable
String getToken()

Deprecated.

11/06/2024 use AccountManagerServices instead

Get the authentication token set (if any) to be used to authenticate next
queries, if required.

Returns:

The token set, if any

setToken

@Deprecated
void setToken(@Nullable
 String token)

Deprecated.

11/06/2024 use AccountManagerServices instead

Set the authentication token received by push notification to be used to
authenticate next queries, if required.

Parameters:

token - The token to set

getTransport

@Deprecated
TransportType getTransport()

Deprecated.

11/06/2024 use AccountManagerServices instead

Get Transport.

Returns:

The TransportType of the creator.

setTransport

@Deprecated
AccountCreator.TransportStatus setTransport(TransportType transport)

Deprecated.

11/06/2024 use AccountManagerServices instead

Set Transport.

Parameters:

transport - The TransportType to set

Returns:

AccountCreator.TransportStatus.Ok if everything is OK, or a specific error
otherwise.

getUsername

@Deprecated
@Nullable
String getUsername()

Deprecated.

11/06/2024 use AccountManagerServices instead

Get the username.

Returns:

The username of the AccountCreator.

setUsername

@Deprecated
AccountCreator.UsernameStatus setUsername(@Nullable
 String username)

Deprecated.

11/06/2024 use AccountManagerServices instead

Set the username.

Parameters:

username - The username to set

Returns:

AccountCreator.UsernameStatus.Ok if everything is OK, or a specific error
otherwise.

activateAccount

@Deprecated
AccountCreator.Status activateAccount()

Deprecated.

11/06/2024 use AccountManagerServices instead

Send a request to activate an account on server.

Returns:

AccountCreator.Status.RequestOk if the request has been sent, AccountCreator.Status.RequestFailed
otherwise

activateAlias

@Deprecated
AccountCreator.Status activateAlias()

Deprecated.

11/06/2024 use AccountManagerServices instead

Send a request to activate an alias.

Returns:

AccountCreator.Status.RequestOk if the request has been sent, AccountCreator.Status.RequestFailed
otherwise

createAccount

@Deprecated
AccountCreator.Status createAccount()

Deprecated.

11/06/2024 use AccountManagerServices instead

Send a request to create an account on server.

Returns:

AccountCreator.Status.RequestOk if the request has been sent, AccountCreator.Status.RequestFailed
otherwise

createAccountInCore

@Deprecated
@Nullable
Account createAccountInCore()

Deprecated.

11/06/2024 use AccountManagerServices instead

Create and configure a Account and a AuthInfo from informations
set in the AccountCreator.

Returns:

A Account object if successful, null otherwise.

createProxyConfig

@Deprecated
@Nullable
ProxyConfig createProxyConfig()

Deprecated.

05/05/2023 Use createAccountInCore() instead.

Create and configure a proxy config and a authentication info for an account
creator.

Returns:

A ProxyConfig object if successful, null otherwise.

createPushAccount

@Deprecated
AccountCreator.Status createPushAccount()

Deprecated.

11/06/2024 use AccountManagerServices instead

Send a request to create a push account on server.

Push accounts are used in account dependent situation when account cannot send
push notifications. A username and password are automatically generated, an
account is automatically activated.

Returns:

AccountCreator.Status.RequestOk if the request has been sent, AccountCreator.Status.RequestFailed
otherwise

isAccountActivated

@Deprecated
AccountCreator.Status isAccountActivated()

Deprecated.

11/06/2024 use AccountManagerServices instead

Send a request to know if an account is activated on server.

Returns:

AccountCreator.Status.RequestOk if the request has been sent, AccountCreator.Status.RequestFailed
otherwise

isAccountExist

@Deprecated
AccountCreator.Status isAccountExist()

Deprecated.

11/06/2024 use AccountManagerServices instead

Send a request to know the existence of account on server.

Returns:

AccountCreator.Status.RequestOk if the request has been sent, AccountCreator.Status.RequestFailed
otherwise

isAccountLinked

@Deprecated
AccountCreator.Status isAccountLinked()

Deprecated.

11/06/2024 use AccountManagerServices instead

Send a request to know if an account is linked.

Returns:

AccountCreator.Status.RequestOk if the request has been sent, AccountCreator.Status.RequestFailed
otherwise

isAliasUsed

@Deprecated
AccountCreator.Status isAliasUsed()

Deprecated.

11/06/2024 use AccountManagerServices instead

Send a request to know if an alias is used.

Returns:

AccountCreator.Status.RequestOk if the request has been sent, AccountCreator.Status.RequestFailed
otherwise

linkAccount

@Deprecated
AccountCreator.Status linkAccount()

Deprecated.

11/06/2024 use AccountManagerServices instead

Send a request to link an account to an alias.

Returns:

AccountCreator.Status.RequestOk if the request has been sent, AccountCreator.Status.RequestFailed
otherwise

loginLinphoneAccount

@Deprecated
AccountCreator.Status loginLinphoneAccount()

Deprecated.

11/06/2024 use AccountManagerServices instead

Send a request to get the password & algorithm of an account using the
confirmation key.

Returns:

AccountCreator.Status.RequestOk if everything is OK, or a specific error
otherwise.

recoverAccount

@Deprecated
AccountCreator.Status recoverAccount()

Deprecated.

11/06/2024 use AccountManagerServices instead

Send a request to recover an account.

Returns:

AccountCreator.Status.RequestOk if the request has been sent, AccountCreator.Status.RequestFailed
otherwise

requestAccountCreationRequestToken

@Deprecated
AccountCreator.Status requestAccountCreationRequestToken()

Deprecated.

11/06/2024 use AccountManagerServices instead

Request an account creation "request_token" to be used on account creations.

The request_token is retrieved from the callback
linphone_account_creator_cbs_get_account_creation_request_token

Returns:

AccountCreator.Status.RequestOk if everything is OK, or a specific error
otherwise.

requestAccountCreationTokenUsingRequestToken

@Deprecated
AccountCreator.Status requestAccountCreationTokenUsingRequestToken()

Deprecated.

11/06/2024 use AccountManagerServices instead

Send a request to get a token to be used for account creation from a
request_token.

The token is retrieved from the callback
linphone_account_creator_cbs_get_account_creation_token_using_request_token

Returns:

AccountCreator.Status.RequestOk if the request has been sent, AccountCreator.Status.RequestFailed
otherwise

requestAuthToken

@Deprecated
AccountCreator.Status requestAuthToken()

Deprecated.

11/06/2024 use AccountManagerServices instead

Request an auth token to be send by the backend by push notification.

Returns:

AccountCreator.Status.RequestOk if everything is OK, or a specific error
otherwise.

reset

@Deprecated
void reset()

Deprecated.

11/06/2024 use AccountManagerServices instead

Reset the account creator entries like username, password, phone number...

setPhoneNumber

@Deprecated
int setPhoneNumber(@Nullable
 String phoneNumber,
 @Nullable
 String countryCode)

Deprecated.

11/06/2024 use AccountManagerServices instead

Set the phone number normalized.

Parameters:

phoneNumber - The phone number to set

countryCode - Country code to associate phone number with

Returns:

AccountCreator.PhoneNumberStatus.Ok if everything is OK, or specific(s)
error(s) otherwise.

updateAccount

@Deprecated
AccountCreator.Status updateAccount()

Deprecated.

11/06/2024 use AccountManagerServices instead

Send a request to update an account.

Returns:

AccountCreator.Status.RequestOk if the request has been sent, AccountCreator.Status.RequestFailed
otherwise

useTestAdminAccount

@Deprecated
void useTestAdminAccount()

Deprecated.

11/06/2024 use AccountManagerServices instead

Require the account creator to use special "test admin account".

warning: The "test admin account" is a special feature required for automated
test, and requires the APP_EVERYONE_IS_ADMIN property to be enabled on the
remote Flexisip Account Manager (FlexiAPI). This feature must never be turned
on for a production-stage app.

create

@Deprecated
@NonNull
AccountCreator create(@NonNull
 Core core)

Deprecated.

11/06/2024 use AccountManagerServices instead

Create a AccountCreator and set Linphone Request callbacks.

Parameters:

core - The Core used for the XML-RPC communication

Returns:

The new AccountCreator object.

addListener

void addListener(AccountCreatorListener listener)

removeListener

void removeListener(AccountCreatorListener listener)

setUserData

void setUserData(Object data)

Sets the object to store in this object user's data

Parameters:

data - the object to store

getUserData

Object getUserData()

Gets the object stored in this object user's data

Returns:

the object store if any, null otherwise

getNativePointer

long getNativePointer()

Gets the native pointer used by this class to make native method calls.

Returns:

the nativer pointer, as long

toString

String toString()

Overrides:

toString in class Object