com.vk.api.sdk.queries.messages

Class MessagesDeleteConversationQuery

java.lang.Object

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

com.vk.api.sdk.client.AbstractQueryBuilder<MessagesDeleteConversationQuery,DeleteConversationResponse>

com.vk.api.sdk.queries.messages.MessagesDeleteConversationQuery

public class MessagesDeleteConversationQuery
extends AbstractQueryBuilder<MessagesDeleteConversationQuery,DeleteConversationResponse>

Query for Messages.deleteConversation method

Constructor Summary

Constructors

Constructor and Description
MessagesDeleteConversationQuery(VkApiClient client, GroupActor actor) Creates a AbstractQueryBuilder instance that can be used to build group api request with various parameters
MessagesDeleteConversationQuery(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
protected java.util.List<java.lang.String>	essentialKeys() Get list of required parameter names
protected MessagesDeleteConversationQuery	getThis() Get reference to this object
MessagesDeleteConversationQuery	groupId(java.lang.Long value) Group ID (for group messages with user access token)
MessagesDeleteConversationQuery	peerId(java.lang.Long value) Destination ID.
MessagesDeleteConversationQuery	userId(java.lang.Long value) User ID.

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

MessagesDeleteConversationQuery

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

MessagesDeleteConversationQuery

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

userId

public MessagesDeleteConversationQuery userId(java.lang.Long value)

User ID. To clear a chat history use 'chat_id'

Parameters:

value - value of "user id" parameter. Entity - owner

Returns:

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

peerId

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

groupId

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

getThis

protected MessagesDeleteConversationQuery getThis()

Description copied from class: AbstractQueryBuilder

Get reference to this object

Specified by:

getThis in class AbstractQueryBuilder<MessagesDeleteConversationQuery,DeleteConversationResponse>

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<MessagesDeleteConversationQuery,DeleteConversationResponse>

Returns:

list of names