KSVPNUFacade(Networking)
Use the links in the table of contents to the left to access the documentation.
Extends: ass: KSVPNUFacade
Declared in: KSVPNUFacade.h
Instance Methods
accountStatusWithCompletion:
- (void)accountStatusWithCompletion:(void(^)(VPNUAccountStatus *accountStatus, NSError *error))completion;
Retrieves the currently logged-in user's account status.
Parameters
- completion
- Block to be called upon operation completion.
See also
allServerListsWithCompletion:
- (void)allServerListsWithCompletion:(void(^)(NSArray<VPNUServerItem *> *allServerItems, NSArray<VPNUServerItem *> *streamServerItems, NSArray<VPNUServerItem *> *personalServerItems, NSArray<VPNUServerItem *> *optimalServerItems, NSError *error))completion;
Retrieves a list of available VPN servers for different types.
Parameters
- completion
- Block to be called upon operation completion.
authorizeWithLogin:password:completion:
- (void)authorizeWithLogin:(NSString *)login password:(NSString *)password completion:(void(^)(NSError *error))completion;
Performs authorization.
Parameters
- login
- User's login. Cannot be nil.
- password
- User's password. Cannot be nil.
- completion
- Block to be called upon operation completion.
Discussion
This method tries to authorize a user with specified login and password. If authorization is successful it automatically sets the currentUserInfo property.
changeAccountPasswordWithLogin:oldPassword:newPassword:completion:
- (void)changeAccountPasswordWithLogin:(NSString *)login oldPassword:(NSString *)oldPassword newPassword:(NSString *)newPassword completion:(void(^)(NSError *error))completion;
Changes password for a user identifiied by login parameter.
Parameters
- login
- User's login/email.
- oldPassword
- User's current password.
- newPassword
- User's new password.
- completion
- Block to be called upon operation completion. Possible error responses: 302, 323, 500, 502, 503
Discussion
If password was changed successfully it automatically reauthorizes user with new password. This method doesn't perform any local checks on provided passwords. If you need these checks you have to implement them.
changePersonalServerName:region:completion:
- (void)changePersonalServerName:(NSString *)newName region:(NSString *)region completion:(void(^)(NSError *error))completion;
Change the personal server name.
Parameters
- region
- Server region.
- newName
- New server name.
- completion
- Block to be called upon operation completion.
Discussion
Used to change the name of the personal server
enterCode:completion:
- (void)enterCode:(NSString *)code completion:(void(^)(NSError *error))completion;
Sends redeem code to server.
Parameters
- code
- Reddem code string.
- completion
- Block to be called upon operation completion. Possible error responses: 351, 352, 502, 503
Discussion
This method does not perform code validation locally. If you want code validation feature you have to implement it.
See also
geolocateMeWithSquareFlags:completion:
- (void)geolocateMeWithSquareFlags:(BOOL)squareFlags completion:(void(^)(VPNULocationInfo *locationInfo, NSError *error))completion;
Retrieves a user current location with no need to logged-in.
Parameters
- squareFlags
- YES - square; NO - round
- completion
- Block to be called upon operation completion.
personalIPServersListWithSquareFlags:completion:
- (void)personalIPServersListWithSquareFlags:(BOOL)squareFlags completion:(void(^)(NSArray<VPNUPersonalServer *> *servers, NSError *error))completion;
Retrieves a list of available personal IP servers for currently logged-in user.
Parameters
- squareFlags
- The server list is obtained with square flags
- completion
- Block to be called upon operation completion.
personalServerRegionsListWithSquareFlags:completion:
- (void)personalServerRegionsListWithSquareFlags:(BOOL)squareFlags completion:(void(^)(NSArray<VPNUPersonalServer *> *servers, NSError *error))completion;
Retrieves a list of available personal VPN servers for currently logged-in user.
Parameters
- squareFlags
- The server list is obtained with square flags
- completion
- Block to be called upon operation completion.
recoveryPasswordForLogin:completion:
- (void)recoveryPasswordForLogin:(NSString *)login completion:(void(^)(NSError *error))completion;
Sends recovery password instructions.
Parameters
- login
- User's login/email.
- completion
- Block to be called upon operation completion. Possible error responses: 361, 502, 504
Discussion
Instructions are sent to the email of user specified in login parameter.
See also
registerWithLogin:password:marketingEmails:partnerId:completion:
- (void)registerWithLogin:(NSString *)login password:(NSString *)password marketingEmails:(BOOL)doNotRecieveMarketingEmails partnerId:(NSString *)partnerId completion:(void(^)(NSError *error))completion;
Registers a new user.
Parameters
- login
- User's login. Cannot be nil.
- password
- User's password. Cannot be nil.
- doNotRecieveMarketingEmails
- Marketing e-mails for the user. YES for not to receive marketing letters for this account, NO for recieve.
- completion
- Block to be called upon operation completion.
Discussion
This method tries to register a new user with specified login and password synchronously and waits for the response. If registration is successful, it automatically logs in the newly created user.
sendConfirmationEmailWithLogin:completion:
- (void)sendConfirmationEmailWithLogin:(NSString *)login completion:(void(^)(NSError *error))completion;
Sends account confirmation email.
Parameters
- login
- User's login.
- completion
- Block to be called upon operation completion. Possible error responses: 361, 502, 504
Discussion
This method sends an account confirmation letter to user's email.
See also
serverListWithOptions:completion:
- (void)serverListWithOptions:(KSVPNUServerListOptions)mask completion:(void(^)(NSArray<VPNUServerItem *> *serversList, NSError *error))completion;
Retrieves a list of available VPN servers for provided options.
Parameters
- mask
- Bitmask of KSVPNUServerListOptions values. Default is 0.
- completion
- Block to be called upon operation completion.
See also
signOutWithCompletion:
- (void)signOutWithCompletion:(void(^)(BOOL successful, NSError *error))completion;
Signs out the already authorized user.
Parameters
- completion
- Block to be called upon operation completion.
Discussion
This method clears current session and signals server about sign-out event.
userDeviceInfoWithCompletion:
- (void)userDeviceInfoWithCompletion:(void(^)(VPNUAccountDevice *deviceInfo, NSError *error))completion;
Retrieves the currently logged-in user's device information.
Parameters
- completion
- Block to be called upon operation completion.
See also
userInfoWithCompletion:
- (void)userInfoWithCompletion:(void(^)(VPNUAccountUserInfo *userInfo, NSError *error))completion;
Retrieves the currently logged-in user's account information.
Parameters
- completion
- Block to be called upon operation completion. Possible error responses: 502, 503
See also
validatePurchaseWithCountryCode:completion:
- (void)validatePurchaseWithCountryCode:(NSString *)countryCode completion:(void(^)(NSError *error))completion;
Validates purchases on server.
Parameters
- countryCode
- Code for the country of purchase.
- completion
- Block to be called upon operation completion.