Developers SDK

VPN Unlimited SDK v1.1 for Android Reference

Name Description
InvalidProxyException Exception class which will be thrown when VPNU SDK user will try to setup KSProxyManager with invalid proxy configuration KSProxyConfiguration.
KSAccountDevice A model object which describes a user's device.
KSAccountDeviceStatistic A model object which describes statistics of a user's device for a specific date.
KSAccountManager This class provides an interface for retrieving miscellaneous information about currently logged-in user.
Before using this class you must authorize or register with the help of KSAuthorizer class. You must pass the same KSTransport instance to its constructor as you have passed to KSAuthorizer instance constructor.
KSAccountStatus A model object which describes user's account status.
KSAccountUserInfo A model object which describes user's account information.
KSAuthDelegate Protocol for implementing custom authorization. If you use custom authorization routines (like Facebook or Google Plus), you should implement this#resolveCustomAuthorizationWithHandler to provide the results in form of KSAuthDelegate.Response of this authorization.
KSAuthDelegate.Response
KSAuthorizer This class provides an interface for performing various authorization-related routines.
Use this class to authorize with an existing KeepSolid account or create a new one. After initializing an instance of this class with an instance of KSTransport and performing authorization, be sure to pass the same instance of KSTransport to other classes which depend on it. Otherwise you will not be able to use all features of SDK.
KSException VPN Unlimited SDK internal exception. Exception details should be retrieved by getResponse().
KSFacade This singleton class which provides access to KeepSolid API.
KSImageLoader This class provides an interface for loading remote images.
KSImageRequest A special request class used by KSTransport. A request object is constructed with one of the factory methods of KSRequestBuilder. The newly created request must then be passed as a parameter to KSTransport.sendImageRequest(KSImageRequest) method.
KSImageResponse This class represents general response on image request.
KSLocationCoordinate2D Type used to represent a latitude or longitude coordinate in degrees
KSProxyConfiguration A model class which describes proxy configuration.
KSProxyManager This class provides an interface for retrieving and setting proxy configuration for both VPN Service and KeepSolid API requests.
KSPurchaseItem A model object which describes purchased item.
KSPurchaseManager This class provides an interface for validating a purchase.
Before using this class you must authorize or register with the help of KSAuthorizer class. You must pass the same KSAuthorizer instance to its constructor as you have passed to KSAuthorizer instance constructor.
KSRequest A special request class used by KSTransport. A request object is constructed with one of the factory methods of KSRequestBuilder. The newly created request must then be passed as a parameter to KSTransport.sendRequest(KSRequest) method.
KSRequest.METHOD http method presentation
KSRequest.VPNURequestEndpointType KeepSolid API type
KSRequestBuilder This class provides a factory methods for building KeepSolid API requests.
KSResponse This class represents general VPNU SDK operation response.
KSTransport Class used to send synchronous requests to KeepSolid servers.
Once sign-in request is successful, the instance of manages the created session internally.
If you use the standard authorization routine with method KSAuthorizer.authorizeWithLogin(String, String), KSTransport silently re-authorizes if the session is expired. But if you implement non-standard authorization methods (like authorizing with social networks), it is impossible to re-authorize without calling the third-party code. In this case you must implement KSAuthDelegate and pass the delegate instance to KSAuthDataSource via setAuthDelegate(KSAuthDelegate) before any usage of this class.
LocalizedResponseProvider This class provides an interface for retrieving localized descriptions about various server errors. For sample implementation, please, refer KSDefault
OpenVpnService
OpenVpnStatusChangedListener Listener class for VPN connection state handling
VPNUConfigurator This class provides an interface for managing VPN connection. A basic workflow looks as follows:
1. Call prepare() method to establish connection to VPN Unlimited service or creates a new one.
2. Configure VPN server item using setup(com.keepsolid.androidkeepsolidcommon.vpnunlimitesdk.entities.VPNUServer, boolean) method.
3. Add OpenVpnStatusChangedListener for observing connection status.
3. Connect to the configured VPN server using startVpn() method.
4. Disconnect at any time using stopVpn() method.
Before using this class you must authorize or register with the help of KSAuthorizer class.
You must pass the same KSAuthorizer instance to its constructor as you have passed to KSAuthorizer instance constructor.
VPNUFacade This singleton class which provides access to VPN Unlimited SDK API.
VPNUServer A model object which describes remote vpn server.
VPNUServersManager This class provides an interface for retrieving current list of vpn unlimited servers.
Before using this class you must authorize or register with the help of KSAuthorizer class. You must pass the same KSAuthorizer instance to its constructor as you have passed to KSAuthorizer instance constructor.
Other versions: 1.0 / 1.2 / 1.3 / 1.4 / 1.5