com.vk.api.sdk.queries.messages

Class MessagesGetByIdQueryWithExtended

java.lang.Object

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

com.vk.api.sdk.client.AbstractQueryBuilder<MessagesGetByIdQueryWithExtended,GetByIdExtendedResponse>

com.vk.api.sdk.queries.messages.MessagesGetByIdQueryWithExtended

public class MessagesGetByIdQueryWithExtended
extends AbstractQueryBuilder<MessagesGetByIdQueryWithExtended,GetByIdExtendedResponse>

Query for Messages.getById method

Constructor Summary

Constructors

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

MessagesGetByIdQueryWithExtended

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

MessagesGetByIdQueryWithExtended

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

protected MessagesGetByIdQueryWithExtended 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 MessagesGetByIdQueryWithExtended 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 MessagesGetByIdQueryWithExtended 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 MessagesGetByIdQueryWithExtended 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 MessagesGetByIdQueryWithExtended 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 MessagesGetByIdQueryWithExtended 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 MessagesGetByIdQueryWithExtended 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 MessagesGetByIdQueryWithExtended 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 MessagesGetByIdQueryWithExtended 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 MessagesGetByIdQueryWithExtended getThis()

Description copied from class: AbstractQueryBuilder

Get reference to this object

Specified by:

getThis in class AbstractQueryBuilder<MessagesGetByIdQueryWithExtended,GetByIdExtendedResponse>

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<MessagesGetByIdQueryWithExtended,GetByIdExtendedResponse>

Returns:

list of names