Class 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/.
Inherited Members
Namespace: Linphone
Assembly: cs.temp.dll.dll
Syntax
public class AccountCreator : LinphoneObject
Properties
ActivationCode
Get the activation code.
Declaration
public string ActivationCode { get; set; }
Property Value
Type | Description |
---|---|
System.String | The activation code of the AccountCreator. |
Algorithm
Get the algorithm configured in the account creator.
Declaration
public string Algorithm { get; set; }
Property Value
Type | Description |
---|---|
System.String | The algorithm of the AccountCreator. |
AsDefault
Set the set_as_default property.
Declaration
public bool AsDefault { set; }
Property Value
Type | Description |
---|---|
System.Boolean | RequestOk if everything is OK, or a specific error otherwise. |
CurrentCallbacks
Get the current LinphoneAccountCreatorCbs object associated with a LinphoneAccountCreator.
Declaration
public AccountCreatorListener CurrentCallbacks { get; }
Property Value
Type | Description |
---|---|
AccountCreatorListener | The current LinphoneAccountCreatorCbs object associated with the LinphoneAccountCreator. |
DisplayName
Get the display name.
Declaration
public string DisplayName { get; set; }
Property Value
Type | Description |
---|---|
System.String | The display name of the AccountCreator. |
Domain
Get the domain.
Declaration
public string Domain { get; set; }
Property Value
Type | Description |
---|---|
System.String | The domain of the AccountCreator. |
Get the email.
Declaration
public string Email { get; set; }
Property Value
Type | Description |
---|---|
System.String | The email of the AccountCreator. |
Ha1
Get the ha1.
Declaration
public string Ha1 { get; set; }
Property Value
Type | Description |
---|---|
System.String | The ha1 of the AccountCreator. |
Language
Get the language use in email of SMS.
Declaration
public string Language { get; set; }
Property Value
Type | Description |
---|---|
System.String | The language of the AccountCreator. |
Listener
Declaration
public AccountCreatorListener Listener { get; }
Property Value
Type | Description |
---|---|
AccountCreatorListener |
Password
Get the password.
Declaration
public string Password { get; set; }
Property Value
Type | Description |
---|---|
System.String | The password of the AccountCreator. |
PhoneNumber
Get the RFC 3966 normalized phone number.
Declaration
public string PhoneNumber { get; }
Property Value
Type | Description |
---|---|
System.String | The phone number of the AccountCreator. |
ProxyConfig
Assign a proxy config pointer to the LinphoneAccountCreator.
Declaration
public ProxyConfig ProxyConfig { set; }
Property Value
Type | Description |
---|---|
ProxyConfig |
Route
Get the route.
Declaration
public string Route { get; set; }
Property Value
Type | Description |
---|---|
System.String | The route of the AccountCreator. |
SetAsDefault
Get the set_as_default property.
Declaration
public bool SetAsDefault { get; }
Property Value
Type | Description |
---|---|
System.Boolean | true if account will be set as default, false otherwise. |
Transport
Get Transport.
Declaration
public TransportType Transport { get; set; }
Property Value
Type | Description |
---|---|
TransportType | The TransportType of the creator. |
Username
Get the username.
Declaration
public string Username { get; set; }
Property Value
Type | Description |
---|---|
System.String | The username of the AccountCreator. |
Methods
ActivateAccount()
Send a request to activate an account on server.
Declaration
public AccountCreatorStatus ActivateAccount()
Returns
Type | Description |
---|---|
AccountCreatorStatus | RequestOk if the request has been sent, RequestFailed otherwise |
ActivateAlias()
Send a request to activate an alias.
Declaration
public AccountCreatorStatus ActivateAlias()
Returns
Type | Description |
---|---|
AccountCreatorStatus | RequestOk if the request has been sent, RequestFailed otherwise |
CreateAccount()
Send a request to create an account on server.
Declaration
public AccountCreatorStatus CreateAccount()
Returns
Type | Description |
---|---|
AccountCreatorStatus | RequestOk if the request has been sent, RequestFailed otherwise |
CreateProxyConfig()
Create and configure a proxy config and a authentication info for an account creator.
Declaration
public ProxyConfig CreateProxyConfig()
Returns
Type | Description |
---|---|
ProxyConfig | A ProxyConfig object if successful, null otherwise. |
Finalize()
Declaration
protected void Finalize()
IsAccountActivated()
Send a request to know if an account is activated on server.
Declaration
public AccountCreatorStatus IsAccountActivated()
Returns
Type | Description |
---|---|
AccountCreatorStatus | RequestOk if the request has been sent, RequestFailed otherwise |
IsAccountExist()
Send a request to know the existence of account on server.
Declaration
public AccountCreatorStatus IsAccountExist()
Returns
Type | Description |
---|---|
AccountCreatorStatus | RequestOk if the request has been sent, RequestFailed otherwise |
IsAccountLinked()
Send a request to know if an account is linked.
Declaration
public AccountCreatorStatus IsAccountLinked()
Returns
Type | Description |
---|---|
AccountCreatorStatus | RequestOk if the request has been sent, RequestFailed otherwise |
IsAliasUsed()
Send a request to know if an alias is used.
Declaration
public AccountCreatorStatus IsAliasUsed()
Returns
Type | Description |
---|---|
AccountCreatorStatus | RequestOk if the request has been sent, RequestFailed otherwise |
LinkAccount()
Send a request to link an account to an alias.
Declaration
public AccountCreatorStatus LinkAccount()
Returns
Type | Description |
---|---|
AccountCreatorStatus | RequestOk if the request has been sent, RequestFailed otherwise |
LoginLinphoneAccount()
Send a request to get the password & algorithm of an account using the confirmation key.
Declaration
public AccountCreatorStatus LoginLinphoneAccount()
Returns
Type | Description |
---|---|
AccountCreatorStatus | RequestOk if everything is OK, or a specific error otherwise. |
RecoverAccount()
Send a request to recover an account.
Declaration
public AccountCreatorStatus RecoverAccount()
Returns
Type | Description |
---|---|
AccountCreatorStatus | RequestOk if the request has been sent, RequestFailed otherwise |
Reset()
Reset the account creator entries like username, password, phone number...
Declaration
public void Reset()
SetPhoneNumber(String, String)
Set the phone number normalized.
Declaration
public uint SetPhoneNumber(string phoneNumber, string countryCode)
Parameters
Type | Name | Description |
---|---|---|
System.String | phoneNumber | The phone number to set |
System.String | countryCode | Country code to associate phone number with |
Returns
Type | Description |
---|---|
System.UInt32 | Ok if everything is OK, or specific(s) error(s) otherwise. |
UpdateAccount()
Send a request to update an account.
Declaration
public AccountCreatorStatus UpdateAccount()
Returns
Type | Description |
---|---|
AccountCreatorStatus | RequestOk if the request has been sent, RequestFailed otherwise |