Package com.vk.api.sdk.actions

Class Leads

java.lang.Object

com.vk.api.sdk.client.AbstractAction

com.vk.api.sdk.actions.Leads

public class Leads
extends AbstractAction

List of Leads methods

Constructor Summary

Constructors

Constructor	Description
Leads(VkApiClient client)	Constructor

Method Summary

Modifier and Type	Method	Description
LeadsCheckUserQuery	checkUser(UserActor actor, int leadId)	Checks if the user can start the lead.
LeadsCompleteQuery	complete(ServiceActor actor, java.lang.String vkSid, java.lang.String secret)	Completes the lead started by user.
LeadsCompleteQuery	complete(UserActor actor, java.lang.String vkSid, java.lang.String secret)	Completes the lead started by user.
LeadsGetStatsQuery	getStats(UserActor actor, int leadId)	Returns lead stats data.
LeadsGetUsersQuery	getUsers(ServiceActor actor, int offerId, java.lang.String secret)	Returns a list of last user actions for the offer.
LeadsGetUsersQuery	getUsers(UserActor actor, int offerId, java.lang.String secret)	Returns a list of last user actions for the offer.
LeadsMetricHitQuery	metricHit(UserActor actor, java.lang.String data)	Counts the metric event.
LeadsStartQuery	start(ServiceActor actor, int leadId, java.lang.String secret)	Creates new session for the user passing the offer.
LeadsStartQuery	start(UserActor actor, int leadId, java.lang.String secret)	Creates new session for the user passing the offer.

Methods inherited from class com.vk.api.sdk.client.AbstractAction

getClient

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Leads

public Leads(VkApiClient client)

Constructor

Parameters:

client - vk api client

Method Detail

checkUser

public LeadsCheckUserQuery checkUser(UserActor actor,
                                     int leadId)

Checks if the user can start the lead.

Parameters:

actor - vk actor

leadId - Lead ID.

Returns:

query

complete

public LeadsCompleteQuery complete(UserActor actor,
                                   java.lang.String vkSid,
                                   java.lang.String secret)

Completes the lead started by user.

Parameters:

actor - vk actor

vkSid - Session obtained as GET parameter when session started.

secret - Secret key from the lead testing interface.

Returns:

query

complete

public LeadsCompleteQuery complete(ServiceActor actor,
                                   java.lang.String vkSid,
                                   java.lang.String secret)

Completes the lead started by user.

Parameters:

actor - vk actor

vkSid - Session obtained as GET parameter when session started.

secret - Secret key from the lead testing interface.

Returns:

query

getStats

public LeadsGetStatsQuery getStats(UserActor actor,
                                   int leadId)

Returns lead stats data.

Parameters:

actor - vk actor

leadId - Lead ID.

Returns:

query

getUsers

public LeadsGetUsersQuery getUsers(UserActor actor,
                                   int offerId,
                                   java.lang.String secret)

Returns a list of last user actions for the offer.

Parameters:

actor - vk actor

offerId - Offer ID.

secret - Secret key obtained in the lead testing interface.

Returns:

query

getUsers

public LeadsGetUsersQuery getUsers(ServiceActor actor,
                                   int offerId,
                                   java.lang.String secret)

Returns a list of last user actions for the offer.

Parameters:

actor - vk actor

offerId - Offer ID.

secret - Secret key obtained in the lead testing interface.

Returns:

query

metricHit

public LeadsMetricHitQuery metricHit(UserActor actor,
                                     java.lang.String data)

Counts the metric event.

Parameters:

actor - vk actor

data - Metric data obtained in the lead interface.

Returns:

query

start

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

Creates new session for the user passing the offer.

Parameters:

actor - vk actor

leadId - Lead ID.

secret - Secret key from the lead testing interface.

Returns:

query

start

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

Creates new session for the user passing the offer.

Parameters:

actor - vk actor

leadId - Lead ID.

secret - Secret key from the lead testing interface.

Returns:

query