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

Class LeadFormsCreateQuery

java.lang.Object

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

com.vk.api.sdk.client.AbstractQueryBuilder<LeadFormsCreateQuery,CreateResponse>

com.vk.api.sdk.queries.leadforms.LeadFormsCreateQuery

public class LeadFormsCreateQuery
extends AbstractQueryBuilder<LeadFormsCreateQuery,CreateResponse>

Query for LeadForms.create method

Constructor Summary

Constructors

Constructor	Description
LeadFormsCreateQuery(VkApiClient client, UserActor actor, int groupId, java.lang.String name, java.lang.String title, java.lang.String description, java.lang.String questions, java.lang.String policyLinkUrl)	Creates a AbstractQueryBuilder instance that can be used to build api request with various parameters

Method Summary

Modifier and Type	Method	Description
LeadFormsCreateQuery	active(java.lang.Boolean value)	Set active
LeadFormsCreateQuery	confirmation(java.lang.String value)	Set confirmation
protected LeadFormsCreateQuery	description(java.lang.String value)	Set description
protected java.util.List<java.lang.String>	essentialKeys()	Get list of required parameter names
protected LeadFormsCreateQuery	getThis()	Get reference to this object
protected LeadFormsCreateQuery	groupId(int value)	Set group id
protected LeadFormsCreateQuery	name(java.lang.String value)	Set name
LeadFormsCreateQuery	notifyAdmins(java.lang.Integer... value)	notify_admins Set notify admins
LeadFormsCreateQuery	notifyAdmins(java.util.List<java.lang.Integer> value)	Set notify admins
LeadFormsCreateQuery	notifyEmails(java.lang.String... value)	notify_emails Set notify emails
LeadFormsCreateQuery	notifyEmails(java.util.List<java.lang.String> value)	Set notify emails
LeadFormsCreateQuery	oncePerUser(java.lang.Boolean value)	Set once per user
LeadFormsCreateQuery	photo(java.lang.String value)	Set photo
LeadFormsCreateQuery	pixelCode(java.lang.String value)	Set pixel code
protected LeadFormsCreateQuery	policyLinkUrl(java.lang.String value)	Set policy link url
protected LeadFormsCreateQuery	questions(java.lang.String value)	Set questions
LeadFormsCreateQuery	siteLinkUrl(java.lang.String value)	Set site link url
protected LeadFormsCreateQuery	title(java.lang.String value)	Set title

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

LeadFormsCreateQuery

public LeadFormsCreateQuery(VkApiClient client,
                            UserActor actor,
                            int groupId,
                            java.lang.String name,
                            java.lang.String title,
                            java.lang.String description,
                            java.lang.String questions,
                            java.lang.String policyLinkUrl)

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.

name - value of "name" parameter.

title - value of "title" parameter.

description - value of "description" parameter.

questions - value of "questions" parameter.

policyLinkUrl - value of "policy link url" parameter.

Method Detail

groupId

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

name

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

title

protected LeadFormsCreateQuery title(java.lang.String value)

Set title

Parameters:

value - value of "title" parameter.

Returns:

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

description

protected LeadFormsCreateQuery description(java.lang.String value)

Set description

Parameters:

value - value of "description" parameter.

Returns:

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

questions

protected LeadFormsCreateQuery questions(java.lang.String value)

Set questions

Parameters:

value - value of "questions" parameter.

Returns:

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

policyLinkUrl

protected LeadFormsCreateQuery policyLinkUrl(java.lang.String value)

Set policy link url

Parameters:

value - value of "policy link url" parameter.

Returns:

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

photo

public LeadFormsCreateQuery photo(java.lang.String value)

Set photo

Parameters:

value - value of "photo" parameter.

Returns:

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

confirmation

public LeadFormsCreateQuery confirmation(java.lang.String value)

Set confirmation

Parameters:

value - value of "confirmation" parameter.

Returns:

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

siteLinkUrl

public LeadFormsCreateQuery siteLinkUrl(java.lang.String value)

Set site link url

Parameters:

value - value of "site link url" parameter.

Returns:

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

active

public LeadFormsCreateQuery active(java.lang.Boolean value)

Set active

Parameters:

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

Returns:

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

oncePerUser

public LeadFormsCreateQuery oncePerUser(java.lang.Boolean value)

Set once per user

Parameters:

value - value of "once per user" parameter. By default 0.

Returns:

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

pixelCode

public LeadFormsCreateQuery pixelCode(java.lang.String value)

Set pixel code

Parameters:

value - value of "pixel code" parameter.

Returns:

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

notifyAdmins

public LeadFormsCreateQuery notifyAdmins(java.lang.Integer... value)

notify_admins Set notify admins

Parameters:

value - value of "notify admins" parameter.

Returns:

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

notifyAdmins

public LeadFormsCreateQuery notifyAdmins(java.util.List<java.lang.Integer> value)

Set notify admins

Parameters:

value - value of "notify admins" parameter.

Returns:

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

notifyEmails

public LeadFormsCreateQuery notifyEmails(java.lang.String... value)

notify_emails Set notify emails

Parameters:

value - value of "notify emails" parameter.

Returns:

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

notifyEmails

public LeadFormsCreateQuery notifyEmails(java.util.List<java.lang.String> value)

Set notify emails

Parameters:

value - value of "notify emails" parameter.

Returns:

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

getThis

protected LeadFormsCreateQuery getThis()

Description copied from class: AbstractQueryBuilder

Get reference to this object

Specified by:

getThis in class AbstractQueryBuilder<LeadFormsCreateQuery,CreateResponse>

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<LeadFormsCreateQuery,CreateResponse>

Returns:

list of names