api.longpoll.bots.methods.impl.messages

Class GetHistory

java.lang.Object

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

api.longpoll.bots.methods.impl.messages.GetHistory

public class GetHistory
extends VkMethod<GetHistory.ResponseBody>

Implements messages.getHistory method.

Returns message history for the specified user or group chat.

See Also:

https://vk.com/dev/messages.getHistory

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GetHistory.ResponseBody Response to messages.getHistory request.

Constructor Summary

Constructors

Constructor and Description
GetHistory(String accessToken)

Method Summary

Modifier and Type	Method and Description
GetHistory	addParam(String key, Object value) Adds URL parameter to HTTP request.
protected Class<GetHistory.ResponseBody>	getResponseClass() Gets a class of VK API response.
String	getUri() Gets request URI.
GetHistory	setCount(int count)
GetHistory	setExtended(boolean extended)
GetHistory	setFields(List<String> fields)
GetHistory	setFields(String... fields)
GetHistory	setGroupId(int groupId)
GetHistory	setOffset(int offset)
GetHistory	setPeerId(int peerId)
GetHistory	setRev(boolean rev)
GetHistory	setStartMessageId(int startMessageId)
GetHistory	setUserId(int userId)

Methods inherited from class api.longpoll.bots.methods.impl.VkMethod

csv, execute, executeAsync, getAccessToken, getGson, getRequestBody, property, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

GetHistory

public GetHistory(String accessToken)

Method Detail

getUri

public String getUri()

Description copied from class: VkMethod

Gets request URI.

Specified by:

getUri in class VkMethod<GetHistory.ResponseBody>

Returns:

request URI.

getResponseClass

protected Class<GetHistory.ResponseBody> getResponseClass()

Description copied from class: VkMethod

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

Specified by:

getResponseClass in class VkMethod<GetHistory.ResponseBody>

Returns:

a class of VK API response.

setOffset

public GetHistory setOffset(int offset)

setCount

public GetHistory setCount(int count)

setUserId

public GetHistory setUserId(int userId)

setPeerId

public GetHistory setPeerId(int peerId)

setStartMessageId

public GetHistory setStartMessageId(int startMessageId)

setRev

public GetHistory setRev(boolean rev)

setExtended

public GetHistory setExtended(boolean extended)

setFields

public GetHistory setFields(String... fields)

setFields

public GetHistory setFields(List<String> fields)

setGroupId

public GetHistory setGroupId(int groupId)

addParam

public GetHistory addParam(String key,
                           Object value)

Description copied from class: VkMethod

Adds URL parameter to HTTP request.

Overrides:

addParam in class VkMethod<GetHistory.ResponseBody>

Parameters:

key - URL parameter key.

value - URL parameter value.

Returns:

current instance.