Package com.vk.api.sdk.queries.messages

Class MessagesGetConversationsByIdQuery

java.lang.Object

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

com.vk.api.sdk.client.AbstractQueryBuilder<MessagesGetConversationsByIdQuery,GetConversationsByIdResponse>

com.vk.api.sdk.queries.messages.MessagesGetConversationsByIdQuery

public class MessagesGetConversationsByIdQuery
extends AbstractQueryBuilder<MessagesGetConversationsByIdQuery,GetConversationsByIdResponse>

Query for Messages.getConversationsById method

Constructor Summary

Constructors

Constructor	Description
MessagesGetConversationsByIdQuery(VkApiClient client, GroupActor actor, java.lang.Integer... peerIds)	Creates a AbstractQueryBuilder instance that can be used to build api request with various parameters
MessagesGetConversationsByIdQuery(VkApiClient client, GroupActor actor, java.util.List<java.lang.Integer> peerIds)	Creates a AbstractQueryBuilder instance that can be used to build api request with various parameters
MessagesGetConversationsByIdQuery(VkApiClient client, UserActor actor, java.lang.Integer... peerIds)	Creates a AbstractQueryBuilder instance that can be used to build api request with various parameters
MessagesGetConversationsByIdQuery(VkApiClient client, UserActor actor, java.util.List<java.lang.Integer> peerIds)	Creates a AbstractQueryBuilder instance that can be used to build api request with various parameters

Method Summary

Modifier and Type	Method	Description
protected java.util.List<java.lang.String>	essentialKeys()	Get list of required parameter names
MessagesGetConversationsByIdQuery	extended(java.lang.Boolean value)	Return extended properties
MessagesGetConversationsByIdQuery	fields(UserGroupFields... value)	fields Profile and communities fields to return.
MessagesGetConversationsByIdQuery	fields(java.util.List<UserGroupFields> value)	Profile and communities fields to return.
protected MessagesGetConversationsByIdQuery	getThis()	Get reference to this object
MessagesGetConversationsByIdQuery	groupId(java.lang.Integer value)	Group ID (for group messages with group access token)
protected MessagesGetConversationsByIdQuery	peerIds(java.lang.Integer... value)	peer_ids Destination IDs.
protected MessagesGetConversationsByIdQuery	peerIds(java.util.List<java.lang.Integer> value)	Destination IDs.

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

accessToken, build, captchaKey, captchaSid, clientSecret, confirm, getBody, getMethod, getParams, lang, toString, 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, getHeaders, getResponseClass, getUrl, setHeaders

Methods inherited from class java.lang.Object

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

Constructor Detail

MessagesGetConversationsByIdQuery

public MessagesGetConversationsByIdQuery(VkApiClient client,
                                         UserActor actor,
                                         java.lang.Integer... peerIds)

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

peerIds - value of "peer ids" parameter.

MessagesGetConversationsByIdQuery

public MessagesGetConversationsByIdQuery(VkApiClient client,
                                         UserActor actor,
                                         java.util.List<java.lang.Integer> peerIds)

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

peerIds - value of "peer ids" parameter.

MessagesGetConversationsByIdQuery

public MessagesGetConversationsByIdQuery(VkApiClient client,
                                         GroupActor actor,
                                         java.lang.Integer... peerIds)

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

peerIds - value of "peer ids" parameter.

MessagesGetConversationsByIdQuery

public MessagesGetConversationsByIdQuery(VkApiClient client,
                                         GroupActor actor,
                                         java.util.List<java.lang.Integer> peerIds)

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

peerIds - value of "peer ids" parameter.

Method Detail

extended

public MessagesGetConversationsByIdQuery extended(java.lang.Boolean value)

Return extended properties

Parameters:

value - value of "extended" parameter.

Returns:

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

groupId

public MessagesGetConversationsByIdQuery groupId(java.lang.Integer value)

Group ID (for group messages with group access token)

Parameters:

value - value of "group id" parameter. Minimum is 0.

Returns:

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

peerIds

protected MessagesGetConversationsByIdQuery peerIds(java.lang.Integer... value)

peer_ids Destination IDs. "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 ids" parameter.

Returns:

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

peerIds

protected MessagesGetConversationsByIdQuery peerIds(java.util.List<java.lang.Integer> value)

Destination IDs. "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 ids" parameter.

Returns:

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

fields

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

Description copied from class: AbstractQueryBuilder

Get reference to this object

Specified by:

getThis in class AbstractQueryBuilder<MessagesGetConversationsByIdQuery,GetConversationsByIdResponse>

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<MessagesGetConversationsByIdQuery,GetConversationsByIdResponse>

Returns:

list of names