com.vk.api.sdk.queries.messages

Class MessagesGetConversationsQuery

java.lang.Object

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

com.vk.api.sdk.client.AbstractQueryBuilder<MessagesGetConversationsQuery,GetConversationsResponse>

com.vk.api.sdk.queries.messages.MessagesGetConversationsQuery

public class MessagesGetConversationsQuery
extends AbstractQueryBuilder<MessagesGetConversationsQuery,GetConversationsResponse>

Query for Messages.getConversations method

Constructor Summary

Constructors

Constructor and Description
MessagesGetConversationsQuery(VkApiClient client, GroupActor actor) Creates a AbstractQueryBuilder instance that can be used to build group api request with various parameters
MessagesGetConversationsQuery(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
MessagesGetConversationsQuery	count(java.lang.Integer value) Number of conversations to return.
protected java.util.List<java.lang.String>	essentialKeys() Get list of required parameter names
MessagesGetConversationsQuery	extended(java.lang.Boolean value) '1' - return extra information about users and communities
MessagesGetConversationsQuery	fields(java.util.List<UserGroupFields> value) Profile and communities fields to return.
MessagesGetConversationsQuery	fields(UserGroupFields... value) fields Profile and communities fields to return.
MessagesGetConversationsQuery	filter(GetConversationsFilter value) Filter to apply: 'all' - all conversations, 'unread' - conversations with unread messages, 'important' - conversations, marked as important (only for community messages), 'unanswered' - conversations, marked as unanswered (only for community messages)
protected MessagesGetConversationsQuery	getThis() Get reference to this object
MessagesGetConversationsQuery	groupId(java.lang.Long value) Group ID (for group messages with group access token)
MessagesGetConversationsQuery	offset(java.lang.Integer value) Offset needed to return a specific subset of conversations.
MessagesGetConversationsQuery	startMessageId(java.lang.Integer value) ID of the message from what to return dialogs.

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

MessagesGetConversationsQuery

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

MessagesGetConversationsQuery

public MessagesGetConversationsQuery(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 MessagesGetConversationsQuery offset(java.lang.Integer value)

Offset needed to return a specific subset of conversations.

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 MessagesGetConversationsQuery count(java.lang.Integer value)

Number of conversations 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.

filter

public MessagesGetConversationsQuery filter(GetConversationsFilter value)

Filter to apply: 'all' - all conversations, 'unread' - conversations with unread messages, 'important' - conversations, marked as important (only for community messages), 'unanswered' - conversations, marked as unanswered (only for community messages)

Parameters:

value - value of "filter" parameter. By default all.

Returns:

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

extended

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

startMessageId

public MessagesGetConversationsQuery startMessageId(java.lang.Integer value)

ID of the message from what to return dialogs.

Parameters:

value - value of "start message id" parameter. Minimum is 0.

Returns:

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

groupId

public MessagesGetConversationsQuery 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 MessagesGetConversationsQuery fields(UserGroupFields... value)

fields Profile and communities fields to return.

Parameters:

value - value of "fields" parameter.

Returns:

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

fields

public MessagesGetConversationsQuery fields(java.util.List<UserGroupFields> value)

Profile and communities fields to return.

Parameters:

value - value of "fields" parameter.

Returns:

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

getThis

protected MessagesGetConversationsQuery getThis()

Description copied from class: AbstractQueryBuilder

Get reference to this object

Specified by:

getThis in class AbstractQueryBuilder<MessagesGetConversationsQuery,GetConversationsResponse>

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<MessagesGetConversationsQuery,GetConversationsResponse>

Returns:

list of names