com.vk.api.sdk.queries.messages

Class MessagesSearchDialogsQuery

java.lang.Object

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

com.vk.api.sdk.client.AbstractQueryBuilder<MessagesSearchDialogsQuery,java.util.List<SearchDialogsResponse>>

com.vk.api.sdk.queries.messages.MessagesSearchDialogsQuery

public class MessagesSearchDialogsQuery
extends AbstractQueryBuilder<MessagesSearchDialogsQuery,java.util.List<SearchDialogsResponse>>

Query for Messages.searchDialogs method

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected java.util.List<java.lang.String>	essentialKeys() Get list of required parameter names
MessagesSearchDialogsQuery	fields(EnumParam... value) Profile fields to return.
MessagesSearchDialogsQuery	fields(java.util.List<EnumParam> value) Profile fields to return.
protected MessagesSearchDialogsQuery	getThis() Get reference to this object
MessagesSearchDialogsQuery	limit(java.lang.Integer value)
MessagesSearchDialogsQuery	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, lang, unsafeParam, unsafeParam, unsafeParam, unsafeParam, unsafeParam, unsafeParam, unsafeParam, unsafeParam, unsafeParam, unsafeParam, unsafeParam, version

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

execute, executeAsRaw, executeAsString, getClient, getGson, getResponseClass, getUrl

Methods inherited from class java.lang.Object

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

Constructor Detail

MessagesSearchDialogsQuery

public MessagesSearchDialogsQuery(VkApiClient client,
                                  UserActor actor)

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

Parameters:

client - VK API client

actor - actor with access token

Method Detail

q

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

limit

public MessagesSearchDialogsQuery limit(java.lang.Integer value)

Parameters:

value - value of "limit" parameter. Minimum is 0. By default 20.

Returns:

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

fields

public MessagesSearchDialogsQuery fields(EnumParam... value)

Profile fields to return.

Parameters:

value - value of "fields" parameter.

Returns:

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

fields

public MessagesSearchDialogsQuery fields(java.util.List<EnumParam> 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 MessagesSearchDialogsQuery getThis()

Description copied from class: AbstractQueryBuilder

Get reference to this object

Specified by:

getThis in class AbstractQueryBuilder<MessagesSearchDialogsQuery,java.util.List<SearchDialogsResponse>>

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<MessagesSearchDialogsQuery,java.util.List<SearchDialogsResponse>>

Returns:

list of names