Liblinphone  5.5.0
Linphone.AccountManagerServices Class Reference
Inheritance diagram for Linphone.AccountManagerServices:
Linphone.LinphoneObject

Public Member Functions

Linphone.AccountManagerServicesRequest CreateDeleteDeviceRequest (Linphone.Address sipIdentity, Linphone.AccountDevice device)
 
Linphone.AccountManagerServicesRequest CreateGetAccountCreationRequestTokenRequest ()
 
Linphone.AccountManagerServicesRequest CreateGetAccountCreationTokenFromRequestTokenRequest (string requestToken)
 
Linphone.AccountManagerServicesRequest CreateGetDevicesListRequest (Linphone.Address sipIdentity)
 
Linphone.AccountManagerServicesRequest CreateLinkEmailToAccountUsingCodeRequest (Linphone.Address sipIdentity, string code)
 
Linphone.AccountManagerServicesRequest CreateLinkPhoneNumberToAccountUsingCodeRequest (Linphone.Address sipIdentity, string code)
 
Linphone.AccountManagerServicesRequest CreateNewAccountUsingTokenRequest (string username, string password, string algorithm, string token)
 
Linphone.AccountManagerServicesRequest CreateSendAccountCreationTokenByPushRequest (string pnProvider, string pnParam, string pnPrid)
 
Linphone.AccountManagerServicesRequest CreateSendAccountRecoveryTokenByPushRequest (string pnProvider, string pnParam, string pnPrid)
 
Linphone.AccountManagerServicesRequest CreateSendEmailLinkingCodeByEmailRequest (Linphone.Address sipIdentity, string emailAddress)
 
Linphone.AccountManagerServicesRequest CreateSendPhoneNumberLinkingCodeBySmsRequest (Linphone.Address sipIdentity, string phoneNumber)
 

Properties

string Language [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

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

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

Member Function Documentation

Linphone.AccountManagerServicesRequest Linphone.AccountManagerServices.CreateDeleteDeviceRequest ( Linphone.Address  sipIdentity,
Linphone.AccountDevice  device 
)
inline

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

Parameters
sipIdentitythe SIP identity URI that identifies your account for which you want the devices list.
devicethe Linphone.AccountDevice to delete.
Returns
the Linphone.AccountManagerServicesRequest request object.
Linphone.AccountManagerServicesRequest Linphone.AccountManagerServices.CreateGetAccountCreationRequestTokenRequest ( )
inline

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().

Returns
the Linphone.AccountManagerServicesRequest request object.
Linphone.AccountManagerServicesRequest Linphone.AccountManagerServices.CreateGetAccountCreationTokenFromRequestTokenRequest ( string  requestToken)
inline

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().

Parameters
requestTokenthe token obtained previously and validated using your web browser.
Returns
the Linphone.AccountManagerServicesRequest request object.
Linphone.AccountManagerServicesRequest Linphone.AccountManagerServices.CreateGetDevicesListRequest ( Linphone.Address  sipIdentity)
inline

Requests the list of devices currently known.

Parameters
sipIdentitythe SIP identity URI that identifies your account for which you want the devices list.
Returns
the Linphone.AccountManagerServicesRequest request object.
Linphone.AccountManagerServicesRequest Linphone.AccountManagerServices.CreateLinkEmailToAccountUsingCodeRequest ( Linphone.Address  sipIdentity,
string  code 
)
inline

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

Parameters
sipIdentitythe SIP identity URI that identifies the account to which you want to link the email address to.
codethe code received by email.
Returns
the Linphone.AccountManagerServicesRequest request object.
Linphone.AccountManagerServicesRequest Linphone.AccountManagerServices.CreateLinkPhoneNumberToAccountUsingCodeRequest ( Linphone.Address  sipIdentity,
string  code 
)
inline

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

Parameters
sipIdentitythe SIP identity URI that identifies the account to which you want to link the phone number to.
codethe code received by SMS.
Returns
the Linphone.AccountManagerServicesRequest request object.
Linphone.AccountManagerServicesRequest Linphone.AccountManagerServices.CreateNewAccountUsingTokenRequest ( string  username,
string  password,
string  algorithm,
string  token 
)
inline

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

Parameters
usernamethe username of the newly created account.
passwordthe password to use for the newly created account.
algorithmthe algorithm to use to hash the password (must be either MD5 or SHA-256).
tokenthe account creation token obtained previously.
Returns
the Linphone.AccountManagerServicesRequest request object.
Linphone.AccountManagerServicesRequest Linphone.AccountManagerServices.CreateSendAccountCreationTokenByPushRequest ( string  pnProvider,
string  pnParam,
string  pnPrid 
)
inline

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().

Parameters
pnProviderThe provider, for example "apns.dev".
pnParamThe parameters, for example "ABCD1234.org.linphone.phone.remote".
pnPridThe prid, also known as push token.
Returns
the Linphone.AccountManagerServicesRequest request object.
Linphone.AccountManagerServicesRequest Linphone.AccountManagerServices.CreateSendAccountRecoveryTokenByPushRequest ( string  pnProvider,
string  pnParam,
string  pnPrid 
)
inline

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/&lt;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/&lt;recovery token>?phone=<phone number>

Parameters
pnProviderThe provider, for example "apns.dev".
pnParamThe parameters, for example "ABCD1234.org.linphone.phone.remote".
pnPridThe prid, also known as push token.
Returns
the Linphone.AccountManagerServicesRequest request object.
Linphone.AccountManagerServicesRequest Linphone.AccountManagerServices.CreateSendEmailLinkingCodeByEmailRequest ( Linphone.Address  sipIdentity,
string  emailAddress 
)
inline

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().

Parameters
sipIdentitythe SIP identity URI that identifies the account to which you want to link the email address to.
emailAddressthe email address to which to send the code to.
Returns
the Linphone.AccountManagerServicesRequest request object.
Linphone.AccountManagerServicesRequest Linphone.AccountManagerServices.CreateSendPhoneNumberLinkingCodeBySmsRequest ( Linphone.Address  sipIdentity,
string  phoneNumber 
)
inline

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().

Parameters
sipIdentitythe SIP identity URI that identifies the account to which you want to link the phone number to.
phoneNumberthe phone number to which to send the code by SMS.
Returns
the Linphone.AccountManagerServicesRequest request object.

Property Documentation

string Linphone.AccountManagerServices.Language
getset

Gets the configurer preferred language, if set.

Returns
the language previously set, if any (otherwise null).

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