com.vk.api.sdk.queries.messages

Class MessagesGetChatQuery

java.lang.Object

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

com.vk.api.sdk.client.AbstractQueryBuilder<MessagesGetChatQuery,GetChatResponse>

com.vk.api.sdk.queries.messages.MessagesGetChatQuery

public class MessagesGetChatQuery
extends AbstractQueryBuilder<MessagesGetChatQuery,GetChatResponse>

Query for Messages.getChat method

Constructor Summary

Constructors

Constructor and Description
MessagesGetChatQuery(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
MessagesGetChatQuery	chatId(java.lang.Integer value) Chat ID.
MessagesGetChatQuery	chatIds(java.lang.Integer... value) chatIds Chat IDs.
MessagesGetChatQuery	chatIds(java.util.List<java.lang.Integer> value) Chat IDs.
protected java.util.List<java.lang.String>	essentialKeys() Get list of required parameter names
MessagesGetChatQuery	fields(Fields... value) fields Profile fields to return.
MessagesGetChatQuery	fields(java.util.List<Fields> value) Profile fields to return.
protected MessagesGetChatQuery	getThis() Get reference to this object
MessagesGetChatQuery	nameCase(NameCase value) Case for declension of user name and surname: 'nom' - nominative (default), 'gen' - genitive , 'dat' - dative, 'acc' - accusative , 'ins' - instrumental , 'abl' - prepositional

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

MessagesGetChatQuery

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

chatId

public MessagesGetChatQuery chatId(java.lang.Integer value)

Chat ID.

Parameters:

value - value of "chat id" parameter. Maximum is 100000000. Minimum is 0.

Returns:

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

nameCase

public MessagesGetChatQuery nameCase(NameCase value)

Case for declension of user name and surname: 'nom' - nominative (default), 'gen' - genitive , 'dat' - dative, 'acc' - accusative , 'ins' - instrumental , 'abl' - prepositional

Parameters:

value - value of "name case" parameter.

Returns:

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

chatIds

public MessagesGetChatQuery chatIds(java.lang.Integer... value)

chatIds Chat IDs.

Parameters:

value - value of "chat ids" parameter.

Returns:

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

chatIds

public MessagesGetChatQuery chatIds(java.util.List<java.lang.Integer> value)

Chat IDs.

Parameters:

value - value of "chat ids" parameter.

Returns:

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

fields

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

Description copied from class: AbstractQueryBuilder

Get reference to this object

Specified by:

getThis in class AbstractQueryBuilder<MessagesGetChatQuery,GetChatResponse>

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<MessagesGetChatQuery,GetChatResponse>

Returns:

list of names