com.vk.api.sdk.queries.messages

Class MessagesSearchConversationsQuery

java.lang.Object

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

com.vk.api.sdk.client.AbstractQueryBuilder<MessagesSearchConversationsQuery,SearchConversationsResponse>

com.vk.api.sdk.queries.messages.MessagesSearchConversationsQuery

public class MessagesSearchConversationsQuery
extends AbstractQueryBuilder<MessagesSearchConversationsQuery,SearchConversationsResponse>

Query for Messages.searchConversations method

Constructor Summary

Constructors

Constructor and Description
MessagesSearchConversationsQuery(VkApiClient client, GroupActor actor) Creates a AbstractQueryBuilder instance that can be used to build group api request with various parameters
MessagesSearchConversationsQuery(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
MessagesSearchConversationsQuery	count(java.lang.Integer value) Maximum number of results.
protected java.util.List<java.lang.String>	essentialKeys() Get list of required parameter names
MessagesSearchConversationsQuery	extended(java.lang.Boolean value) '1' - return extra information about users and communities
MessagesSearchConversationsQuery	fields(Fields... value) fields Profile fields to return.
MessagesSearchConversationsQuery	fields(java.util.List<Fields> value) Profile fields to return.
protected MessagesSearchConversationsQuery	getThis() Get reference to this object
MessagesSearchConversationsQuery	groupId(java.lang.Long value) Group ID (for group messages with user access token)
MessagesSearchConversationsQuery	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

MessagesSearchConversationsQuery

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

MessagesSearchConversationsQuery

public MessagesSearchConversationsQuery(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 MessagesSearchConversationsQuery 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.

count

public MessagesSearchConversationsQuery count(java.lang.Integer value)

Maximum number of results.

Parameters:

value - value of "count" parameter. Maximum is 255. Minimum is 1. By default 20.

Returns:

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

extended

public MessagesSearchConversationsQuery extended(java.lang.Boolean value)

'1' - return extra information about users and communities

Parameters:

value - value of "extended" parameter.

Returns:

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

groupId

public MessagesSearchConversationsQuery 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.

fields

public MessagesSearchConversationsQuery 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 MessagesSearchConversationsQuery 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 MessagesSearchConversationsQuery getThis()

Description copied from class: AbstractQueryBuilder

Get reference to this object

Specified by:

getThis in class AbstractQueryBuilder<MessagesSearchConversationsQuery,SearchConversationsResponse>

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<MessagesSearchConversationsQuery,SearchConversationsResponse>

Returns:

list of names