Liblinphone  5.5.0
Public Member Functions | Static Public Member Functions | Properties | List of all members
Linphone.AccountCreator Class Reference
Inheritance diagram for Linphone.AccountCreator:
Linphone.LinphoneObject

Public Member Functions

Linphone.AccountCreatorStatus ActivateAccount ()
 
Linphone.AccountCreatorStatus ActivateAlias ()
 
Linphone.AccountCreatorStatus CreateAccount ()
 
Linphone.Account CreateAccountInCore ()
 
Linphone.ProxyConfig CreateProxyConfig ()
 
Linphone.AccountCreatorStatus CreatePushAccount ()
 
Linphone.AccountCreatorStatus IsAccountActivated ()
 
Linphone.AccountCreatorStatus IsAccountExist ()
 
Linphone.AccountCreatorStatus IsAccountLinked ()
 
Linphone.AccountCreatorStatus IsAliasUsed ()
 
Linphone.AccountCreatorStatus LinkAccount ()
 
Linphone.AccountCreatorStatus LoginLinphoneAccount ()
 
Linphone.AccountCreatorStatus RecoverAccount ()
 
Linphone.AccountCreatorStatus RequestAccountCreationRequestToken ()
 
Linphone.AccountCreatorStatus RequestAccountCreationTokenUsingRequestToken ()
 
Linphone.AccountCreatorStatus RequestAuthToken ()
 
void Reset ()
 
uint SetPhoneNumber (string phoneNumber, string countryCode)
 
Linphone.AccountCreatorStatus UpdateAccount ()
 
void UseTestAdminAccount ()
 

Static Public Member Functions

static Linphone.AccountCreator Create (Linphone.Core core)
 

Properties

AccountCreatorListener Listener [get, set]
 
Linphone.Account Account [set]
 
string AccountCreationRequestToken [get, set]
 
string ActivationCode [get, set]
 
string Algorithm [get, set]
 
bool AsDefault [set]
 
string DisplayName [get, set]
 
string Domain [get, set]
 
string Email [get, set]
 
string Ha1 [get, set]
 
string Language [get, set]
 
string Password [get, set]
 
string PhoneCountryCode [get]
 
string PhoneNumber [get]
 
string PnParam [get, set]
 
string PnPrid [get, set]
 
string PnProvider [get, set]
 
Linphone.ProxyConfig ProxyConfig [set]
 
string Route [get, set]
 
bool SetAsDefault [get]
 
string Token [get, set]
 
Linphone.TransportType Transport [get, set]
 
string Username [get, set]
 

Additional Inherited Members

- Protected Member Functions inherited from Linphone.LinphoneObject
static String linphone_pointer_to_string (IntPtr ptr)
 
static IntPtr linphone_string_to_pointer ([MarshalAs(LinphoneWrapper.ByteStringMarshalling)] String str)
 
IntPtr StringArrayToBctbxList (IEnumerable< string > stringlist)
 
void CleanStringArrayPtrs (IntPtr l)
 

Detailed Description

The object used to configure an account on a server via XML-RPC See: Override account creator request The object used to configure an account on a server via XML-RPC See: Override account creator request

Member Function Documentation

Linphone.AccountCreatorStatus Linphone.AccountCreator.ActivateAccount ( )
inline

Send a request to activate an account on server.

Returns
Linphone.AccountCreatorStatus.RequestOk if the request has been sent, Linphone.AccountCreatorStatus.RequestFailed otherwise

Deprecated : 11/06/2024 use Linphone.AccountManagerServices instead

Linphone.AccountCreatorStatus Linphone.AccountCreator.ActivateAlias ( )
inline

Send a request to activate an alias.

Returns
Linphone.AccountCreatorStatus.RequestOk if the request has been sent, Linphone.AccountCreatorStatus.RequestFailed otherwise

Deprecated : 11/06/2024 use Linphone.AccountManagerServices instead

static Linphone.AccountCreator Linphone.AccountCreator.Create ( Linphone.Core  core)
inlinestatic

Create a Linphone.AccountCreator and set Linphone Request callbacks.

Parameters
coreThe Linphone.Core used for the XML-RPC communication
Returns
The new Linphone.AccountCreator object.

Deprecated : 11/06/2024 use Linphone.AccountManagerServices instead

Linphone.AccountCreatorStatus Linphone.AccountCreator.CreateAccount ( )
inline

Send a request to create an account on server.

Returns
Linphone.AccountCreatorStatus.RequestOk if the request has been sent, Linphone.AccountCreatorStatus.RequestFailed otherwise

Deprecated : 11/06/2024 use Linphone.AccountManagerServices instead

Linphone.Account Linphone.AccountCreator.CreateAccountInCore ( )
inline

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

Returns
A Linphone.Account object if successful, null otherwise.

Deprecated : 11/06/2024 use Linphone.AccountManagerServices instead

Linphone.ProxyConfig Linphone.AccountCreator.CreateProxyConfig ( )
inline

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

Returns
A Linphone.ProxyConfig object if successful, null otherwise.

Deprecated : 05/05/2023 Use Linphone.AccountCreator.CreateAccountInCore() instead.

Linphone.AccountCreatorStatus Linphone.AccountCreator.CreatePushAccount ( )
inline

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
Linphone.AccountCreatorStatus.RequestOk if the request has been sent, Linphone.AccountCreatorStatus.RequestFailed otherwise

Deprecated : 11/06/2024 use Linphone.AccountManagerServices instead

Linphone.AccountCreatorStatus Linphone.AccountCreator.IsAccountActivated ( )
inline

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

Returns
Linphone.AccountCreatorStatus.RequestOk if the request has been sent, Linphone.AccountCreatorStatus.RequestFailed otherwise

Deprecated : 11/06/2024 use Linphone.AccountManagerServices instead

Linphone.AccountCreatorStatus Linphone.AccountCreator.IsAccountExist ( )
inline

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

Returns
Linphone.AccountCreatorStatus.RequestOk if the request has been sent, Linphone.AccountCreatorStatus.RequestFailed otherwise

Deprecated : 11/06/2024 use Linphone.AccountManagerServices instead

Linphone.AccountCreatorStatus Linphone.AccountCreator.IsAccountLinked ( )
inline

Send a request to know if an account is linked.

Returns
Linphone.AccountCreatorStatus.RequestOk if the request has been sent, Linphone.AccountCreatorStatus.RequestFailed otherwise

Deprecated : 11/06/2024 use Linphone.AccountManagerServices instead

Linphone.AccountCreatorStatus Linphone.AccountCreator.IsAliasUsed ( )
inline

Send a request to know if an alias is used.

Returns
Linphone.AccountCreatorStatus.RequestOk if the request has been sent, Linphone.AccountCreatorStatus.RequestFailed otherwise

Deprecated : 11/06/2024 use Linphone.AccountManagerServices instead

Linphone.AccountCreatorStatus Linphone.AccountCreator.LinkAccount ( )
inline

Send a request to link an account to an alias.

Returns
Linphone.AccountCreatorStatus.RequestOk if the request has been sent, Linphone.AccountCreatorStatus.RequestFailed otherwise

Deprecated : 11/06/2024 use Linphone.AccountManagerServices instead

Linphone.AccountCreatorStatus Linphone.AccountCreator.LoginLinphoneAccount ( )
inline

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

Returns
Linphone.AccountCreatorStatus.RequestOk if everything is OK, or a specific error otherwise.

Deprecated : 11/06/2024 use Linphone.AccountManagerServices instead

Linphone.AccountCreatorStatus Linphone.AccountCreator.RecoverAccount ( )
inline

Send a request to recover an account.

Returns
Linphone.AccountCreatorStatus.RequestOk if the request has been sent, Linphone.AccountCreatorStatus.RequestFailed otherwise

Deprecated : 11/06/2024 use Linphone.AccountManagerServices instead

Linphone.AccountCreatorStatus Linphone.AccountCreator.RequestAccountCreationRequestToken ( )
inline

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
Linphone.AccountCreatorStatus.RequestOk if everything is OK, or a specific error otherwise.

Deprecated : 11/06/2024 use Linphone.AccountManagerServices instead

Linphone.AccountCreatorStatus Linphone.AccountCreator.RequestAccountCreationTokenUsingRequestToken ( )
inline

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
Linphone.AccountCreatorStatus.RequestOk if the request has been sent, Linphone.AccountCreatorStatus.RequestFailed otherwise

Deprecated : 11/06/2024 use Linphone.AccountManagerServices instead

Linphone.AccountCreatorStatus Linphone.AccountCreator.RequestAuthToken ( )
inline

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

Returns
Linphone.AccountCreatorStatus.RequestOk if everything is OK, or a specific error otherwise.

Deprecated : 11/06/2024 use Linphone.AccountManagerServices instead

void Linphone.AccountCreator.Reset ( )
inline

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

Deprecated : 11/06/2024 use Linphone.AccountManagerServices instead

uint Linphone.AccountCreator.SetPhoneNumber ( string  phoneNumber,
string  countryCode 
)
inline

Set the phone number normalized.

Parameters
phoneNumberThe phone number to set
countryCodeCountry code to associate phone number with
Returns
Linphone.AccountCreatorPhoneNumberStatus.Ok if everything is OK, or specific(s) error(s) otherwise.

Deprecated : 11/06/2024 use Linphone.AccountManagerServices instead

Linphone.AccountCreatorStatus Linphone.AccountCreator.UpdateAccount ( )
inline

Send a request to update an account.

Returns
Linphone.AccountCreatorStatus.RequestOk if the request has been sent, Linphone.AccountCreatorStatus.RequestFailed otherwise

Deprecated : 11/06/2024 use Linphone.AccountManagerServices instead

void Linphone.AccountCreator.UseTestAdminAccount ( )
inline

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.

Deprecated : 11/06/2024 use Linphone.AccountManagerServices instead

Property Documentation

Linphone.Account Linphone.AccountCreator.Account
set

Assign a proxy config pointer to the LinphoneAccountCreator.

Parameters
accountThe LinphoneAccount to associate with the LinphoneAccountCreator.

Deprecated : 11/06/2024 use Linphone.AccountManagerServices instead

string Linphone.AccountCreator.AccountCreationRequestToken
getset

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

Returns
The token set, if any

Deprecated : 11/06/2024 use Linphone.AccountManagerServices instead

string Linphone.AccountCreator.ActivationCode
getset

Get the activation code.

Returns
The activation code of the Linphone.AccountCreator.

Deprecated : 11/06/2024 use Linphone.AccountManagerServices instead

string Linphone.AccountCreator.Algorithm
getset

Get the algorithm configured in the account creator.

Returns
The algorithm of the Linphone.AccountCreator.

Deprecated : 11/06/2024 use Linphone.AccountManagerServices instead

bool Linphone.AccountCreator.AsDefault
set

Set the set_as_default property.

Parameters
setAsDefaulttrue for the created proxy config to be set as default in Linphone.Core, false otherwise
Returns
Linphone.AccountCreatorStatus.RequestOk if everything is OK, or a specific error otherwise.

Deprecated : 11/06/2024 use Linphone.AccountManagerServices instead

string Linphone.AccountCreator.DisplayName
getset

Get the display name.

Returns
The display name of the Linphone.AccountCreator.

Deprecated : 11/06/2024 use Linphone.AccountManagerServices instead

string Linphone.AccountCreator.Domain
getset

Get the domain.

Returns
The domain of the Linphone.AccountCreator.

Deprecated : 11/06/2024 use Linphone.AccountManagerServices instead

string Linphone.AccountCreator.Email
getset

Get the email.

Returns
The email of the Linphone.AccountCreator.

Deprecated : 11/06/2024 use Linphone.AccountManagerServices instead

string Linphone.AccountCreator.Ha1
getset

Get the ha1.

Returns
The ha1 of the Linphone.AccountCreator.

Deprecated : 11/06/2024 use Linphone.AccountManagerServices instead

string Linphone.AccountCreator.Language
getset

Get the language use in email of SMS.

Returns
The language of the Linphone.AccountCreator.

Deprecated : 11/06/2024 use Linphone.AccountManagerServices instead

string Linphone.AccountCreator.Password
getset

Get the password.

Returns
The password of the Linphone.AccountCreator.

Deprecated : 11/06/2024 use Linphone.AccountManagerServices instead

string Linphone.AccountCreator.PhoneCountryCode
get

Get the international prefix.

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

Deprecated : 11/06/2024 use Linphone.AccountManagerServices instead

string Linphone.AccountCreator.PhoneNumber
get

Get the RFC 3966 normalized phone number.

Returns
The phone number of the Linphone.AccountCreator.

Deprecated : 11/06/2024 use Linphone.AccountManagerServices instead

string Linphone.AccountCreator.PnParam
getset

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

Deprecated : 11/06/2024 use Linphone.AccountManagerServices instead

string Linphone.AccountCreator.PnPrid
getset

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

Deprecated : 11/06/2024 use Linphone.AccountManagerServices instead

string Linphone.AccountCreator.PnProvider
getset

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

Deprecated : 11/06/2024 use Linphone.AccountManagerServices instead

Linphone.ProxyConfig Linphone.AccountCreator.ProxyConfig
set

Assign a proxy config pointer to the LinphoneAccountCreator.

Parameters
cfgThe LinphoneProxyConfig to associate with the LinphoneAccountCreator.

Deprecated : 11/06/2024 use Linphone.AccountManagerServices instead

string Linphone.AccountCreator.Route
getset

Get the route.

Returns
The route of the Linphone.AccountCreator.
bool Linphone.AccountCreator.SetAsDefault
get

Get the set_as_default property.

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

Deprecated : 11/06/2024 use Linphone.AccountManagerServices instead

string Linphone.AccountCreator.Token
getset

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

Returns
The token set, if any

Deprecated : 11/06/2024 use Linphone.AccountManagerServices instead

Linphone.TransportType Linphone.AccountCreator.Transport
getset

Get Transport.

Returns
The Linphone.TransportType of the creator.

Deprecated : 11/06/2024 use Linphone.AccountManagerServices instead

string Linphone.AccountCreator.Username
getset

Get the username.

Returns
The username of the Linphone.AccountCreator.

Deprecated : 11/06/2024 use Linphone.AccountManagerServices instead

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