com.vk.api.sdk.queries.apps

Class AppsSendRequestQuery

java.lang.Object

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

com.vk.api.sdk.client.AbstractQueryBuilder<AppsSendRequestQuery,java.lang.Integer>

com.vk.api.sdk.queries.apps.AppsSendRequestQuery

public class AppsSendRequestQuery
extends AbstractQueryBuilder<AppsSendRequestQuery,java.lang.Integer>

Query for Apps.sendRequest method

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected java.util.List<java.lang.String>	essentialKeys() Get list of required parameter names
protected AppsSendRequestQuery	getThis() Get reference to this object
AppsSendRequestQuery	key(java.lang.String value) Special string key to be sent with the request
AppsSendRequestQuery	name(java.lang.String value) Set name
AppsSendRequestQuery	separate(java.lang.Boolean value) Set separate
AppsSendRequestQuery	text(java.lang.String value) Request text
AppsSendRequestQuery	type(SendRequestType value) Request type.
AppsSendRequestQuery	userId(java.lang.Long value) Id of the user to send a request

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

AppsSendRequestQuery

public AppsSendRequestQuery(VkApiClient client,
                            UserActor actor,
                            java.lang.Long userId)

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

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

AppsSendRequestQuery

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

userId

public AppsSendRequestQuery userId(java.lang.Long value)

Id of the user to send a request

Parameters:

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

Returns:

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

text

public AppsSendRequestQuery text(java.lang.String value)

Request text

Parameters:

value - value of "text" parameter.

Returns:

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

type

public AppsSendRequestQuery type(SendRequestType value)

Request type. Values: 'invite' - if the request is sent to a user who does not have the app installed,, 'request' - if a user has already installed the app

Parameters:

value - value of "type" parameter. By default request.

Returns:

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

name

public AppsSendRequestQuery name(java.lang.String value)

Set name

Parameters:

value - value of "name" parameter.

Returns:

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

key

public AppsSendRequestQuery key(java.lang.String value)

Special string key to be sent with the request

Parameters:

value - value of "key" parameter.

Returns:

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

separate

public AppsSendRequestQuery separate(java.lang.Boolean value)

Set separate

Parameters:

value - value of "separate" parameter.

Returns:

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

getThis

protected AppsSendRequestQuery getThis()

Description copied from class: AbstractQueryBuilder

Get reference to this object

Specified by:

getThis in class AbstractQueryBuilder<AppsSendRequestQuery,java.lang.Integer>

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<AppsSendRequestQuery,java.lang.Integer>

Returns:

list of names