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.
checkForUpdate
uint64_t checkForUpdate (IAPIUpdate *update_delegate)
Asynchronously requests information about available update.
Parameters
- update_delegate
- instance of IAPIUpdate interface
Return value
Unique operation id.
checkServersPing
uint64_t checkServersPing (std::vector< std::string >regions)
Asynchronously performs ping requests to selected regions.
Return value
Unique operation id.
checkUserRegistration
uint64_t checkUserRegistration (const std::string &email)
Asynchronously requests is the user registered.
Parameters
- A email from user to detect registration.
Return value
Unique operation id.
confirmNewAccount
uint64_t confirmNewAccount (const std::string &login, intcode)
Asynchronously performs confirmation of User's account.
Parameters
- login
- User's login, usually email. Cannot be null.
- code
- User's confirmation code.
Return value
Unique operation id.
downloadNewVersion
uint64_t downloadNewVersion (SXUpdateInfoinfo, IAPIUpdate *update_delegate)
Asynchronously requests download of new client version.
Parameters
- info
- SXUpdateInfo that was returned and verified from checkForUpdate request.
- update_delegate
- instance of IAPIUpdate interface.
Return value
Unique operation id.
getAccountStatus
uint64_t getAccountStatus (boolversion2 = true)
Asynchronously requests Users's account status.
Return value
Unique operation id.
See also
getCurrentUserInfo
const UserInfo& getCurrentUserInfo ()
Returns current user info.
Return value
UserInfo object with filled user data.
See also
getDeviceStatus
uint64_t getDeviceStatus ()
Asynchronously requests Users's device status.
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.
getUserStatus
uint64_t getUserStatus ()
Asynchronously performs request of User's status.
Return value
Unique operation id.
See also
tVPNPurchasesByService.
getVPNProfile
uint64_t getVPNProfile (const std::string ®ion, const VPNProtocol &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
VPNProtocol.
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
refreshTokenLogin
uint64_t refreshTokenLogin (const std::string &token)
Asynchronously performs authorization. This method tries to authorize a user with specified refresh token.
Parameters
- User's
- refresh token.
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, const boolmarketingMailFlag)
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
sendRedeemCode
uint64_t sendRedeemCode (const std::string &code)
Asynchronously performs applying of redeem code.
Parameters
- User's
- redeem code
Return value
Unique operation id.
See also
updateGlobalValues
void updateGlobalValues (IAppInfoProvider *pInfoProvider)
Performs update of IAppInfoProvider interface.
Parameters
- pInfoProvider
- Pointer to interface for saving and getting data.
Return value
Unique operation id.
See also
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.