KSVPNUFacade(VPN)
Use the links in the table of contents to the left to access the documentation.
Extends: ass: KSVPNUFacade
Declared in: KSVPNUFacade.h
Instance Methods
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 YES before 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
- enable
- Boolean value which controls VPN On Demand toggling. If set to YES VPN On Demand is turned on, otherwise VPN On Demand is turned off.
- completion
- Block to be called upon operation completion.
enableOnDemandForCellular:completion:
- (void)enableOnDemandForCellular:(BOOL)enable completion:(void (^)(NSError *error))completion;
Turns VPN On Demand for Cellular network. Works only if enableOnDemand is set to YES.
Parameters
- enable
- Boolean value which controls VPN On Demand for Cellular. If set to YES VPN On Demand is turned on for all networks, otherwise VPN On Demand is turned on only for not Cellular networks (WiFi on iPhone). Default is YES.
- completion
- Block to be called upon operation completion.
Availability
Not available in Mac OS X. Available in iOS v8.0.
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.
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.
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.
setProtocol:shouldReconnect:serverItem:completion:
- (void)setProtocol:(VPNUProtocol)protocol shouldReconnect:(BOOL)shouldReconnect serverItem:(VPNUServerItem *)serverItem completion:(void(^)(NSError *error))completion;
Sets current VPN protocol.
Parameters
- shouldReconnect
- Depending on this flag, the VPN will be connected after the protocol changing process is ended.
- serverItem
- Server item object to perform reconnect for. Cannot be nil if reconnect is YES.
- completion
- Block to be called upon operation completion.
Discussion
This method sets the protocol for VPN configuration. Disconnects VPN if it was connected. If reconnect flag is YES then VPN will be connected with new protocol to serverItem, otherwise serverItem will be ignored.
setupVPNWithServerItem:completion:
- (void)setupVPNWithServerItem:(VPNUServerItem *)serverItem completion:(void(^)(NSError *error, BOOL successfullyInstalled))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: error if any error occurs and successfullyInstalled - set to YES, if VPN profile is successfully installed.
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.
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 NO before 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.