VPN Unlimited SDK - Android - v1.0 - Reference

Class Methods

setApplicationID

 void setApplicationID(java.lang.String appID)

Sets the application ID needed for request signing

setApplicationSecret

 void setApplicationSecret(java.lang.String appSecret)

Sets the application secret key needed for request signing

Parameters

appSecret: Your application secret key.

buildAuthRequest

 KSRequest buildAuthRequest(java.lang.String action)

Same as buildAuthRequest(String, HashMap) but does not use any extra parameters.

Return value

The newly constructed KSRequest object or null if construction fails.

buildAuthRequest

 KSRequest buildAuthRequest(java.lang.String action,
                         java.util.HashMap<java.lang.String,java.lang.String> params)

Creates and returns a newly constructed KSRequest object for authorization-related routines using a specified action. action One of the predefined action strings associated with the new request. Cannot be null.

Parameters

params: A dictionary containing additional parameters for the request. Can be null.

Return value

The newly constructed KSRequest object or null if construction fails.

buildAPIRequest

 KSRequest buildAPIRequest(java.lang.String action)

Same as buildAPIRequest(String, HashMap) but does not use any extra parameters.

Parameters

action: One of the predefined action strings associated with the new request. Cannot be null.

Return value

The newly constructed KSRequest object or null if construction fails.

buildAPIRequest

 KSRequest buildAPIRequest(java.lang.String action,
                        java.util.HashMap<java.lang.String,java.lang.String> params)

Creates and returns a newly constructed KSRequest object for API-related routines using a specified action.

Parameters

action: One of the predefined action strings associated with the new request. Cannot be null.
params: A dictionary containing additional parameters for the request. Can be null.

Return value

The newly constructed KSRequest object or null if construction fails.

buildKeepSolidAPIRequest

 KSRequest buildKeepSolidAPIRequest(java.lang.String action)

Same as buildKeepSolidAPIRequest(String, HashMap) but does not use any extra parameters.

Parameters

action: One of the predefined action strings associated with the new request. Cannot be null.

buildKeepSolidAPIRequest

 KSRequest buildKeepSolidAPIRequest(java.lang.String action,
                                 java.util.HashMap<java.lang.String,java.lang.String> params)

Creates and returns a newly constructed KSRequest object for Simplex API-related routines using a specified action.

Parameters

action: One of the predefined action strings associated with the new request. Cannot be null.
params: A dictionary containing additional parameters for the request. Can be null.

Return value

The newly constructed KSRequest object or null if construction fails.

buildCustomRequest

 KSRequest buildCustomRequest(java.lang.String customUrl)

Same as buildCustomRequest(String, HashMap) but does not use any extra parameters.

Parameters

customUrl: Url of this request. Cannot be null.

Return value

The newly constructed KSRequest object or null if construction fails.

buildCustomRequest

 KSRequest buildCustomRequest(java.lang.String customUrl,
                           java.util.HashMap<java.lang.String,java.lang.String> params)

Creates and returns a newly constructed KSRequest object for non-KeepSolid API using a specified action.

Parameters

customUrl: Url of this request. Cannot be null.
params: A dictionary containing additional parameters for the request. Can be null.

Return value

The newly constructed KSRequest object or null if construction fails.

buildImageRequest

 KSImageRequest buildImageRequest(java.lang.String url,
                               int maxWidth,
                               int maxHeight)

Creates and returns a newly constructed KSImageRequest request for retrieving cached image (or loading image from a remote host).

Parameters

url: address of remote image
maxWidth: maximum width of remote image
maxHeight: maximum height of remote imaget

Return value

KSImageRequest request for retrieving an image

buildImageRequest

 KSImageRequest buildImageRequest(java.lang.String url)

Same as buildImageRequest(String, int, int) but does not use any extra parameters.

Parameters

url: address of remote image

Return value

KSImageRequest request for retrieving an image

Properties

ACTION_REGISTER

static final java.lang.String ACTION_REGISTER

See KSAuthorizer.registerWithLogin(String, String)

ACTION_AUTHORIZE

static final java.lang.String ACTION_AUTHORIZE

See KSAuthorizer.authorizeWithLogin(String, String)

ACTION_SIGN_OUT

static final java.lang.String ACTION_SIGN_OUT

See KSAuthorizer.signOut()

ACTION_RESEND_CONFIRMATION_EMAIL

static final java.lang.String ACTION_RESEND_CONFIRMATION_EMAIL

See KSAuthorizer.resendConfirmationEmailForLogin(String)

ACTION_RECOVER_PASSWORD

static final java.lang.String ACTION_RECOVER_PASSWORD

See KSAuthorizer.recoverPassword(String)

ACTION_ACCOUNT_STATUS

static final java.lang.String ACTION_ACCOUNT_STATUS

See KSAccountManager.getStatus()

ACTION_ACCOUNT_INFO

static final java.lang.String ACTION_ACCOUNT_INFO

See KSAccountManager.getUserInfo()

ACTION_USER_DEVICES_LIST

static final java.lang.String ACTION_USER_DEVICES_LIST

See KSAccountManager.getDevices()

ACTION_VPN_DEVICES_LIST

static final java.lang.String ACTION_VPN_DEVICES_LIST

See KSAccountManager.getDevices()

ACTION_SESSION_HISTORY_BY_DEVICE

static final java.lang.String ACTION_SESSION_HISTORY_BY_DEVICE

See KSAccountManager.getStatisticsForDevice(KSAccountDevice)

ACTION_VALIDATE_PURCHASE

static final java.lang.String ACTION_VALIDATE_PURCHASE

See KSPurchaseManager.validatePurchaseItem(KSPurchaseItem)

Developers SDK

KSRequestBuilder

Class Methods

Properties