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
Instance Methods
cancelAllRequests
- (void)cancelAllRequests;
Cancels all pending requests.
initializeSettingsOfStandaloneWithAppID:appSecret:applicationGroupIdentifier:appVersion:sharedKeychainGroupID:helperToolBundleIdentifier:daemonBundleName:completion:
- (void)initializeSettingsOfStandaloneWithAppID:(NSString *)appID appSecret:(NSString *)appSecret applicationGroupIdentifier:(NSString *)applicationGroupIdentifier appVersion:(NSString *)appVersion sharedKeychainGroupID:(NSString *)sharedKeychainGroupID helperToolBundleIdentifier:(NSString *)helperToolBundleIdentifier daemonBundleName:(NSString *)daemonBundleName completion:(dispatch_block_t)completion;
Creates all settings for VPN Unlimited SDK (macOS Standalone).
Parameters
- appID
- The application id needed for request signing.
- appSecret
- The application secret key needed for request signing.
- applicationGroupIdentifier
- The shared application group id needed for storing logs.
- appVersion
- The application version. The default value is 1.0.
- sharedKeychainGroupID
- The shared keychain group id needed for deviceID storing in iOS keychain.
- helperToolBundleIdentifier
- The helper tool bundle id needed for install vpn service.
- daemonBundleName
- The VPN service bundle id.
- completion
- Block to be called upon operation completion.
Discussion
.
initializeSettingsWithAppID:appSecret:applicationGroupIdentifier:appVersion:sharedKeychainGroupID:providerBundleIdentifier:wgProviderBundleIdentifier:profileName:completion:
- (void)initializeSettingsWithAppID:(NSString *)appID appSecret:(NSString *)appSecret applicationGroupIdentifier:(NSString *)applicationGroupIdentifier appVersion:(NSString *)appVersion sharedKeychainGroupID:(NSString *)sharedKeychainGroupID providerBundleIdentifier:(NSString *)providerBundleIdentifier wgProviderBundleIdentifier:(NSString *)wgProviderBundleIdentifier profileName:(NSString *)profileName completion:(dispatch_block_t)completion;
Creates all settings for VPN Unlimited SDK (macOS/iOS).
Parameters
- appID
- The application ID needed for request signing.
- appSecret
- The application secret key needed for request signing.
- applicationGroupIdentifier
- The shared application group id needed for storing logs.
- appVersion
- The application version.
- sharedKeychainGroupID
- The shared keychain group ID needed for deviceID storing in iOS keychain.
- providerBundleIdentifier
- The provider bundle identifier needed for Network Extension. Needed for iOS and macOS.
- wgProviderBundleIdentifier
- The provider bundle identifier needed for Network Extension (Wireguard protocol). Needed for iOS and macOS.
- profileName
- Custom name for a downloaded VPN profile.
- completion
- Block to be called upon operation completion.
Discussion
.
Properties
connection
@property (readonly) VPNUConnection *connection;
Intance of VPNUConnection 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.
currentDeviceInfo
@property (strong) VPNUAccountDevice *currentDeviceInfo;
Info about currently logged-in user's device.
currentServersList
@property (strong) NSArray<VPNUServerItem *> *currentServersList;
Currently user's servers list from the serverListWithOptions:completion: method.
currentUserInfo
@property (strong) VPNUAccountUserInfo *currentUserInfo;
Info about currently logged-in user.
customAuthDelegate
@property (strong) id<VPNUAuthDelegate> customAuthDelegate;
A delegate object which conforms to VPNUAuthDelegate protocol.
Discussion
Once you define an object which conforms to VPNUAuthDelegate, set this property with it. If you are using non-standard authorization methods (like authorizing with social networks), you must provide an object which resolves custom authorization with third-party server and returns authentication details.
defaultFacade
@property (class, readonly) KSVPNUFacade *defaultFacade;
Singleton instance of Facade.
Typedefs
KSVPNUServerListOptions
typedef enum { KSVPNUServerListOptionsNonAuthorized = 1 << 0, KSVPNUServerListOptionsOptimal = 1 << 1, KSVPNUServerListOptionsSquareFlags = 1 << 2, } KSVPNUServerListOptions;
Server list fetching options
Constants
- KSVPNUServerListOptionsNonAuthorized
- 0 - authorization is required; 1 - authorization is not required
- KSVPNUServerListOptionsOptimal
- 0 - default server list will be returned; 1 - list of recomended servers will be returned
- KSVPNUServerListOptionsSquareFlags
- 0 - round region flag images; 1 - square region flag images