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

Class LeadsStartQuery

java.lang.Object

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

com.vk.api.sdk.client.AbstractQueryBuilder<LeadsStartQuery,Start>

com.vk.api.sdk.queries.leads.LeadsStartQuery

public class LeadsStartQuery
extends AbstractQueryBuilder<LeadsStartQuery,Start>

Query for Leads.start method

Constructor Summary

Constructors

Constructor	Description
LeadsStartQuery(VkApiClient client, ServiceActor actor, int leadId, java.lang.String secret)	Creates a AbstractQueryBuilder instance that can be used to build api request with various parameters
LeadsStartQuery(VkApiClient client, UserActor actor, int leadId, java.lang.String secret)	Creates a AbstractQueryBuilder instance that can be used to build api request with various parameters

Method Summary

Modifier and Type	Method	Description
LeadsStartQuery	aid(java.lang.Integer value)	Set aid
protected java.util.List<java.lang.String>	essentialKeys()	Get list of required parameter names
LeadsStartQuery	force(java.lang.Boolean value)	Set force
protected LeadsStartQuery	getThis()	Get reference to this object
protected LeadsStartQuery	leadId(int value)	Lead ID.
protected LeadsStartQuery	secret(java.lang.String value)	Secret key from the lead testing interface.
LeadsStartQuery	testMode(java.lang.Boolean value)	Set test mode
LeadsStartQuery	uid(java.lang.Integer value)	Set uid

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

LeadsStartQuery

public LeadsStartQuery(VkApiClient client,
                       UserActor actor,
                       int leadId,
                       java.lang.String secret)

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.

secret - value of "secret" parameter.

LeadsStartQuery

public LeadsStartQuery(VkApiClient client,
                       ServiceActor actor,
                       int leadId,
                       java.lang.String secret)

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.

secret - value of "secret" parameter.

Method Detail

leadId

protected LeadsStartQuery 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.

secret

protected LeadsStartQuery secret(java.lang.String value)

Secret key from the lead testing interface.

Parameters:

value - value of "secret" parameter.

Returns:

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

uid

public LeadsStartQuery uid(java.lang.Integer value)

Set uid

Parameters:

value - value of "uid" parameter. Minimum is 0. By default 0.

Returns:

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

aid

public LeadsStartQuery aid(java.lang.Integer value)

Set aid

Parameters:

value - value of "aid" parameter. Minimum is 0. By default 0.

Returns:

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

testMode

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

force

public LeadsStartQuery force(java.lang.Boolean value)

Set force

Parameters:

value - value of "force" parameter. By default 0.

Returns:

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

getThis

protected LeadsStartQuery getThis()

Description copied from class: AbstractQueryBuilder

Get reference to this object

Specified by:

getThis in class AbstractQueryBuilder<LeadsStartQuery,Start>

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<LeadsStartQuery,Start>

Returns:

list of names