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

Class MessagesMarkAsImportantQuery

java.lang.Object

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

com.vk.api.sdk.client.AbstractQueryBuilder<MessagesMarkAsImportantQuery,java.util.List<java.lang.Integer>>

com.vk.api.sdk.queries.messages.MessagesMarkAsImportantQuery

public class MessagesMarkAsImportantQuery
extends AbstractQueryBuilder<MessagesMarkAsImportantQuery,java.util.List<java.lang.Integer>>

Query for Messages.markAsImportant method

Constructor Summary

Constructors

Constructor	Description
MessagesMarkAsImportantQuery(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
protected java.util.List<java.lang.String>	essentialKeys()	Get list of required parameter names
protected MessagesMarkAsImportantQuery	getThis()	Get reference to this object
MessagesMarkAsImportantQuery	important(java.lang.Integer value)	'1' — to add a star (mark as important), '0' — to remove the star
MessagesMarkAsImportantQuery	messageIds(java.lang.Integer... value)	message_ids IDs of messages to mark as important.
MessagesMarkAsImportantQuery	messageIds(java.util.List<java.lang.Integer> value)	IDs of messages to mark as important.

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

MessagesMarkAsImportantQuery

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

Method Detail

important

public MessagesMarkAsImportantQuery important(java.lang.Integer value)

'1' — to add a star (mark as important), '0' — to remove the star

Parameters:

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

Returns:

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

messageIds

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

message_ids IDs of messages to mark as important.

Parameters:

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

Returns:

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

messageIds

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

IDs of messages to mark as important.

Parameters:

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

Returns:

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

getThis

protected MessagesMarkAsImportantQuery getThis()

Description copied from class: AbstractQueryBuilder

Get reference to this object

Specified by:

getThis in class AbstractQueryBuilder<MessagesMarkAsImportantQuery,java.util.List<java.lang.Integer>>

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<MessagesMarkAsImportantQuery,java.util.List<java.lang.Integer>>

Returns:

list of names