Package com.vk.api.sdk.queries.leads

Class LeadsCheckUserQuery

java.lang.Object

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

com.vk.api.sdk.client.AbstractQueryBuilder<LeadsCheckUserQuery,Checked>

com.vk.api.sdk.queries.leads.LeadsCheckUserQuery

public class LeadsCheckUserQuery
extends AbstractQueryBuilder<LeadsCheckUserQuery,Checked>

Query for Leads.checkUser method

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
LeadsCheckUserQuery	age(java.lang.Integer value)	User age.
LeadsCheckUserQuery	autoStart(java.lang.Boolean value)	Set auto start
LeadsCheckUserQuery	country(java.lang.String value)	User country code.
protected java.util.List<java.lang.String>	essentialKeys()	Get list of required parameter names
protected LeadsCheckUserQuery	getThis()	Get reference to this object
protected LeadsCheckUserQuery	leadId(int value)	Lead ID.
LeadsCheckUserQuery	testMode(java.lang.Boolean value)	Set test mode
LeadsCheckUserQuery	testResult(java.lang.Integer value)	Value to be return in 'result' field when test mode is used.

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

LeadsCheckUserQuery

public LeadsCheckUserQuery(VkApiClient client,
                           UserActor actor,
                           int leadId)

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

leadId - value of "lead id" parameter. Minimum is 0.

Method Detail

leadId

protected LeadsCheckUserQuery leadId(int value)

Lead ID.

Parameters:

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

Returns:

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

testResult

public LeadsCheckUserQuery testResult(java.lang.Integer value)

Value to be return in 'result' field when test mode is used.

Parameters:

value - value of "test result" parameter. Minimum is 0.

Returns:

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

testMode

public LeadsCheckUserQuery testMode(java.lang.Boolean value)

Set test mode

Parameters:

value - value of "test mode" parameter. By default 0.

Returns:

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

autoStart

public LeadsCheckUserQuery autoStart(java.lang.Boolean value)

Set auto start

Parameters:

value - value of "auto start" parameter. By default 0.

Returns:

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

age

public LeadsCheckUserQuery age(java.lang.Integer value)

User age.

Parameters:

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

Returns:

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

country

public LeadsCheckUserQuery country(java.lang.String value)

User country code.

Parameters:

value - value of "country" parameter.

Returns:

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

getThis

protected LeadsCheckUserQuery getThis()

Description copied from class: AbstractQueryBuilder

Get reference to this object

Specified by:

getThis in class AbstractQueryBuilder<LeadsCheckUserQuery,Checked>

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<LeadsCheckUserQuery,Checked>

Returns:

list of names