com.vk.api.sdk.queries.messages

Class MessagesMarkAsReadQuery

java.lang.Object

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

com.vk.api.sdk.client.AbstractQueryBuilder<MessagesMarkAsReadQuery,OkResponse>

com.vk.api.sdk.queries.messages.MessagesMarkAsReadQuery

public class MessagesMarkAsReadQuery
extends AbstractQueryBuilder<MessagesMarkAsReadQuery,OkResponse>

Query for Messages.markAsRead method

Constructor Summary

Constructors

Constructor and Description
MessagesMarkAsReadQuery(VkApiClient client, GroupActor actor) Creates a AbstractQueryBuilder instance that can be used to build group api request with various parameters
MessagesMarkAsReadQuery(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 MessagesMarkAsReadQuery	getThis() Get reference to this object
MessagesMarkAsReadQuery	groupId(java.lang.Long value) Group ID (for group messages with user access token)
MessagesMarkAsReadQuery	markConversationAsRead(java.lang.Boolean value) Set mark conversation as read
MessagesMarkAsReadQuery	messageIds(java.lang.Integer... value) messageIds IDs of messages to mark as read.
MessagesMarkAsReadQuery	messageIds(java.util.List<java.lang.Integer> value) IDs of messages to mark as read.
MessagesMarkAsReadQuery	peerId(java.lang.Long value) Destination ID.
MessagesMarkAsReadQuery	startMessageId(java.lang.Integer value) Message ID to start from.
MessagesMarkAsReadQuery	upToCmid(java.lang.Integer value) Set up to cmid

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

MessagesMarkAsReadQuery

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

MessagesMarkAsReadQuery

public MessagesMarkAsReadQuery(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 MessagesMarkAsReadQuery 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.

startMessageId

public MessagesMarkAsReadQuery startMessageId(java.lang.Integer value)

Message ID to start from.

Parameters:

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

Returns:

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

groupId

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

markConversationAsRead

public MessagesMarkAsReadQuery markConversationAsRead(java.lang.Boolean value)

Set mark conversation as read

Parameters:

value - value of "mark conversation as read" parameter.

Returns:

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

upToCmid

public MessagesMarkAsReadQuery upToCmid(java.lang.Integer value)

Set up to cmid

Parameters:

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

Returns:

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

messageIds

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

messageIds IDs of messages to mark as read.

Parameters:

value - value of "message ids" parameter. By default [].

Returns:

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

messageIds

public MessagesMarkAsReadQuery messageIds(java.util.List<java.lang.Integer> value)

IDs of messages to mark as read.

Parameters:

value - value of "message ids" parameter. By default [].

Returns:

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

getThis

protected MessagesMarkAsReadQuery getThis()

Description copied from class: AbstractQueryBuilder

Get reference to this object

Specified by:

getThis in class AbstractQueryBuilder<MessagesMarkAsReadQuery,OkResponse>

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<MessagesMarkAsReadQuery,OkResponse>

Returns:

list of names