com.vk.api.sdk.queries.messages

Class MessagesGetLongPollHistoryQuery

java.lang.Object

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

com.vk.api.sdk.client.AbstractQueryBuilder<MessagesGetLongPollHistoryQuery,GetLongPollHistoryResponse>

com.vk.api.sdk.queries.messages.MessagesGetLongPollHistoryQuery

public class MessagesGetLongPollHistoryQuery
extends AbstractQueryBuilder<MessagesGetLongPollHistoryQuery,GetLongPollHistoryResponse>

Query for Messages.getLongPollHistory method

Constructor Summary

Constructors

Constructor and Description
MessagesGetLongPollHistoryQuery(VkApiClient client, GroupActor actor) Creates a AbstractQueryBuilder instance that can be used to build group api request with various parameters
MessagesGetLongPollHistoryQuery(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
MessagesGetLongPollHistoryQuery	credentials(java.lang.Boolean value) Set credentials
protected java.util.List<java.lang.String>	essentialKeys() Get list of required parameter names
MessagesGetLongPollHistoryQuery	eventsLimit(java.lang.Integer value) Maximum number of events to return.
MessagesGetLongPollHistoryQuery	extended(java.lang.Boolean value) Set extended
MessagesGetLongPollHistoryQuery	fields(Fields... value) fields Additional profile [vk.com/dev/fields|fields] to return.
MessagesGetLongPollHistoryQuery	fields(java.util.List<Fields> value) Additional profile [vk.com/dev/fields|fields] to return.
protected MessagesGetLongPollHistoryQuery	getThis() Get reference to this object
MessagesGetLongPollHistoryQuery	groupId(java.lang.Long value) Group ID (for group messages with user access token)
MessagesGetLongPollHistoryQuery	lastN(java.lang.Integer value) Set last n
MessagesGetLongPollHistoryQuery	lpVersion(java.lang.Integer value) Set lp version
MessagesGetLongPollHistoryQuery	maxMsgId(java.lang.Integer value) Maximum ID of the message among existing ones in the local copy.
MessagesGetLongPollHistoryQuery	msgsLimit(java.lang.Integer value) Maximum number of messages to return.
MessagesGetLongPollHistoryQuery	onlines(java.lang.Boolean value) '1' - to return history with online users only.
MessagesGetLongPollHistoryQuery	previewLength(java.lang.Integer value) Number of characters after which to truncate a previewed message.
MessagesGetLongPollHistoryQuery	pts(java.lang.Integer value) Last value of 'pts' parameter returned from the Long Poll server or by using [vk.com/dev/messages.getLongPollHistory|messages.getLongPollHistory] method.
MessagesGetLongPollHistoryQuery	ts(java.lang.Integer value) Last value of the 'ts' parameter returned from the Long Poll server or by using [vk.com/dev/messages.getLongPollHistory|messages.getLongPollHistory] method.

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

MessagesGetLongPollHistoryQuery

public MessagesGetLongPollHistoryQuery(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

MessagesGetLongPollHistoryQuery

public MessagesGetLongPollHistoryQuery(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

ts

public MessagesGetLongPollHistoryQuery ts(java.lang.Integer value)

Last value of the 'ts' parameter returned from the Long Poll server or by using [vk.com/dev/messages.getLongPollHistory|messages.getLongPollHistory] method.

Parameters:

value - value of "ts" parameter. Minimum is 0.

Returns:

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

pts

public MessagesGetLongPollHistoryQuery pts(java.lang.Integer value)

Last value of 'pts' parameter returned from the Long Poll server or by using [vk.com/dev/messages.getLongPollHistory|messages.getLongPollHistory] method.

Parameters:

value - value of "pts" parameter. Minimum is 0.

Returns:

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

previewLength

public MessagesGetLongPollHistoryQuery previewLength(java.lang.Integer value)

Number of characters after which to truncate a previewed message. To preview the full message, specify '0'. "NOTE: Messages are not truncated by default. Messages are truncated by words."

Parameters:

value - value of "preview length" parameter. Minimum is 0.

Returns:

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

onlines

public MessagesGetLongPollHistoryQuery onlines(java.lang.Boolean value)

'1' - to return history with online users only.

Parameters:

value - value of "onlines" parameter.

Returns:

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

eventsLimit

public MessagesGetLongPollHistoryQuery eventsLimit(java.lang.Integer value)

Maximum number of events to return.

Parameters:

value - value of "events limit" parameter. Minimum is 1000. By default 1000.

Returns:

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

msgsLimit

public MessagesGetLongPollHistoryQuery msgsLimit(java.lang.Integer value)

Maximum number of messages to return.

Parameters:

value - value of "msgs limit" parameter. Minimum is 200. By default 200.

Returns:

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

maxMsgId

public MessagesGetLongPollHistoryQuery maxMsgId(java.lang.Integer value)

Maximum ID of the message among existing ones in the local copy. Both messages received with API methods (for example, , ), and data received from a Long Poll server (events with code 4) are taken into account.

Parameters:

value - value of "max msg id" parameter. Minimum is 0.

Returns:

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

groupId

public MessagesGetLongPollHistoryQuery groupId(java.lang.Long value)

Group ID (for group messages with user 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.

lpVersion

public MessagesGetLongPollHistoryQuery lpVersion(java.lang.Integer value)

Set lp version

Parameters:

value - value of "lp version" parameter. Minimum is 0.

Returns:

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

lastN

public MessagesGetLongPollHistoryQuery lastN(java.lang.Integer value)

Set last n

Parameters:

value - value of "last n" parameter. Maximum is 2000. Minimum is 0. By default 0.

Returns:

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

credentials

public MessagesGetLongPollHistoryQuery credentials(java.lang.Boolean value)

Set credentials

Parameters:

value - value of "credentials" parameter.

Returns:

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

extended

public MessagesGetLongPollHistoryQuery extended(java.lang.Boolean value)

Set extended

Parameters:

value - value of "extended" parameter. By default false.

Returns:

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

fields

public MessagesGetLongPollHistoryQuery fields(Fields... value)

fields Additional profile [vk.com/dev/fields|fields] to return.

Parameters:

value - value of "fields" parameter. By default photo,photo_medium_rec,sex,online,screen_name.

Returns:

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

fields

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

Additional profile [vk.com/dev/fields|fields] to return.

Parameters:

value - value of "fields" parameter. By default photo,photo_medium_rec,sex,online,screen_name.

Returns:

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

getThis

protected MessagesGetLongPollHistoryQuery getThis()

Description copied from class: AbstractQueryBuilder

Get reference to this object

Specified by:

getThis in class AbstractQueryBuilder<MessagesGetLongPollHistoryQuery,GetLongPollHistoryResponse>

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<MessagesGetLongPollHistoryQuery,GetLongPollHistoryResponse>

Returns:

list of names