KSVPNUFacade
Class which serves as a 'facade' to other VPN Unlimited SDK classes.
Discussion
This class hides the complexity of VPN Unlimited SDK by encapsulating most of the needed features.
Extends: NSObject
Declared in: KSVPNUFacade.h
Class Methods
defaultFacade
+ (instancetype)defaultFacade;
Singleton instance of Facade.
Instance Methods
accountDevicesWithCompletion:
- (void)accountDevicesWithCompletion:(void(^)(NSError *error, NSArray<VPNUAccountDevice *> *accountDevices))completion;
Retrieves a list of currently logged-in user's used devices.
Parameters
- completion
- Block to be called upon operation completion.
See also
accountStatisticsForDevice:completion:
- (void)accountStatisticsForDevice:(VPNUAccountDevice *)device completion:(void(^)(NSError *error, NSArray<VPNUAccountDeviceStatistics *> *accountStatistics))completion;
Retrieves a list of currently logged-in user's statistics for provided device.
Parameters
- device
- A device object for which to retrieve statistics.
- completion
- Block to be called upon operation completion.
See also
VPNUAccountDeviceStatistics
accountStatusWithCompletion:
- (void)accountStatusWithCompletion:(void(^)(NSError *error, VPNUAccountStatus *accountStatus))completion;
Retrieves the currently logged-in user's account status.
Parameters
- completion
- Block to be called upon operation completion.
See also
authorizeWithLogin:andPassword:completion:
- (void)authorizeWithLogin:(NSString *)login andPassword:(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. attention: This method doesn't perform any local checks on provided passwords. If you need these checks you have to implement them.
Discussion
If password was changed successfully it automatically reauthorizes user with new password.
See also
authorizeWithLogin:andPassword:completion:
connectToVPNAndUseOnDemand:completion:
- (void)connectToVPNAndUseOnDemand:(BOOL)useOnDemand completion:(void(^)(NSError *error))completion;
Starts the VPN tunnel using the current VPN configuration.
Parameters
- useOnDemand
- Flag which indicates whether to automatically set On Demand value for this connection to
YESbefore connecting. - completion
- Block to be called upon operation completion.
Discussion
This method returns after VPN tunnel connection process is started and does not signals about the actual success of the VPN connection. In order to obtain the connection status, use the connectionStatus property.
See also
connectionStatus
connectToVPNWithCompletion:
- (void)connectToVPNWithCompletion:(void(^)(NSError *error))completion;
Calls
connectToVPNAndUseOnDemand:completion: with useOnDemand parameter set to YES.
enableOnDemand:completion:
- (void)enableOnDemand:(BOOL)enable completion:(void(^)(NSError *error))completion;
Turns VPN On Demand on or off.
Parameters
- enabled
- Boolean value which controls VPN On Demand toggling. If set to
YESVPN On Demand is turned on, otherwise VPN On Demand is turned off. - completion
- Block to be called upon operation completion.
enableVPNWithCompletion:
- (void)enableVPNWithCompletion:(void(^)(NSError *error))completion;
Sets VPN configuration for current app enabled.
Parameters
- completion
- Block to be called upon operation completion.
Discussion
If succeeded, this method disables VPN configurations of other apps.
Availability
Available in Mac OS X v10.11. Available in iOS v8.0.
enterCode:completion:
- (void)enterCode:(NSString *)code completion:(void(^)(NSError *error))completion;
Sends redeem code to server.
attention: This method does not perform code validation locally. If you want code validation feature you have to implement it.
Parameters
- code
- Reddem code string.
- completion
- Block to be called upon operation completion.
loadPreferencesWithCompletion:
- (void)loadPreferencesWithCompletion:(void(^)(NSError *error))completion;
Loads VPN configuration preferences.
Parameters
- completion
- Block to be called upon operation completion.
Discussion
This method loads the preferences for VPN configuration of the current application. You can call this method if you want to retrieve connectionStatus property before any call to configurator.
optimalServersListWithCompletion:
- (void)optimalServersListWithCompletion:(void(^)(NSError *error, NSArray<NSDictionary *> *serversList))completion;
Retieves a list of optimal VPN servers for currently logged-in user.
Parameters
- 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.
Discussion
Instructions are sent to the email of user specified in login parameter.
registerWithLogin:andPassword:completion:
- (void)registerWithLogin:(NSString *)login andPassword:(NSString *)password completion:(void(^)(NSError *error))completion;
Registers a new user.
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 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.
See also
authorizeWithLogin:andPassword:completion:
removeProfileWithCompletion:
- (void)removeProfileWithCompletion:(void(^)(NSError *error))completion;
Removes the VPN configuration from the Network Extension preferences if present.
Parameters
- completion
- Block to be called upon operation completion.
Availability
Available in Mac OS X v10.7. Available in iOS v8.0.
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.
Discussion
This method sends an account confirmation letter to user's email.
serversListWithCompletion:
- (void)serversListWithCompletion:(void(^)(NSError *error, NSArray<VPNUServerItem *> *serversList))completion;
Retieves a list of available VPN servers for currently logged-in user.
Parameters
- completion
- Block to be called upon operation completion.
See also
VPNUServerItem
setApplicationID:
- (void)setApplicationID:(NSString *)appID;
Sets the application ID needed for request signing.
Parameters
- appID
- Your application ID.
setApplicationSecret:
- (void)setApplicationSecret:(NSString *)appSecret;
Sets the application secret key needed for request signing.
Parameters
- appSecret
- Your application secret key.
setApplicationVersion:
- (void)setApplicationVersion:(NSString *)appVersion;
Sets the application version.
Parameters
- applicationVersion
- Your application version.
setupVPNWithServerItem:completion:
- (void)setupVPNWithServerItem:(VPNUServerItem *)serverItem completion:(void(^)(NSError *error, BOOL alreadyInstalled))completion;
Installs VPN profile for the specified server item.
Parameters
- serverItem
- Server item object to perform setup for. Cannot be
nil. - completion
- Block to be called upon operation completion. It has no return value and accepts two parameters:
errorif any error occurs andalreadyInstalled- set toYES, if VPN profile is already installed (iOS only).
Discussion
This method first retrieves VPN profile information for the specified server item. If this step was succesful, it then tries to install a new VPN profile into the system using the information retrieved in the first step.
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.
stopVPNAndUseOnDemand:completion:
- (void)stopVPNAndUseOnDemand:(BOOL)useOnDemand completion:(void(^)(NSError *error))completion;
Stops the VPN tunnel.
Parameters
- useOnDemand
- Flag which indicates whether to automatically set On Demand value for this connection to
NObefore disconnecting. - completion
- Block to be called upon operation completion.
Discussion
This method returns after VPN tunnel disconnect process is started and does not signals about the actual success of the VPN connection. In order to obtain the connection status, use the connectionStatus property.
See also
connectionStatus
stopVPNWithCompletion:
- (void)stopVPNWithCompletion:(void(^)(NSError *error))completion;
Calls
stopVPNAndUseOnDemand:completion: with useOnDemand parameter set to YES.
userInfoWithCompletion:
- (void)userInfoWithCompletion:(void(^)(NSError *error, VPNUAccountUserInfo *userInfo))completion;
Retrieves the currently logged-in user's account information.
Parameters
- completion
- Block to be called upon operation completion.
See also
VPNUAccountUserInfo
validatePurchaseItem:completion:
- (void)validatePurchaseItem:(VPNUPurchaseItem *)purchaseItem completion:(void(^)(NSError *error))completion;
Validates a provided purchase item on server.
Parameters
- purchaseItem
- A purchase item for which to perform the validation.
- completion
- Block to be called upon operation completion.
See also
Properties
appScheme
@property (copy) NSString *appScheme;
Application scheme used by local server.
configurator
@property (readonly) VPNUConfigurator *configurator;
Intance of VPNUConfigurator which is used to configure and control VPN connections.
Discussion
This object is read-only and created lazily inside KSVPNUFacade implementation.
currentAccountStatus
@property (strong) VPNUAccountStatus *currentAccountStatus;
Currently logged-in user's account status.
currentUserInfo
@property (strong) VPNUAccountUserInfo *currentUserInfo;
Info about currently logged-in user.
profileName
@property (copy) NSString *profileName;
Custom name for a downloaded VPN profile.
transport
@property (readonly) VPNUTransport *transport;
Intance of VPNUTransport which is used to send requests to server.
Discussion
This object is read-only and created lazily inside KSVPNUFacade implementation.