com.vk.api.sdk.queries.messages

Class MessagesGetHistoryQuery

java.lang.Object

com.vk.api.sdk.client.ApiRequest<R>

com.vk.api.sdk.client.AbstractQueryBuilder<MessagesGetHistoryQuery,GetHistoryResponse>

com.vk.api.sdk.queries.messages.MessagesGetHistoryQuery

public class MessagesGetHistoryQuery
extends AbstractQueryBuilder<MessagesGetHistoryQuery,GetHistoryResponse>

Query for Messages.getHistory method

Constructor Summary

Constructors

Constructor and Description
MessagesGetHistoryQuery(VkApiClient client, GroupActor actor) Creates a AbstractQueryBuilder instance that can be used to build group api request with various parameters
MessagesGetHistoryQuery(VkApiClient client, UserActor actor) Creates a AbstractQueryBuilder instance that can be used to build user api request with various parameters

Method Summary

Modifier and Type	Method and Description
MessagesGetHistoryQuery	count(java.lang.Integer value) Number of messages to return.
protected java.util.List<java.lang.String>	essentialKeys() Get list of required parameter names
MessagesGetHistoryQuery	extended(java.lang.Boolean value) Information whether the response should be extended
MessagesGetHistoryQuery	fields(Fields... value) fields Profile fields to return.
MessagesGetHistoryQuery	fields(java.util.List<Fields> value) Profile fields to return.
protected MessagesGetHistoryQuery	getThis() Get reference to this object
MessagesGetHistoryQuery	groupId(java.lang.Long value) Group ID (for group messages with group access token)
MessagesGetHistoryQuery	offset(java.lang.Integer value) Offset needed to return a specific subset of messages.
MessagesGetHistoryQuery	peerId(java.lang.Long value) Set peer id
MessagesGetHistoryQuery	rev(GetHistoryRev value) Sort order: '1' - return messages in chronological order. '0' - return messages in reverse chronological order.
MessagesGetHistoryQuery	startMessageId(java.lang.Integer value) Starting message ID from which to return history.
MessagesGetHistoryQuery	userId(java.lang.Long value) ID of the user whose message history you want to return.

Methods inherited from class com.vk.api.sdk.client.AbstractQueryBuilder

accessToken, build, captchaKey, captchaSid, clientSecret, confirm, getBody, getMethod, getParams, getQueryHeaders, lang, toString, unsafeParam, unsafeParam, unsafeParam, unsafeParam, unsafeParam, unsafeParam, unsafeParam, unsafeParam, unsafeParam, unsafeParam, unsafeParam, unsafeParam, version, withHeader, withHeaders

Methods inherited from class com.vk.api.sdk.client.ApiRequest

addHeader, addHeaders, execute, executeAsRaw, executeAsString, executeAsStringWithReturningFullInfo, executeTypeable, executeTypeableWithoutRetry, executeWithoutRetry, getClient, getCookie, getGson, getHeaders, getResponseClass, getUrl, setCookie, setCookies, setHeaders, setHeaders

Methods inherited from class java.lang.Object

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

Constructor Detail

MessagesGetHistoryQuery

public MessagesGetHistoryQuery(VkApiClient client,
                               GroupActor actor)

Creates a AbstractQueryBuilder instance that can be used to build group api request with various parameters

Parameters:

client - VK API client

actor - actor with access token

MessagesGetHistoryQuery

public MessagesGetHistoryQuery(VkApiClient client,
                               UserActor actor)

Creates a AbstractQueryBuilder instance that can be used to build user api request with various parameters

Parameters:

client - VK API client

actor - actor with access token

Method Detail

offset

public MessagesGetHistoryQuery offset(java.lang.Integer value)

Offset needed to return a specific subset of messages.

Parameters:

value - value of "offset" parameter.

Returns:

a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

count

public MessagesGetHistoryQuery count(java.lang.Integer value)

Number of messages to return.

Parameters:

value - value of "count" parameter. Maximum is 200. Minimum is 0. By default 20.

Returns:

a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

userId

public MessagesGetHistoryQuery userId(java.lang.Long value)

ID of the user whose message history you want to return.

Parameters:

value - value of "user id" parameter. Entity - owner

Returns:

a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

peerId

public MessagesGetHistoryQuery peerId(java.lang.Long value)

Set peer id

Parameters:

value - value of "peer id" parameter. Entity - peer

Returns:

a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

startMessageId

public MessagesGetHistoryQuery startMessageId(java.lang.Integer value)

Starting message ID from which to return history.

Parameters:

value - value of "start message id" parameter.

Returns:

a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

rev

public MessagesGetHistoryQuery rev(GetHistoryRev value)

Sort order: '1' - return messages in chronological order. '0' - return messages in reverse chronological order.

Parameters:

value - value of "rev" parameter.

Returns:

a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

extended

public MessagesGetHistoryQuery extended(java.lang.Boolean value)

Information whether the response should be extended

Parameters:

value - value of "extended" parameter.

Returns:

a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

groupId

public MessagesGetHistoryQuery groupId(java.lang.Long value)

Group ID (for group messages with group access token)

Parameters:

value - value of "group id" parameter. Minimum is 0. Entity - owner

Returns:

a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

fields

public MessagesGetHistoryQuery fields(Fields... value)

fields Profile fields to return.

Parameters:

value - value of "fields" parameter.

Returns:

a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

fields

public MessagesGetHistoryQuery fields(java.util.List<Fields> value)

Profile fields to return.

Parameters:

value - value of "fields" parameter.

Returns:

a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

getThis

protected MessagesGetHistoryQuery getThis()

Description copied from class: AbstractQueryBuilder

Get reference to this object

Specified by:

getThis in class AbstractQueryBuilder<MessagesGetHistoryQuery,GetHistoryResponse>

Returns:

a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

essentialKeys

protected java.util.List<java.lang.String> essentialKeys()

Description copied from class: AbstractQueryBuilder

Get list of required parameter names

Specified by:

essentialKeys in class AbstractQueryBuilder<MessagesGetHistoryQuery,GetHistoryResponse>

Returns:

list of names