Class AccountManagerServices

Creates and manage SIP user accounts remotely, using the REST API of the Flexisip Account Manager.

Inheritance

System.Object

LinphoneObject

AccountManagerServices

Inherited Members

LinphoneObject.linphone_pointer_to_string(IntPtr)

LinphoneObject.linphone_string_to_pointer(String)

LinphoneObject.StringArrayToBctbxList(IEnumerable<String>)

LinphoneObject.CleanStringArrayPtrs(IntPtr)

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: Linphone

Assembly: cs.temp.dll.dll

Syntax

public class AccountManagerServices : LinphoneObject

Remarks

See : https://gitlab.linphone.org/BC/public/flexisip-account-manager

Properties

Language

Gets the configurer preferred language, if set.

Declaration

public string Language { get; set; }

Property Value

Type	Description
System.String	the language previously set, if any (otherwise null). @maybenil

Methods

CreateDeleteDeviceRequest(Address, AccountDevice)

Requests to delete a device from the list of currently known devices.

Declaration

public AccountManagerServicesRequest CreateDeleteDeviceRequest(Address sipIdentity, AccountDevice device)

Parameters

Type	Name	Description
Address	sipIdentity	the SIP identity URI that identifies your account for which you want the devices list. @notnil
AccountDevice	device	the Linphone.AccountDevice to delete. @notnil

Returns

Type	Description
AccountManagerServicesRequest	the Linphone.AccountManagerServicesRequest request object. @notnil

CreateGetAccountCreationRequestTokenRequest()

Requests a an account creation request token that once validated using the URL returned by this method upon success, will allow you to call Linphone.AccountManagerServices.CreateGetAccountCreationTokenFromRequestTokenRequest() to obtain a valid account creation token.

Once the account creation token is obtained, you can call Linphone.AccountManagerServices.CreateNewAccountUsingTokenRequest().

Declaration

public AccountManagerServicesRequest CreateGetAccountCreationRequestTokenRequest()

Returns

Type	Description
AccountManagerServicesRequest	the Linphone.AccountManagerServicesRequest request object. @notnil

CreateGetAccountCreationTokenFromRequestTokenRequest(String)

Converts an account creation request token obtained by linphone_account_manager_services_request_account_creation_request_token to an account creation token.

The obtained token can be used to call Linphone.AccountManagerServices.CreateNewAccountUsingTokenRequest().

Declaration

public AccountManagerServicesRequest CreateGetAccountCreationTokenFromRequestTokenRequest(string requestToken)

Parameters

Type	Name	Description
System.String	requestToken	the token obtained previously and validated using your web browser. @notnil

Returns

Type	Description
AccountManagerServicesRequest	the Linphone.AccountManagerServicesRequest request object. @notnil

CreateGetDevicesListRequest(Address)

Requests the list of devices currently known.

Declaration

public AccountManagerServicesRequest CreateGetDevicesListRequest(Address sipIdentity)

Parameters

Type	Name	Description
Address	sipIdentity	the SIP identity URI that identifies your account for which you want the devices list. @notnil

Returns

Type	Description
AccountManagerServicesRequest	the Linphone.AccountManagerServicesRequest request object. @notnil

CreateLinkEmailToAccountUsingCodeRequest(Address, String)

Validates the link between an email address and an account using a code received by email after calling Linphone.AccountManagerServices.CreateSendEmailLinkingCodeByEmailRequest()

Declaration

public AccountManagerServicesRequest CreateLinkEmailToAccountUsingCodeRequest(Address sipIdentity, string code)

Parameters

Type	Name	Description
Address	sipIdentity	the SIP identity URI that identifies the account to which you want to link the email address to. @notnil
System.String	code	the code received by email. @notnil

Returns

Type	Description
AccountManagerServicesRequest	the Linphone.AccountManagerServicesRequest request object. @notnil

CreateLinkPhoneNumberToAccountUsingCodeRequest(Address, String)

Validates the link between a phone number and an account using a code received by SMS after calling Linphone.AccountManagerServices.CreateSendPhoneNumberLinkingCodeBySmsRequest()

Declaration

public AccountManagerServicesRequest CreateLinkPhoneNumberToAccountUsingCodeRequest(Address sipIdentity, string code)

Parameters

Type	Name	Description
Address	sipIdentity	the SIP identity URI that identifies the account to which you want to link the phone number to. @notnil
System.String	code	the code received by SMS. @notnil

Returns

Type	Description
AccountManagerServicesRequest	the Linphone.AccountManagerServicesRequest request object. @notnil

CreateNewAccountUsingTokenRequest(String, String, String, String)

Creates an account using an account creation token, for example obtained using Linphone.AccountManagerServices.CreateSendAccountCreationTokenByPushRequest().

Declaration

public AccountManagerServicesRequest CreateNewAccountUsingTokenRequest(string username, string password, string algorithm, string token)

Parameters

Type	Name	Description
System.String	username	the username of the newly created account. @notnil
System.String	password	the password to use for the newly created account. @notnil
System.String	algorithm	the algorithm to use to hash the password (must be either MD5 or SHA-256). @notnil
System.String	token	the account creation token obtained previously. @notnil

Returns

Type	Description
AccountManagerServicesRequest	the Linphone.AccountManagerServicesRequest request object. @notnil

CreateSendAccountCreationTokenByPushRequest(String, String, String)

Requests a push notification to be sent to device, containing a valid account creation token.

Provider, param & prid can be obtained from Linphone.Core.PushNotificationConfig, but on iOS may need some modifications (depending on debug mode for example). Once the token is obtained, you can call Linphone.AccountManagerServices.CreateNewAccountUsingTokenRequest().

Declaration

public AccountManagerServicesRequest CreateSendAccountCreationTokenByPushRequest(string pnProvider, string pnParam, string pnPrid)

Parameters

Type	Name	Description
System.String	pnProvider	The provider, for example "apns.dev". @notnil
System.String	pnParam	The parameters, for example "ABCD1234.org.linphone.phone.remote". @notnil
System.String	pnPrid	The prid, also known as push token. @notnil

Returns

Type	Description
AccountManagerServicesRequest	the Linphone.AccountManagerServicesRequest request object. @notnil

CreateSendAccountRecoveryTokenByPushRequest(String, String, String)

Requests a push notification to be sent to device, containing a valid account recovery token.

Provider, param & prid can be obtained from Linphone.Core.PushNotificationConfig, but on iOS may need some modifications (depending on debug mode for example). Once the token is obtained, you can use it to open the recovery webpage on the flexisip account manager at https://account_manager.domain.tld/recovery/phone/<recovery token>?phone=<phone number> Provider, param & prid can be obtained from Linphone.Core.PushNotificationConfig, but on iOS may need some modifications (depending on debug mode for example). Once the token is obtained, you can use it to open the recovery webpage on the flexisip account manager at https://account_manager.domain.tld/recovery/phone/<recovery token>?phone=<phone number>

Declaration

public AccountManagerServicesRequest CreateSendAccountRecoveryTokenByPushRequest(string pnProvider, string pnParam, string pnPrid)

Parameters

Type	Name	Description
System.String	pnProvider	The provider, for example "apns.dev". @notnil
System.String	pnParam	The parameters, for example "ABCD1234.org.linphone.phone.remote". @notnil
System.String	pnPrid	The prid, also known as push token. @notnil

Returns

Type	Description
AccountManagerServicesRequest	the Linphone.AccountManagerServicesRequest request object. @notnil

CreateSendEmailLinkingCodeByEmailRequest(Address, String)

Requests a code to be sent to a given email address, that can be used later to associate said email to an account using Linphone.AccountManagerServices.CreateLinkEmailToAccountUsingCodeRequest().

Declaration

public AccountManagerServicesRequest CreateSendEmailLinkingCodeByEmailRequest(Address sipIdentity, string emailAddress)

Parameters

Type	Name	Description
Address	sipIdentity	the SIP identity URI that identifies the account to which you want to link the email address to. @notnil
System.String	emailAddress	the email address to which to send the code to. @notnil

Returns

Type	Description
AccountManagerServicesRequest	the Linphone.AccountManagerServicesRequest request object. @notnil

CreateSendPhoneNumberLinkingCodeBySmsRequest(Address, String)

Requests a code to be sent to a given phone number, that can be used later to associate said phone number to an account using Linphone.AccountManagerServices.CreateLinkPhoneNumberToAccountUsingCodeRequest().

Declaration

public AccountManagerServicesRequest CreateSendPhoneNumberLinkingCodeBySmsRequest(Address sipIdentity, string phoneNumber)

Parameters

Type	Name	Description
Address	sipIdentity	the SIP identity URI that identifies the account to which you want to link the phone number to. @notnil
System.String	phoneNumber	the phone number to which to send the code by SMS. @notnil

Returns

Type	Description
AccountManagerServicesRequest	the Linphone.AccountManagerServicesRequest request object. @notnil