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

Class MessagesDeleteQuery

java.lang.Object

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

com.vk.api.sdk.client.AbstractQueryBuilder<MessagesDeleteQuery,java.util.Map<java.lang.Integer,java.lang.String>>

com.vk.api.sdk.queries.messages.MessagesDeleteQuery

public class MessagesDeleteQuery
extends AbstractQueryBuilder<MessagesDeleteQuery,java.util.Map<java.lang.Integer,java.lang.String>>

Query for Messages.delete method

Constructor Summary

Constructors

Constructor	Description
MessagesDeleteQuery(VkApiClient client, GroupActor actor)	Creates a AbstractQueryBuilder instance that can be used to build api request with various parameters
MessagesDeleteQuery(VkApiClient client, UserActor actor)	Creates a AbstractQueryBuilder instance that can be used to build api request with various parameters

Method Summary

Modifier and Type	Method	Description
MessagesDeleteQuery	conversationMessageIds(java.lang.Integer... value)	conversation_message_ids Conversation message IDs.
MessagesDeleteQuery	conversationMessageIds(java.util.List<java.lang.Integer> value)	Conversation message IDs.
MessagesDeleteQuery	deleteForAll(java.lang.Boolean value)	'1' — delete message for for all.
protected java.util.List<java.lang.String>	essentialKeys()	Get list of required parameter names
protected MessagesDeleteQuery	getThis()	Get reference to this object
MessagesDeleteQuery	groupId(java.lang.Integer value)	Group ID (for group messages with user access token)
MessagesDeleteQuery	messageIds(java.lang.Integer... value)	message_ids Message IDs.
MessagesDeleteQuery	messageIds(java.util.List<java.lang.Integer> value)	Message IDs.
MessagesDeleteQuery	peerId(java.lang.Integer value)	Destination ID.
MessagesDeleteQuery	spam(java.lang.Boolean value)	'1' — to mark message as spam.

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

MessagesDeleteQuery

public MessagesDeleteQuery(VkApiClient client,
                           UserActor actor)

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

MessagesDeleteQuery

public MessagesDeleteQuery(VkApiClient client,
                           GroupActor actor)

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

Method Detail

spam

public MessagesDeleteQuery spam(java.lang.Boolean value)

'1' — to mark message as spam.

Parameters:

value - value of "spam" parameter.

Returns:

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

groupId

public MessagesDeleteQuery groupId(java.lang.Integer value)

Group ID (for group messages with user access token)

Parameters:

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

Returns:

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

deleteForAll

public MessagesDeleteQuery deleteForAll(java.lang.Boolean value)

'1' — delete message for for all.

Parameters:

value - value of "delete for all" parameter. By default false.

Returns:

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

peerId

public MessagesDeleteQuery peerId(java.lang.Integer 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.

Returns:

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

messageIds

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

message_ids Message IDs.

Parameters:

value - value of "message ids" parameter.

Returns:

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

messageIds

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

conversationMessageIds

public MessagesDeleteQuery conversationMessageIds(java.lang.Integer... value)

conversation_message_ids Conversation message IDs.

Parameters:

value - value of "conversation message ids" parameter.

Returns:

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

conversationMessageIds

public MessagesDeleteQuery conversationMessageIds(java.util.List<java.lang.Integer> value)

Conversation message IDs.

Parameters:

value - value of "conversation message ids" parameter.

Returns:

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

getThis

protected MessagesDeleteQuery getThis()

Description copied from class: AbstractQueryBuilder

Get reference to this object

Specified by:

getThis in class AbstractQueryBuilder<MessagesDeleteQuery,java.util.Map<java.lang.Integer,java.lang.String>>

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<MessagesDeleteQuery,java.util.Map<java.lang.Integer,java.lang.String>>

Returns:

list of names