com.vk.api.sdk.queries.messages

Class MessagesGetByIdQuery

java.lang.Object

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

com.vk.api.sdk.client.AbstractQueryBuilder<MessagesGetByIdQuery,GetByIdResponse>

com.vk.api.sdk.queries.messages.MessagesGetByIdQuery

public class MessagesGetByIdQuery
extends AbstractQueryBuilder<MessagesGetByIdQuery,GetByIdResponse>

Query for Messages.getById method

Constructor Summary

Constructors

Constructor and Description
MessagesGetByIdQuery(VkApiClient client, GroupActor actor) Creates a AbstractQueryBuilder instance that can be used to build group api request with various parameters
MessagesGetByIdQuery(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
MessagesGetByIdQuery	cmids(java.lang.Integer... value) cmids Set cmids
MessagesGetByIdQuery	cmids(java.util.List<java.lang.Integer> value) Set cmids
protected java.util.List<java.lang.String>	essentialKeys() Get list of required parameter names
MessagesGetByIdQuery	extended(java.lang.Boolean value) Information whether the response should be extended
MessagesGetByIdQuery	fields(Fields... value) fields Profile fields to return.
MessagesGetByIdQuery	fields(java.util.List<Fields> value) Profile fields to return.
protected MessagesGetByIdQuery	getThis() Get reference to this object
MessagesGetByIdQuery	groupId(java.lang.Long value) Group ID (for group messages with group access token)
MessagesGetByIdQuery	messageIds(java.lang.Integer... value) messageIds Message IDs.
MessagesGetByIdQuery	messageIds(java.util.List<java.lang.Integer> value) Message IDs.
MessagesGetByIdQuery	peerId(java.lang.Long value) Set peer id
MessagesGetByIdQuery	previewLength(java.lang.Integer value) Number of characters after which to truncate a previewed message.

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

MessagesGetByIdQuery

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

MessagesGetByIdQuery

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

previewLength

public MessagesGetByIdQuery previewLength(java.lang.Integer value)

Number of characters after which to truncate a previewed message. To preview the full message, specify '0'. "NOTE: Messages are not truncated by default. Messages are truncated by words."

Parameters:

value - value of "preview length" parameter. Minimum is 0. By default 0.

Returns:

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

extended

public MessagesGetByIdQuery extended(java.lang.Boolean value)

Information whether the response should be extended

Parameters:

value - value of "extended" parameter.

Returns:

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

groupId

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

peerId

public MessagesGetByIdQuery peerId(java.lang.Long value)

Set peer id

Parameters:

value - value of "peer id" parameter. Entity - peer

Returns:

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

messageIds

public MessagesGetByIdQuery messageIds(java.lang.Integer... value)

messageIds Message IDs.

Parameters:

value - value of "message ids" parameter.

Returns:

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

messageIds

public MessagesGetByIdQuery messageIds(java.util.List<java.lang.Integer> value)

Message IDs.

Parameters:

value - value of "message ids" parameter.

Returns:

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

fields

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

cmids

public MessagesGetByIdQuery cmids(java.lang.Integer... value)

cmids Set cmids

Parameters:

value - value of "cmids" parameter.

Returns:

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

cmids

public MessagesGetByIdQuery cmids(java.util.List<java.lang.Integer> value)

Set cmids

Parameters:

value - value of "cmids" parameter.

Returns:

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

getThis

protected MessagesGetByIdQuery getThis()

Description copied from class: AbstractQueryBuilder

Get reference to this object

Specified by:

getThis in class AbstractQueryBuilder<MessagesGetByIdQuery,GetByIdResponse>

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<MessagesGetByIdQuery,GetByIdResponse>

Returns:

list of names