com.vk.sdk.api

Class VKError

java.lang.Object

com.vk.sdk.VKObject

com.vk.sdk.api.VKError

public class VKError
extends VKObject

Class for presenting VK SDK and VK API errors

Field Summary

Fields

Modifier and Type	Field and Description
VKError	apiError Describes API error
java.lang.String	captchaImg Image for captcha-check
java.lang.String	captchaSid Captcha identifier for captcha-check
int	errorCode May contains such errors: HTTP status code if HTTP error occured; VK_API_ERROR if API error occured; VK_API_CANCELED if request was canceled; VK_API_REQUEST_NOT_PREPARED if error occured while preparing request;
java.lang.String	errorMessage API error message
java.lang.String	errorReason Reason for authorization fail
java.lang.Exception	httpError Contains system HTTP error
java.lang.String	redirectUri Redirection address if validation check required
VKRequest	request Request which caused error
java.util.ArrayList<java.util.Map<java.lang.String,java.lang.String>>	requestParams API parameters passed to request
static int	VK_API_ERROR
static int	VK_CANCELED
static int	VK_JSON_FAILED
static int	VK_REQUEST_HTTP_FAILED
static int	VK_REQUEST_NOT_PREPARED

Constructor Summary

Constructors

Constructor and Description
VKError(int errorCode) Generate new error with code
VKError(org.json.JSONObject json) Generate API error from JSON
VKError(java.util.Map<java.lang.String,java.lang.String> queryParams) Generate API error from HTTP-query

Method Summary

Modifier and Type	Method and Description
void	answerCaptcha(java.lang.String userEnteredCode) Repeats failed captcha request with user entered answer to captcha
static VKError	getRegisteredError(long requestId)
java.lang.String	toString()

Methods inherited from class com.vk.sdk.VKObject

getRegisteredObject, registerObject, unregisterObject

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

VK_API_ERROR

public static final int VK_API_ERROR

See Also:

Constant Field Values

VK_CANCELED

public static final int VK_CANCELED

See Also:

Constant Field Values

VK_REQUEST_NOT_PREPARED

public static final int VK_REQUEST_NOT_PREPARED

See Also:

Constant Field Values

VK_JSON_FAILED

public static final int VK_JSON_FAILED

See Also:

Constant Field Values

VK_REQUEST_HTTP_FAILED

public static final int VK_REQUEST_HTTP_FAILED

See Also:

Constant Field Values

httpError

public java.lang.Exception httpError

Contains system HTTP error

apiError

public VKError apiError

Describes API error

request

public VKRequest request

Request which caused error

errorCode

public int errorCode

May contains such errors:
HTTP status code if HTTP error occured;
VK_API_ERROR if API error occured;
VK_API_CANCELED if request was canceled;
VK_API_REQUEST_NOT_PREPARED if error occured while preparing request;

errorMessage

public java.lang.String errorMessage

API error message

errorReason

public java.lang.String errorReason

Reason for authorization fail

requestParams

public java.util.ArrayList<java.util.Map<java.lang.String,java.lang.String>> requestParams

API parameters passed to request

captchaSid

public java.lang.String captchaSid

Captcha identifier for captcha-check

captchaImg

public java.lang.String captchaImg

Image for captcha-check

redirectUri

public java.lang.String redirectUri

Redirection address if validation check required

Constructor Detail

VKError

public VKError(int errorCode)

Generate new error with code

Parameters:

errorCode - positive if it's an HTTP error. Negative if it's API or SDK error

VKError

public VKError(org.json.JSONObject json)
        throws org.json.JSONException

Generate API error from JSON

Parameters:

json - Json description of VK API error

Throws:

org.json.JSONException

VKError

public VKError(java.util.Map<java.lang.String,java.lang.String> queryParams)

Generate API error from HTTP-query

Parameters:

queryParams - key-value parameters

Method Detail

answerCaptcha

public void answerCaptcha(java.lang.String userEnteredCode)

Repeats failed captcha request with user entered answer to captcha

Parameters:

userEnteredCode - answer for captcha

getRegisteredError

public static VKError getRegisteredError(long requestId)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object