com.vk.api.sdk.queries.messages

Class MessagesDeleteQueryWithFull

java.lang.Object

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

com.vk.api.sdk.client.AbstractQueryBuilder<MessagesDeleteQueryWithFull,java.util.List<DeleteFullResponse>>

com.vk.api.sdk.queries.messages.MessagesDeleteQueryWithFull

public class MessagesDeleteQueryWithFull
extends AbstractQueryBuilder<MessagesDeleteQueryWithFull,java.util.List<DeleteFullResponse>>

Query for Messages.delete method

Constructor Summary

Constructors

Constructor and Description
MessagesDeleteQueryWithFull(VkApiClient client, GroupActor actor) Creates a AbstractQueryBuilder instance that can be used to build group api request with various parameters
MessagesDeleteQueryWithFull(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
MessagesDeleteQueryWithFull	cmids(java.lang.Integer... value) cmids Conversation message IDs.
MessagesDeleteQueryWithFull	cmids(java.util.List<java.lang.Integer> value) Conversation message IDs.
MessagesDeleteQueryWithFull	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 MessagesDeleteQueryWithFull	getThis() Get reference to this object
MessagesDeleteQueryWithFull	groupId(java.lang.Long value) Group ID (for group messages with user access token)
MessagesDeleteQueryWithFull	messageIds(java.lang.Integer... value) messageIds Message IDs.
MessagesDeleteQueryWithFull	messageIds(java.util.List<java.lang.Integer> value) Message IDs.
MessagesDeleteQueryWithFull	peerId(java.lang.Long value) Destination ID.
MessagesDeleteQueryWithFull	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, 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

MessagesDeleteQueryWithFull

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

MessagesDeleteQueryWithFull

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

spam

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

deleteForAll

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

messageIds

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

cmids

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

cmids Conversation message IDs.

Parameters:

value - value of "cmids" parameter.

Returns:

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

cmids

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

Conversation message IDs.

Parameters:

value - value of "cmids" parameter.

Returns:

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

getThis

protected MessagesDeleteQueryWithFull getThis()

Description copied from class: AbstractQueryBuilder

Get reference to this object

Specified by:

getThis in class AbstractQueryBuilder<MessagesDeleteQueryWithFull,java.util.List<DeleteFullResponse>>

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<MessagesDeleteQueryWithFull,java.util.List<DeleteFullResponse>>

Returns:

list of names