APITalker
The class provides an interface for sending requests to the server.
Class Methods
changePassword
uint64_t changePassword (const std::string &login, const std::string &oldPlainPasswd, const std::string &newPlainPasswd)
Asynchronously performs password change. This method tries to change a User's password.
Parameters
- login
- User's login. Cannot be null.
- oldPlainPasswd
- User's old password. Cannot be null, length cannot be less than 6 symbols, first and last symbols cannot be 'space'.
- newPlainPasswd
- User's new password. Cannot be null, length cannot be less than 6 symbols, first and last symbols cannot be 'space'.
Return value
Unique operation id.
getAccountStatus
uint64_t getAccountStatus ()
Asynchronously requests Users's account status.
Return value
Unique operation id.
See also
getDeviceStatus
uint64_t getDeviceStatus ()
Asynchronously requests Users's device status.
Return value
Unique operation id.
See also
getIPPlansByServiceList
uint64_t getIPPlansByServiceList ()
Asynchronously requests a list of personal IP's purchase plans.
Return value
Unique operation id.
See also
tVPNPurchasesByService.
getIPPlansList
uint64_t getIPPlansList ()
Asynchronously requests a list of personal IP's purchase plans.
Return value
Unique operation id.
See also
tVPNPurchases.
getPersonalIPList
uint64_t getPersonalIPList ()
Asynchronously requests a list of personal IP's available for purchase.
Return value
Unique operation id.
See also
getPersonalServersList
uint64_t getPersonalServersList ()
Asynchronously requests a list of personal server purchase plans.
Return value
Unique operation id.
See also
getPurchasesByServiceList
uint64_t getPurchasesByServiceList ()
Asynchronously requests a list of purchase plans.
Return value
Unique operation id.
See also
tVPNPurchasesByService.
getPurchasesList
uint64_t getPurchasesList ()
Asynchronously requests a list of purchase plans.
Return value
Unique operation id.
See also
tVPNPurchases.
getServerPlansByServiceList
uint64_t getServerPlansByServiceList ()
Asynchronously requests a list of purchase plans.
Return value
Unique operation id.
See also
tVPNPurchasesByService.
getServerPlansList
uint64_t getServerPlansList ()
Asynchronously requests a list of purchase plans.
Return value
Unique operation id.
See also
tVPNPurchases.
getSlotsByServiceList
uint64_t getSlotsByServiceList ()
Asynchronously requests a list of slot purchase plans.
Return value
Unique operation id.
See also
tVPNPurchasesByService.
getSlotsList
uint64_t getSlotsList ()
Asynchronously requests a list of slot purchase plans.
Return value
Unique operation id.
See also
tVPNPurchases.
getVPNProfile
uint64_t getVPNProfile (const std::string ®ion, const VPNProfile::tOpenVPNProtocol &protocol)
Asynchronously requests a VPN profile to connect to a VPN.
Parameters
- region
- A region from the list of server regions to which you can connect via the VPN.
- protocol
- A protocol through which the connection establishes (TCP, UDP, Wise).
Return value
Unique operation id.
See also
tOpenVPNProtocol.
getVPNServersList
uint64_t getVPNServersList ()
Asynchronously requests a list of regions with servers to which a User can connect via a VPN.
Return value
Unique operation id.
See also
isLogged
bool isLogged ()
This method returns a User's login state.
Return value
User's login state.
See also
login
uint64_t login (const std::string &login, const std::string &plainPasswd)
Asynchronously performs authorization. This method tries to authorize a user with specified login and password.
Parameters
- login
- User's login, usually email. Cannot be null.
- plainPasswd
- User's password. Cannot be null.
Return value
Unique operation id.
See also
logout
uint64_t logout ()
Asynchronously performs logout from application. This method clears the current session.
Return value
Unique operation id.
See also
recoveryPasswordMailSend
uint64_t recoveryPasswordMailSend (const std::string &login)
Asynchronously performs sending emails to the User's email address with instructions on how to recover his password.
Parameters
- login
- User's login. Cannot be null.
Return value
Unique operation id.
See also
registerAccount
uint64_t registerAccount (const std::string &newLogin, const std::string &plainPasswd, const std::string &firstName, const std::string &lastName, const std::string &secretQuestion, const std::string &secretAnswer)
Asynchronously performs registration of a new account. This method tries to register the new account.
Parameters
- newLogin
- Desired User's login, usually email. Cannot be null.
- plainPasswd
- Desired password. Cannot be null.
- firstName
- 1st name of a new account.
- lastName
- 2nd name of a new account.
- secretQuestion
- Secret question, required to recover a password.
- secretAnswer
- Secret answer, required to recover a password.
Return value
Unique operation id.
See also
resendConfirmMail
uint64_t resendConfirmMail (const std::string &login)
Asynchronously performs resending emails to the User's email address to confirm his account. The user can use the application only 24 hours after registration, then the login to the application will be blocked without account confirmation.
Parameters
- login
- User's login. Cannot be null.
Return value
Unique operation id.
See also
socialFacebookLogin
uint64_t socialFacebookLogin (const std::string &login, const std::string &authParams)
Asynchronously performs social authorization. This method tries to authorize a user with specified social login and parameters.
Parameters
- login
- User's login, getting from the Facebook API. Cannot be null.
- authParams
- User's social parameters, getting from the Facebook API. Cannot be null.
Return value
Unique operation id.
See also
AppAuthType
socialGoogleLogin
uint64_t socialGoogleLogin (const std::string &login, const std::string &authParams)
Asynchronously performs social authorization. This method tries to authorize a user with specified social login and parameters.
Parameters
- login
- User's login, getting from the Google API. Cannot be null.
- authParams
- User's social parameters, getting from the Google API. Cannot be null.
Return value
Unique operation id.
See also
AppAuthType
Constructors
APITalker
APITalker (const std::stringservice, IAppInfoProvider *pInfoProvider, IAPIDelegate *pDelegate)Constructor.
Parameters
- service
- Unique service name to identify a company client.
- pInfoProvider
- Pointer to interface for saving and getting data.
- pDelegate
- Pointer to interface for server response processing.