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
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.
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.
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.
setSSIDsToTrustedList:completion:
- (void)setSSIDsToTrustedList:(NSArray<NSString *> *)list completion:(void (^)(NSError *error))completion;
Adds an array of the Service Set Identifier (SSID) to trusted list.
Parameters
- list
- An array that contains a list of SSIDs. Cannot be nil.
- completion
- Block to be called upon operation completion.
startVPNTunnelWithServerItem:protocol:completion:
- (void)startVPNTunnelWithServerItem:(VPNUServerItem *)serverItem protocol:(VPNUProtocol)protocol completion:(void(^)(NSError *error))completion;
Starts the VPN tunnel using the current VPN configuration.
Parameters
- serverItem
- Server item object to perform setup for. Cannot be nil.
- protocol
- Protocol for VPN configuration.
- 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 status property.
stopVPNWithCompletion:
- (void)stopVPNWithCompletion:(void(^)(NSError *error))completion;
Stops the VPN tunnel.
Parameters
- 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