api.longpoll.bots.methods.impl

Class VkMethod<ResponseBody>

java.lang.Object

api.longpoll.bots.methods.impl.VkMethod<ResponseBody>

Type Parameters:

ResponseBody - VK API response type.

Direct Known Subclasses:

AddAddress, AddCallbackServer, CheckLink, CloseComments, CreateChat, CreateComment, Delete, Delete, DeleteAddress, DeleteCallbackServer, DeleteChatPhoto, DeleteComment, DeleteConversation, DisableOnline, Edit, EditAddress, EditCallbackServer, EditChat, EditOrder, EnableOnline, Execute, Get, Get, GetBanned, GetByConversationMessageId, GetById, GetById, GetById, GetCallbackConfirmationCode, GetCallbackServers, GetCallbackSettings, GetChatUploadServer, GetConversationMembers, GetConversations, GetConversationsById, GetGroupOrders, GetHistory, GetHistoryAttachments, GetImportantMessages, GetInviteLink, GetLinkStats, GetLongPollServer, GetLongPollSettings, GetMembers, GetMessagesUploadServer, GetMessagesUploadServer, GetOnlineStatus, GetOrderById, GetOrderItems, GetOwnerCoverPhotoUploadServer, GetPhotoUploadServer, GetReplies, GetServerTime, GetShortLink, GetStats, GetTokenPermissions, GetUpdates, GetVideoUploadServer, GetViewers, GetWallUploadServer, HideAllReplies, HideReply, IsMember, IsMessagesFromGroupAllowed, MarkAsAnsweredConversation, MarkAsImportantConversation, MarkAsRead, OpenComments, Pin, RemoveChatUser, ResolveScreenName, Restore, RestoreComment, Save, Save, SaveMessagesPhoto, SaveOwnerCoverPhoto, Search, SearchConversations, Send, SendEventAnswer, SetActivity, SetCallbackSettings, SetChatPhoto, SetLongPollSettings, SetSettings, Unpin, UploadMethod

public abstract class VkMethod<ResponseBody>
extends Object

Executes generic HTTP request to VK API.

Constructor Summary

Constructors

Constructor and Description
VkMethod()
VkMethod(String accessToken)

Method Summary

Modifier and Type	Method and Description
VkMethod<ResponseBody>	addParam(String key, Object value) Adds URL parameter to HTTP request.
protected String	csv(List<?> values) Converts list of objects to comma separated values.
ResponseBody	execute() Executes request to VK API.
CompletableFuture<ResponseBody>	executeAsync() Executes request to VK API asynchronously.
protected String	getAccessToken() Gets accessToken.
protected com.google.gson.Gson	getGson() Gets gson object.
protected RequestBody	getRequestBody() Gets HTTP request body.
protected abstract Class<ResponseBody>	getResponseClass() Gets a class of VK API response.
abstract String	getUri() Gets request URI.
protected String	property(String key) Gets a property from VK_PROPERTIES.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

VkMethod

public VkMethod(String accessToken)

VkMethod

public VkMethod()

Method Detail

executeAsync

public CompletableFuture<ResponseBody> executeAsync()

Executes request to VK API asynchronously.

Returns:

VK API response wrapped to CompletableFuture

execute

public ResponseBody execute()
                     throws VkApiException

Executes request to VK API.

Returns:

VK API response.

Throws:

VkApiException - if errors occur.

getResponseClass

protected abstract Class<ResponseBody> getResponseClass()

Gets a class of VK API response. This value is used during deserialization of received JSON.

Returns:

a class of VK API response.

getUri

public abstract String getUri()

Gets request URI.

Returns:

request URI.

getRequestBody

protected RequestBody getRequestBody()

Gets HTTP request body.

Returns:

HTTP request body.

addParam

public VkMethod<ResponseBody> addParam(String key,
                                       Object value)

Adds URL parameter to HTTP request.

Parameters:

key - URL parameter key.

value - URL parameter value.

Returns:

current instance.

getGson

protected com.google.gson.Gson getGson()

Gets gson object.

Returns:

gson object.

csv

protected String csv(List<?> values)

Converts list of objects to comma separated values.

Parameters:

values - list of objects.

Returns:

comma separated values.

property

protected String property(String key)

Gets a property from VK_PROPERTIES.

Parameters:

key - property key.

Returns:

property value.

getAccessToken

protected String getAccessToken()

Gets accessToken.

Returns:

accessToken.

toString

public String toString()

Overrides:

toString in class Object