com.vk.api.sdk.queries.messages

Class MessagesSearchQueryWithExtended

java.lang.Object

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

com.vk.api.sdk.client.AbstractQueryBuilder<MessagesSearchQueryWithExtended,SearchExtendedResponse>

com.vk.api.sdk.queries.messages.MessagesSearchQueryWithExtended

public class MessagesSearchQueryWithExtended
extends AbstractQueryBuilder<MessagesSearchQueryWithExtended,SearchExtendedResponse>

Query for Messages.search method

Constructor Summary

Constructors

Constructor and Description
MessagesSearchQueryWithExtended(VkApiClient client, GroupActor actor) Creates a AbstractQueryBuilder instance that can be used to build group api request with various parameters
MessagesSearchQueryWithExtended(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
MessagesSearchQueryWithExtended	count(java.lang.Integer value) Number of messages to return.
MessagesSearchQueryWithExtended	date(java.lang.Integer value) Date to search message before in Unixtime.
protected java.util.List<java.lang.String>	essentialKeys() Get list of required parameter names
protected MessagesSearchQueryWithExtended	extended(java.lang.Boolean value) Set extended
MessagesSearchQueryWithExtended	fields(java.util.List<java.lang.String> value) Set fields
MessagesSearchQueryWithExtended	fields(java.lang.String... value) fields Set fields
protected MessagesSearchQueryWithExtended	getThis() Get reference to this object
MessagesSearchQueryWithExtended	groupId(java.lang.Long value) Group ID (for group messages with group access token)
MessagesSearchQueryWithExtended	offset(java.lang.Integer value) Offset needed to return a specific subset of messages.
MessagesSearchQueryWithExtended	peerId(java.lang.Long value) Destination ID.
MessagesSearchQueryWithExtended	previewLength(java.lang.Integer value) Number of characters after which to truncate a previewed message.
MessagesSearchQueryWithExtended	q(java.lang.String value) Search query string.

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

MessagesSearchQueryWithExtended

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

MessagesSearchQueryWithExtended

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

q

public MessagesSearchQueryWithExtended q(java.lang.String value)

Search query string.

Parameters:

value - value of "q" parameter.

Returns:

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

peerId

public MessagesSearchQueryWithExtended peerId(java.lang.Long value)

Destination ID. "For user: 'User ID', e.g. '12345'. For chat: '2000000000' + 'chat_id', e.g. '2000000001'. For community: '- community ID', e.g. '-12345'. "

Parameters:

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

Returns:

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

date

public MessagesSearchQueryWithExtended date(java.lang.Integer value)

Date to search message before in Unixtime.

Parameters:

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

Returns:

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

previewLength

public MessagesSearchQueryWithExtended 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. By default 0.

Returns:

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

offset

public MessagesSearchQueryWithExtended offset(java.lang.Integer value)

Offset needed to return a specific subset of messages.

Parameters:

value - value of "offset" parameter. Minimum is 0. By default 0.

Returns:

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

count

public MessagesSearchQueryWithExtended count(java.lang.Integer value)

Number of messages to return.

Parameters:

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

Returns:

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

extended

protected MessagesSearchQueryWithExtended extended(java.lang.Boolean value)

Set extended

Parameters:

value - value of "extended" parameter.

Returns:

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

groupId

public MessagesSearchQueryWithExtended 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 MessagesSearchQueryWithExtended fields(java.lang.String... value)

fields Set fields

Parameters:

value - value of "fields" parameter.

Returns:

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

fields

public MessagesSearchQueryWithExtended fields(java.util.List<java.lang.String> value)

Set fields

Parameters:

value - value of "fields" parameter.

Returns:

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

getThis

protected MessagesSearchQueryWithExtended getThis()

Description copied from class: AbstractQueryBuilder

Get reference to this object

Specified by:

getThis in class AbstractQueryBuilder<MessagesSearchQueryWithExtended,SearchExtendedResponse>

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<MessagesSearchQueryWithExtended,SearchExtendedResponse>

Returns:

list of names