com.vk.sdk.api

Class VKRequest

java.lang.Object

com.vk.sdk.VKObject

com.vk.sdk.api.VKRequest

Direct Known Subclasses:

VKUploadBase

public class VKRequest
extends VKObject

Class for execution API-requests.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	VKRequest.HttpMethod Deprecated.
static class	VKRequest.VKProgressType
static class	VKRequest.VKRequestListener Extend listeners for requests from that class Created by Roman Truba on 02.12.13.

Field Summary

Fields

Modifier and Type	Field and Description
int	attempts Specify attempts for request loading if caused HTTP-error.
android.content.Context	context
java.lang.String	methodName Selected method name
boolean	parseModel Set to false if you don't need automatic model parsing
VKRequest.VKRequestListener	requestListener Specify listener for current request
java.lang.ref.WeakReference<VKResponse>	response Response for this request
boolean	secure Use HTTPS requests (by default is YES).
boolean	shouldInterruptUI Specify if this request should present an activity for processing errors, which required user interaction.
boolean	useSystemLanguage Sets current system language as default for API data

Constructor Summary

Constructors

Constructor and Description
VKRequest(java.lang.String method) Creates new request with parameters.
VKRequest(java.lang.String method, VKParameters parameters) Creates new request with parameters.
VKRequest(java.lang.String method, VKParameters parameters, java.lang.Class<? extends VKApiModel> modelClass) Creates new request with parameters.
VKRequest(java.lang.String method, VKParameters parameters, VKRequest.HttpMethod httpMethod, java.lang.Class<? extends VKApiModel> modelClass) Deprecated.

Method Summary

Modifier and Type	Method and Description
void	addExtraParameter(java.lang.String key, java.lang.Object value) Adds additional parameter to that request
void	addExtraParameters(VKParameters extraParameters) Adds additional parameters to that request
void	cancel() Cancel current request.
void	executeAfterRequest(VKRequest request, VKRequest.VKRequestListener listener) Register current request for execute after passed request, if passed request is successful.
void	executeSyncWithListener(VKRequest.VKRequestListener listener) Executes that request, and returns result to blocks
void	executeWithListener(VKRequest.VKRequestListener listener) Executes that request, and returns result to blocks
VKParameters	getMethodParameters()
VKParameters	getPreparedParameters()
VKHttpClient.VKHTTPRequest	getPreparedRequest() Prepares request for loading
static VKRequest	getRegisteredRequest(long requestId)
void	repeat() Repeats this request with initial parameters and blocks.
void	setModelClass(java.lang.Class<? extends VKApiModel> modelClass) Sets class for parse object model
void	setPreferredLang(java.lang.String lang) Sets preferred language for api results.
void	setRequestListener(VKRequest.VKRequestListener listener)
void	setResponseParser(VKParser parser) Specify parser for response json, which creates data model
void	setUseLooperForCallListener(boolean useLooperForCallListener)
void	start() Starts loading of prepared request.
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

context

public final android.content.Context context

methodName

public final java.lang.String methodName

Selected method name

requestListener

@Nullable
public VKRequest.VKRequestListener requestListener

Specify listener for current request

shouldInterruptUI

public boolean shouldInterruptUI

Specify if this request should present an activity for processing errors, which required user interaction.

attempts

public int attempts

Specify attempts for request loading if caused HTTP-error. 0 for infinite

secure

public boolean secure

Use HTTPS requests (by default is YES). If http-request is impossible (user denied no https access), SDK will load https version

useSystemLanguage

public boolean useSystemLanguage

Sets current system language as default for API data

parseModel

public boolean parseModel

Set to false if you don't need automatic model parsing

response

public java.lang.ref.WeakReference<VKResponse> response

Response for this request

Constructor Detail

VKRequest

public VKRequest(java.lang.String method)

Creates new request with parameters. See documentation for methods here https://vk.com/dev/methods

Parameters:

method - API-method name, e.g. audio.get

VKRequest

public VKRequest(java.lang.String method,
                 VKParameters parameters)

Creates new request with parameters. See documentation for methods here https://vk.com/dev/methods

Parameters:

method - API-method name, e.g. audio.get

parameters - method parameters

VKRequest

@Deprecated
public VKRequest(java.lang.String method,
                             VKParameters parameters,
                             VKRequest.HttpMethod httpMethod,
                             java.lang.Class<? extends VKApiModel> modelClass)

Deprecated.

VKRequest

public VKRequest(java.lang.String method,
                 VKParameters parameters,
                 java.lang.Class<? extends VKApiModel> modelClass)

Creates new request with parameters. See documentation for methods here https://vk.com/dev/methods

Parameters:

method - API-method name, e.g. audio.get

parameters - method parameters

modelClass - class for automatic parse

Method Detail

getMethodParameters

public VKParameters getMethodParameters()

Returns:

Returns list of method parameters (without common parameters)

setUseLooperForCallListener

public void setUseLooperForCallListener(boolean useLooperForCallListener)

executeWithListener

public void executeWithListener(VKRequest.VKRequestListener listener)

Executes that request, and returns result to blocks

Parameters:

listener - listener for request events

executeSyncWithListener

public void executeSyncWithListener(VKRequest.VKRequestListener listener)

Executes that request, and returns result to blocks

Parameters:

listener - listener for request events

setRequestListener

public void setRequestListener(@Nullable
                               VKRequest.VKRequestListener listener)

executeAfterRequest

public void executeAfterRequest(VKRequest request,
                                VKRequest.VKRequestListener listener)

Register current request for execute after passed request, if passed request is successful. If it's not, errorBlock will be called.

Parameters:

request - after which request must be called that request

listener - listener for request events

getPreparedParameters

public VKParameters getPreparedParameters()

getPreparedRequest

public VKHttpClient.VKHTTPRequest getPreparedRequest()

Prepares request for loading

Returns:

Prepared HttpUriRequest for that VKRequest

start

public void start()

Starts loading of prepared request. You can use it instead of executeWithResultBlock

repeat

public void repeat()

Repeats this request with initial parameters and blocks. Used attempts will be set to 0.

cancel

public void cancel()

Cancel current request. Result will be not passed. errorBlock will be called with error code

addExtraParameter

public void addExtraParameter(java.lang.String key,
                              java.lang.Object value)

Adds additional parameter to that request

Parameters:

key - parameter name

value - parameter value

addExtraParameters

public void addExtraParameters(VKParameters extraParameters)

Adds additional parameters to that request

Parameters:

extraParameters - parameters supposed to be added

setPreferredLang

public void setPreferredLang(java.lang.String lang)

Sets preferred language for api results.

Parameters:

lang - Two letter language code. May be "ru", "en", "ua", "es", "fi", "de", "it"

setModelClass

public void setModelClass(java.lang.Class<? extends VKApiModel> modelClass)

Sets class for parse object model

Parameters:

modelClass - Class extends VKApiModel

setResponseParser

public void setResponseParser(VKParser parser)

Specify parser for response json, which creates data model

Parameters:

parser -

getRegisteredRequest

public static VKRequest getRegisteredRequest(long requestId)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object