com.vk.api.sdk.queries.messages

Class MessagesAddChatUserQuery

java.lang.Object

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

com.vk.api.sdk.client.AbstractQueryBuilder<MessagesAddChatUserQuery,OkResponse>

com.vk.api.sdk.queries.messages.MessagesAddChatUserQuery

public class MessagesAddChatUserQuery
extends AbstractQueryBuilder<MessagesAddChatUserQuery,OkResponse>

Query for Messages.addChatUser method

Constructor Summary

Constructors

Constructor and Description
MessagesAddChatUserQuery(VkApiClient client, UserActor actor) Creates a AbstractQueryBuilder instance that can be used to build user api request with various parameters
MessagesAddChatUserQuery(VkApiClient client, UserActor actor, java.lang.Integer chatId) Creates a AbstractQueryBuilder instance that can be used to build user api request with various parameters

Method Summary

Modifier and Type	Method and Description
MessagesAddChatUserQuery	chatId(java.lang.Integer value) Chat ID.
protected java.util.List<java.lang.String>	essentialKeys() Get list of required parameter names
protected MessagesAddChatUserQuery	getThis() Get reference to this object
MessagesAddChatUserQuery	userId(java.lang.Long value) ID of the user to be added to the chat.
MessagesAddChatUserQuery	visibleMessagesCount(java.lang.Integer value) Set visible messages count

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

MessagesAddChatUserQuery

public MessagesAddChatUserQuery(VkApiClient client,
                                UserActor actor,
                                java.lang.Integer chatId)

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

chatId - value of "chat id" parameter. Maximum is 100000000. Minimum is 0.

MessagesAddChatUserQuery

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

chatId

public MessagesAddChatUserQuery chatId(java.lang.Integer value)

Chat ID.

Parameters:

value - value of "chat id" parameter. Maximum is 100000000. Minimum is 0.

Returns:

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

userId

public MessagesAddChatUserQuery userId(java.lang.Long value)

ID of the user to be added to the chat.

Parameters:

value - value of "user id" parameter. Minimum is 0. Entity - owner

Returns:

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

visibleMessagesCount

public MessagesAddChatUserQuery visibleMessagesCount(java.lang.Integer value)

Set visible messages count

Parameters:

value - value of "visible messages count" parameter. Maximum is 1000. Minimum is 0.

Returns:

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

getThis

protected MessagesAddChatUserQuery getThis()

Description copied from class: AbstractQueryBuilder

Get reference to this object

Specified by:

getThis in class AbstractQueryBuilder<MessagesAddChatUserQuery,OkResponse>

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<MessagesAddChatUserQuery,OkResponse>

Returns:

list of names