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

Class LeadsGetUsersQuery

java.lang.Object

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

com.vk.api.sdk.client.AbstractQueryBuilder<LeadsGetUsersQuery,java.util.List<Entry>>

com.vk.api.sdk.queries.leads.LeadsGetUsersQuery

public class LeadsGetUsersQuery
extends AbstractQueryBuilder<LeadsGetUsersQuery,java.util.List<Entry>>

Query for Leads.getUsers method

Constructor Summary

Constructors

Constructor	Description
LeadsGetUsersQuery(VkApiClient client, ServiceActor actor, int offerId, java.lang.String secret)	Creates a AbstractQueryBuilder instance that can be used to build api request with various parameters
LeadsGetUsersQuery(VkApiClient client, UserActor actor, int offerId, 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
LeadsGetUsersQuery	count(java.lang.Integer value)	Number of results to return.
protected java.util.List<java.lang.String>	essentialKeys()	Get list of required parameter names
protected LeadsGetUsersQuery	getThis()	Get reference to this object
protected LeadsGetUsersQuery	offerId(int value)	Offer ID.
LeadsGetUsersQuery	offset(java.lang.Integer value)	Offset needed to return a specific subset of results.
LeadsGetUsersQuery	reverse(java.lang.Boolean value)	Sort order.
protected LeadsGetUsersQuery	secret(java.lang.String value)	Secret key obtained in the lead testing interface.
LeadsGetUsersQuery	status(LeadsStatus value)	Action type.

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

LeadsGetUsersQuery

public LeadsGetUsersQuery(VkApiClient client,
                          UserActor actor,
                          int offerId,
                          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

offerId - value of "offer id" parameter. Minimum is 0.

secret - value of "secret" parameter.

LeadsGetUsersQuery

public LeadsGetUsersQuery(VkApiClient client,
                          ServiceActor actor,
                          int offerId,
                          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

offerId - value of "offer id" parameter. Minimum is 0.

secret - value of "secret" parameter.

Method Detail

offerId

protected LeadsGetUsersQuery offerId(int value)

Offer ID.

Parameters:

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

Returns:

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

secret

protected LeadsGetUsersQuery secret(java.lang.String value)

Secret key obtained in the lead testing interface.

Parameters:

value - value of "secret" parameter.

Returns:

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

offset

public LeadsGetUsersQuery offset(java.lang.Integer value)

Offset needed to return a specific subset of results.

Parameters:

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

Returns:

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

count

public LeadsGetUsersQuery count(java.lang.Integer value)

Number of results to return.

Parameters:

value - value of "count" parameter. Maximum is 1000. Minimum is 0. By default 100.

Returns:

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

status

public LeadsGetUsersQuery status(LeadsStatus value)

Action type. Possible values: *'0' — start,, *'1' — finish,, *'2' — blocking users,, *'3' — start in a test mode,, *'4' — finish in a test mode.

Parameters:

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

Returns:

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

reverse

public LeadsGetUsersQuery reverse(java.lang.Boolean value)

Sort order. Possible values: *'1' — chronological,, *'0' — reverse chronological.

Parameters:

value - value of "reverse" parameter.

Returns:

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

getThis

protected LeadsGetUsersQuery getThis()

Description copied from class: AbstractQueryBuilder

Get reference to this object

Specified by:

getThis in class AbstractQueryBuilder<LeadsGetUsersQuery,java.util.List<Entry>>

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<LeadsGetUsersQuery,java.util.List<Entry>>

Returns:

list of names