com.vk.api.sdk.queries.messages

Class MessagesGetHistoryAttachmentsQuery

java.lang.Object

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

com.vk.api.sdk.client.AbstractQueryBuilder<MessagesGetHistoryAttachmentsQuery,GetHistoryAttachmentsResponse>

com.vk.api.sdk.queries.messages.MessagesGetHistoryAttachmentsQuery

public class MessagesGetHistoryAttachmentsQuery
extends AbstractQueryBuilder<MessagesGetHistoryAttachmentsQuery,GetHistoryAttachmentsResponse>

Query for Messages.getHistoryAttachments method

Constructor Summary

Constructors

Constructor and Description
MessagesGetHistoryAttachmentsQuery(VkApiClient client, GroupActor actor) Creates a AbstractQueryBuilder instance that can be used to build group api request with various parameters
MessagesGetHistoryAttachmentsQuery(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
MessagesGetHistoryAttachmentsQuery	attachmentPosition(java.lang.Integer value) Set attachment position
MessagesGetHistoryAttachmentsQuery	attachmentTypes(java.util.List<java.lang.String> value) Set attachment types
MessagesGetHistoryAttachmentsQuery	attachmentTypes(java.lang.String... value) attachmentTypes Set attachment types
MessagesGetHistoryAttachmentsQuery	cmid(java.lang.Integer value) Set cmid
MessagesGetHistoryAttachmentsQuery	count(java.lang.Integer value) Number of objects to return.
protected java.util.List<java.lang.String>	essentialKeys() Get list of required parameter names
MessagesGetHistoryAttachmentsQuery	extended(java.lang.Boolean value) Set extended
MessagesGetHistoryAttachmentsQuery	fields(Fields... value) fields Additional profile [vk.com/dev/fields|fields] to return.
MessagesGetHistoryAttachmentsQuery	fields(java.util.List<Fields> value) Additional profile [vk.com/dev/fields|fields] to return.
protected MessagesGetHistoryAttachmentsQuery	getThis() Get reference to this object
MessagesGetHistoryAttachmentsQuery	groupId(java.lang.Long value) Group ID (for group messages with group access token)
MessagesGetHistoryAttachmentsQuery	maxForwardsLevel(java.lang.Integer value) Set max forwards level
MessagesGetHistoryAttachmentsQuery	mediaType(GetHistoryAttachmentsMediaType value) Type of media files to return: *'photo',, *'video',, *'audio',, *'doc',, *'link'.
MessagesGetHistoryAttachmentsQuery	offset(java.lang.Integer value) Set offset
MessagesGetHistoryAttachmentsQuery	peerId(java.lang.Long value) Peer ID. ", For group chat: '2000000000 + chat ID' , , For community: '-community ID'"
MessagesGetHistoryAttachmentsQuery	photoSizes(java.lang.Boolean value) '1' - to return photo sizes in a
MessagesGetHistoryAttachmentsQuery	preserveOrder(java.lang.Boolean value) Set preserve order
MessagesGetHistoryAttachmentsQuery	startFrom(java.lang.String value) Message ID to start return results from.

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

MessagesGetHistoryAttachmentsQuery

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

MessagesGetHistoryAttachmentsQuery

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

groupId

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

peerId

public MessagesGetHistoryAttachmentsQuery peerId(java.lang.Long value)

Peer ID. ", For group chat: '2000000000 + chat ID' , , For community: '-community ID'"

Parameters:

value - value of "peer id" parameter. Entity - peer

Returns:

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

cmid

public MessagesGetHistoryAttachmentsQuery cmid(java.lang.Integer value)

Set cmid

Parameters:

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

Returns:

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

attachmentPosition

public MessagesGetHistoryAttachmentsQuery attachmentPosition(java.lang.Integer value)

Set attachment position

Parameters:

value - value of "attachment position" parameter. Maximum is 200. Minimum is 1.

Returns:

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

offset

public MessagesGetHistoryAttachmentsQuery offset(java.lang.Integer value)

Set offset

Parameters:

value - value of "offset" parameter. Maximum is 200. Minimum is -200.

Returns:

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

count

public MessagesGetHistoryAttachmentsQuery count(java.lang.Integer value)

Number of objects to return.

Parameters:

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

Returns:

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

extended

public MessagesGetHistoryAttachmentsQuery extended(java.lang.Boolean value)

Set extended

Parameters:

value - value of "extended" parameter. By default false.

Returns:

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

maxForwardsLevel

public MessagesGetHistoryAttachmentsQuery maxForwardsLevel(java.lang.Integer value)

Set max forwards level

Parameters:

value - value of "max forwards level" parameter. Maximum is 45. Minimum is 0. By default 45.

Returns:

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

mediaType

public MessagesGetHistoryAttachmentsQuery mediaType(GetHistoryAttachmentsMediaType value)

Type of media files to return: *'photo',, *'video',, *'audio',, *'doc',, *'link'.,*'market'.,*'wall'.,*'share'

Parameters:

value - value of "media type" parameter. By default photo.

Returns:

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

startFrom

public MessagesGetHistoryAttachmentsQuery startFrom(java.lang.String value)

Message ID to start return results from.

Parameters:

value - value of "start from" parameter.

Returns:

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

preserveOrder

public MessagesGetHistoryAttachmentsQuery preserveOrder(java.lang.Boolean value)

Set preserve order

Parameters:

value - value of "preserve order" parameter.

Returns:

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

photoSizes

public MessagesGetHistoryAttachmentsQuery photoSizes(java.lang.Boolean value)

'1' - to return photo sizes in a

Parameters:

value - value of "photo sizes" parameter.

Returns:

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

attachmentTypes

public MessagesGetHistoryAttachmentsQuery attachmentTypes(java.lang.String... value)

attachmentTypes Set attachment types

Parameters:

value - value of "attachment types" parameter.

Returns:

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

attachmentTypes

public MessagesGetHistoryAttachmentsQuery attachmentTypes(java.util.List<java.lang.String> value)

Set attachment types

Parameters:

value - value of "attachment types" parameter.

Returns:

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

fields

public MessagesGetHistoryAttachmentsQuery fields(Fields... value)

fields Additional profile [vk.com/dev/fields|fields] to return.

Parameters:

value - value of "fields" parameter.

Returns:

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

fields

public MessagesGetHistoryAttachmentsQuery fields(java.util.List<Fields> value)

Additional profile [vk.com/dev/fields|fields] to return.

Parameters:

value - value of "fields" parameter.

Returns:

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

getThis

protected MessagesGetHistoryAttachmentsQuery getThis()

Description copied from class: AbstractQueryBuilder

Get reference to this object

Specified by:

getThis in class AbstractQueryBuilder<MessagesGetHistoryAttachmentsQuery,GetHistoryAttachmentsResponse>

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<MessagesGetHistoryAttachmentsQuery,GetHistoryAttachmentsResponse>

Returns:

list of names