com.vk.api.sdk.queries.messages

Class MessagesGetImportantMessagesQuery

java.lang.Object

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

com.vk.api.sdk.client.AbstractQueryBuilder<MessagesGetImportantMessagesQuery,GetImportantMessagesResponse>

com.vk.api.sdk.queries.messages.MessagesGetImportantMessagesQuery

public class MessagesGetImportantMessagesQuery
extends AbstractQueryBuilder<MessagesGetImportantMessagesQuery,GetImportantMessagesResponse>

Query for Messages.getImportantMessages method

Constructor Summary

Constructors

Constructor and Description
MessagesGetImportantMessagesQuery(VkApiClient client, GroupActor actor) Creates a AbstractQueryBuilder instance that can be used to build group api request with various parameters
MessagesGetImportantMessagesQuery(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
MessagesGetImportantMessagesQuery	count(java.lang.Integer value) Amount of needed important messages.
protected java.util.List<java.lang.String>	essentialKeys() Get list of required parameter names
MessagesGetImportantMessagesQuery	extended(java.lang.Boolean value) Return extended properties
MessagesGetImportantMessagesQuery	fields(java.util.List<UserGroupFields> value) Actors fields to return.
MessagesGetImportantMessagesQuery	fields(UserGroupFields... value) fields Actors fields to return.
protected MessagesGetImportantMessagesQuery	getThis() Get reference to this object
MessagesGetImportantMessagesQuery	groupId(java.lang.Long value) Group ID (for group messages with group access token)
MessagesGetImportantMessagesQuery	offset(java.lang.Integer value) Set offset
MessagesGetImportantMessagesQuery	previewLength(java.lang.Integer value) Maximum length of messages body.
MessagesGetImportantMessagesQuery	startMessageId(java.lang.Integer value) Set start message 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

MessagesGetImportantMessagesQuery

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

MessagesGetImportantMessagesQuery

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

count

public MessagesGetImportantMessagesQuery count(java.lang.Integer value)

Amount of needed important messages.

Parameters:

value - value of "count" parameter. Maximum is 200. Minimum is 0. By default 20.

Returns:

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

offset

public MessagesGetImportantMessagesQuery offset(java.lang.Integer value)

Set offset

Parameters:

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

Returns:

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

startMessageId

public MessagesGetImportantMessagesQuery startMessageId(java.lang.Integer value)

Set start message id

Parameters:

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

Returns:

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

previewLength

public MessagesGetImportantMessagesQuery previewLength(java.lang.Integer value)

Maximum length of messages body.

Parameters:

value - value of "preview length" parameter. Minimum is 0.

Returns:

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

extended

public MessagesGetImportantMessagesQuery extended(java.lang.Boolean value)

Return extended properties

Parameters:

value - value of "extended" parameter.

Returns:

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

groupId

public MessagesGetImportantMessagesQuery groupId(java.lang.Long value)

Group ID (for group messages with group 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.

fields

public MessagesGetImportantMessagesQuery fields(UserGroupFields... value)

fields Actors fields to return.

Parameters:

value - value of "fields" parameter.

Returns:

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

fields

public MessagesGetImportantMessagesQuery fields(java.util.List<UserGroupFields> value)

Actors fields to return.

Parameters:

value - value of "fields" parameter.

Returns:

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

getThis

protected MessagesGetImportantMessagesQuery getThis()

Description copied from class: AbstractQueryBuilder

Get reference to this object

Specified by:

getThis in class AbstractQueryBuilder<MessagesGetImportantMessagesQuery,GetImportantMessagesResponse>

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<MessagesGetImportantMessagesQuery,GetImportantMessagesResponse>

Returns:

list of names