com.vk.api.sdk.queries.messages

Class MessagesEditQuery

java.lang.Object

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

com.vk.api.sdk.client.AbstractQueryBuilder<MessagesEditQuery,BoolResponse>

com.vk.api.sdk.queries.messages.MessagesEditQuery

public class MessagesEditQuery
extends AbstractQueryBuilder<MessagesEditQuery,BoolResponse>

Query for Messages.edit method

Constructor Summary

Constructors

Constructor and Description
MessagesEditQuery(VkApiClient client, GroupActor actor) Creates a AbstractQueryBuilder instance that can be used to build group api request with various parameters
MessagesEditQuery(VkApiClient client, GroupActor actor, java.lang.Long peerId) Creates a AbstractQueryBuilder instance that can be used to build group api request with various parameters
MessagesEditQuery(VkApiClient client, UserActor actor) Creates a AbstractQueryBuilder instance that can be used to build user api request with various parameters
MessagesEditQuery(VkApiClient client, UserActor actor, java.lang.Long peerId) Creates a AbstractQueryBuilder instance that can be used to build user api request with various parameters

Method Summary

Modifier and Type	Method and Description
MessagesEditQuery	attachment(java.lang.String value) (Required if 'message' is not set.)
MessagesEditQuery	cmid(java.lang.Integer value) Set cmid
MessagesEditQuery	disableMentions(java.lang.Boolean value) Set disable mentions
MessagesEditQuery	dontParseLinks(java.lang.Boolean value) Set dont parse links
protected java.util.List<java.lang.String>	essentialKeys() Get list of required parameter names
protected MessagesEditQuery	getThis() Get reference to this object
MessagesEditQuery	groupId(java.lang.Long value) Group ID (for group messages with user access token)
MessagesEditQuery	keepForwardMessages(java.lang.Boolean value) '1' - to keep forwarded, messages.
MessagesEditQuery	keepSnippets(java.lang.Boolean value) '1' - to keep attached snippets.
MessagesEditQuery	keyboard(java.lang.String value) Set keyboard
MessagesEditQuery	lat(java.lang.Number value) Geographical latitude of a check-in, in degrees (from -90 to 90).
MessagesEditQuery	lng(java.lang.Number value) Geographical longitude of a check-in, in degrees (from -180 to 180).
MessagesEditQuery	message(java.lang.String value) (Required if 'attachments' is not set.)
MessagesEditQuery	messageId(java.lang.Integer value) Set message id
MessagesEditQuery	peerId(java.lang.Long value) Destination ID.
MessagesEditQuery	template(java.lang.String value) Set template

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

MessagesEditQuery

public MessagesEditQuery(VkApiClient client,
                         GroupActor actor,
                         java.lang.Long peerId)

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

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

MessagesEditQuery

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

MessagesEditQuery

public MessagesEditQuery(VkApiClient client,
                         UserActor actor,
                         java.lang.Long peerId)

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

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

MessagesEditQuery

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

peerId

public MessagesEditQuery peerId(java.lang.Long value)

Destination ID. "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 id" parameter. Entity - peer

Returns:

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

message

public MessagesEditQuery message(java.lang.String value)

(Required if 'attachments' is not set.) Text of the message.

Parameters:

value - value of "message" parameter.

Returns:

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

lat

public MessagesEditQuery lat(java.lang.Number value)

Geographical latitude of a check-in, in degrees (from -90 to 90).

Parameters:

value - value of "lat" parameter.

Returns:

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

lng

public MessagesEditQuery lng(java.lang.Number value)

Geographical longitude of a check-in, in degrees (from -180 to 180).

Parameters:

value - value of "long" parameter.

Returns:

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

attachment

public MessagesEditQuery attachment(java.lang.String value)

(Required if 'message' is not set.) List of objects attached to the message, separated by commas, in the following format: "_", ' - Type of media attachment: 'photo' - photo, 'video' - video, 'audio' - audio, 'doc' - document, 'wall' - wall post, '' - ID of the media attachment owner. '' - media attachment ID. Example: "photo100172_166443618"

Parameters:

value - value of "attachment" parameter.

Returns:

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

keepForwardMessages

public MessagesEditQuery keepForwardMessages(java.lang.Boolean value)

'1' - to keep forwarded, messages.

Parameters:

value - value of "keep forward messages" parameter.

Returns:

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

keepSnippets

public MessagesEditQuery keepSnippets(java.lang.Boolean value)

'1' - to keep attached snippets.

Parameters:

value - value of "keep snippets" parameter.

Returns:

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

groupId

public MessagesEditQuery groupId(java.lang.Long value)

Group ID (for group messages with user 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.

dontParseLinks

public MessagesEditQuery dontParseLinks(java.lang.Boolean value)

Set dont parse links

Parameters:

value - value of "dont parse links" parameter. By default false.

Returns:

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

disableMentions

public MessagesEditQuery disableMentions(java.lang.Boolean value)

Set disable mentions

Parameters:

value - value of "disable mentions" parameter. By default false.

Returns:

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

messageId

public MessagesEditQuery messageId(java.lang.Integer value)

Set message id

Parameters:

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

Returns:

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

cmid

public MessagesEditQuery cmid(java.lang.Integer value)

Set cmid

Parameters:

value - value of "cmid" parameter. Minimum is 0.

Returns:

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

template

public MessagesEditQuery template(java.lang.String value)

Set template

Parameters:

value - value of "template" parameter.

Returns:

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

keyboard

public MessagesEditQuery keyboard(java.lang.String value)

Set keyboard

Parameters:

value - value of "keyboard" parameter.

Returns:

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

getThis

protected MessagesEditQuery getThis()

Description copied from class: AbstractQueryBuilder

Get reference to this object

Specified by:

getThis in class AbstractQueryBuilder<MessagesEditQuery,BoolResponse>

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<MessagesEditQuery,BoolResponse>

Returns:

list of names