public class VKRequest extends VKObject
| 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.
|
| 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 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.
|
| 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() |
getRegisteredObject, registerObject, unregisterObjectpublic final android.content.Context context
public final java.lang.String methodName
@Nullable public VKRequest.VKRequestListener requestListener
public boolean shouldInterruptUI
public int attempts
public boolean secure
public boolean useSystemLanguage
public boolean parseModel
public java.lang.ref.WeakReference<VKResponse> response
public VKRequest(java.lang.String method)
method - API-method name, e.g. audio.getpublic VKRequest(java.lang.String method,
VKParameters parameters)
method - API-method name, e.g. audio.getparameters - method parameters@Deprecated
public VKRequest(java.lang.String method,
VKParameters parameters,
VKRequest.HttpMethod httpMethod,
java.lang.Class<? extends VKApiModel> modelClass)
public VKRequest(java.lang.String method,
VKParameters parameters,
java.lang.Class<? extends VKApiModel> modelClass)
method - API-method name, e.g. audio.getparameters - method parametersmodelClass - class for automatic parsepublic VKParameters getMethodParameters()
public void setUseLooperForCallListener(boolean useLooperForCallListener)
public void executeWithListener(VKRequest.VKRequestListener listener)
listener - listener for request eventspublic void executeSyncWithListener(VKRequest.VKRequestListener listener)
listener - listener for request eventspublic void setRequestListener(@Nullable
VKRequest.VKRequestListener listener)
public void executeAfterRequest(VKRequest request, VKRequest.VKRequestListener listener)
request - after which request must be called that requestlistener - listener for request eventspublic VKParameters getPreparedParameters()
public VKHttpClient.VKHTTPRequest getPreparedRequest()
public void start()
public void repeat()
public void cancel()
public void addExtraParameter(java.lang.String key,
java.lang.Object value)
key - parameter namevalue - parameter valuepublic void addExtraParameters(VKParameters extraParameters)
extraParameters - parameters supposed to be addedpublic void setPreferredLang(java.lang.String lang)
lang - Two letter language code. May be "ru", "en", "ua", "es", "fi", "de", "it"public void setModelClass(java.lang.Class<? extends VKApiModel> modelClass)
modelClass - Class extends VKApiModelpublic void setResponseParser(VKParser parser)
parser - public static VKRequest getRegisteredRequest(long requestId)
public java.lang.String toString()
toString in class java.lang.Object