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

Class MessagesPinQuery

java.lang.Object

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

com.vk.api.sdk.client.AbstractQueryBuilder<MessagesPinQuery,PinResponse>

com.vk.api.sdk.queries.messages.MessagesPinQuery

public class MessagesPinQuery
extends AbstractQueryBuilder<MessagesPinQuery,PinResponse>

Query for Messages.pin method

Constructor Summary

Constructors

Constructor	Description
MessagesPinQuery(VkApiClient client, GroupActor actor, int peerId)	Creates a AbstractQueryBuilder instance that can be used to build api request with various parameters
MessagesPinQuery(VkApiClient client, UserActor actor, int peerId)	Creates a AbstractQueryBuilder instance that can be used to build api request with various parameters

Method Summary

Modifier and Type	Method	Description
MessagesPinQuery	conversationMessageId(java.lang.Integer value)	Conversation message ID
protected java.util.List<java.lang.String>	essentialKeys()	Get list of required parameter names
protected MessagesPinQuery	getThis()	Get reference to this object
MessagesPinQuery	messageId(java.lang.Integer value)	Message ID
protected MessagesPinQuery	peerId(int value)	Destination 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

MessagesPinQuery

public MessagesPinQuery(VkApiClient client,
                        UserActor actor,
                        int peerId)

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

peerId - value of "peer id" parameter.

MessagesPinQuery

public MessagesPinQuery(VkApiClient client,
                        GroupActor actor,
                        int peerId)

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

peerId - value of "peer id" parameter.

Method Detail

peerId

protected MessagesPinQuery peerId(int 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.

Returns:

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

messageId

public MessagesPinQuery messageId(java.lang.Integer value)

Message ID

Parameters:

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

Returns:

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

conversationMessageId

public MessagesPinQuery conversationMessageId(java.lang.Integer value)

Conversation message ID

Parameters:

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

Returns:

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

getThis

protected MessagesPinQuery getThis()

Description copied from class: AbstractQueryBuilder

Get reference to this object

Specified by:

getThis in class AbstractQueryBuilder<MessagesPinQuery,PinResponse>

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<MessagesPinQuery,PinResponse>

Returns:

list of names