Package com.vk.api.sdk.queries.leadforms

Class LeadFormsGetLeadsQuery

java.lang.Object

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

com.vk.api.sdk.client.AbstractQueryBuilder<LeadFormsGetLeadsQuery,GetLeadsResponse>

com.vk.api.sdk.queries.leadforms.LeadFormsGetLeadsQuery

public class LeadFormsGetLeadsQuery
extends AbstractQueryBuilder<LeadFormsGetLeadsQuery,GetLeadsResponse>

Query for LeadForms.getLeads method

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
protected java.util.List<java.lang.String>	essentialKeys()	Get list of required parameter names
protected LeadFormsGetLeadsQuery	formId(int value)	Set form id
protected LeadFormsGetLeadsQuery	getThis()	Get reference to this object
protected LeadFormsGetLeadsQuery	groupId(int value)	Set group id
LeadFormsGetLeadsQuery	limit(java.lang.Integer value)	Set limit
LeadFormsGetLeadsQuery	nextPageToken(java.lang.String value)	Set next page token

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

LeadFormsGetLeadsQuery

public LeadFormsGetLeadsQuery(VkApiClient client,
                              UserActor actor,
                              int groupId,
                              int formId)

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

groupId - value of "group id" parameter.

formId - value of "form id" parameter.

Method Detail

groupId

protected LeadFormsGetLeadsQuery groupId(int value)

Set group id

Parameters:

value - value of "group id" parameter.

Returns:

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

formId

protected LeadFormsGetLeadsQuery formId(int value)

Set form id

Parameters:

value - value of "form id" parameter.

Returns:

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

limit

public LeadFormsGetLeadsQuery limit(java.lang.Integer value)

Set limit

Parameters:

value - value of "limit" parameter. Maximum is 1000. Minimum is 1. By default 10.

Returns:

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

nextPageToken

public LeadFormsGetLeadsQuery nextPageToken(java.lang.String value)

Set next page token

Parameters:

value - value of "next page token" parameter.

Returns:

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

getThis

protected LeadFormsGetLeadsQuery getThis()

Description copied from class: AbstractQueryBuilder

Get reference to this object

Specified by:

getThis in class AbstractQueryBuilder<LeadFormsGetLeadsQuery,GetLeadsResponse>

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<LeadFormsGetLeadsQuery,GetLeadsResponse>

Returns:

list of names