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

Class MessagesGetImportantMessagesQueryWithExtended

java.lang.Object

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

com.vk.api.sdk.client.AbstractQueryBuilder<MessagesGetImportantMessagesQueryWithExtended,GetImportantMessagesExtendedResponse>

com.vk.api.sdk.queries.messages.MessagesGetImportantMessagesQueryWithExtended

public class MessagesGetImportantMessagesQueryWithExtended
extends AbstractQueryBuilder<MessagesGetImportantMessagesQueryWithExtended,GetImportantMessagesExtendedResponse>

Query for Messages.getImportantMessages method

Constructor Summary

Constructors

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

MessagesGetImportantMessagesQueryWithExtended

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

MessagesGetImportantMessagesQueryWithExtended

public MessagesGetImportantMessagesQueryWithExtended(VkApiClient client,
                                                     GroupActor 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

count

public MessagesGetImportantMessagesQueryWithExtended 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 MessagesGetImportantMessagesQueryWithExtended 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 MessagesGetImportantMessagesQueryWithExtended 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 MessagesGetImportantMessagesQueryWithExtended 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

protected MessagesGetImportantMessagesQueryWithExtended 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 MessagesGetImportantMessagesQueryWithExtended groupId(java.lang.Integer value)

Group ID (for group messages with group access token)

Parameters:

value - value of "group id" parameter. Minimum is 0.

Returns:

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

fields

public MessagesGetImportantMessagesQueryWithExtended 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 MessagesGetImportantMessagesQueryWithExtended 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 MessagesGetImportantMessagesQueryWithExtended getThis()

Description copied from class: AbstractQueryBuilder

Get reference to this object

Specified by:

getThis in class AbstractQueryBuilder<MessagesGetImportantMessagesQueryWithExtended,GetImportantMessagesExtendedResponse>

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<MessagesGetImportantMessagesQueryWithExtended,GetImportantMessagesExtendedResponse>

Returns:

list of names