Package com.vk.api.sdk.queries.apps

Class AppsGetLeaderboardQuery

java.lang.Object

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

com.vk.api.sdk.client.AbstractQueryBuilder<AppsGetLeaderboardQuery,GetLeaderboardResponse>

com.vk.api.sdk.queries.apps.AppsGetLeaderboardQuery

public class AppsGetLeaderboardQuery
extends AbstractQueryBuilder<AppsGetLeaderboardQuery,GetLeaderboardResponse>

Query for Apps.getLeaderboard method

Constructor Summary

Constructors

Constructor	Description
AppsGetLeaderboardQuery(VkApiClient client, UserActor actor, GetLeaderboardType type)	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
AppsGetLeaderboardQuery	extended(java.lang.Boolean value)	1 — to return additional info about users
protected AppsGetLeaderboardQuery	getThis()	Get reference to this object
AppsGetLeaderboardQuery	global(java.lang.Boolean value)	Rating type.
protected AppsGetLeaderboardQuery	type(GetLeaderboardType value)	Leaderboard 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

AppsGetLeaderboardQuery

public AppsGetLeaderboardQuery(VkApiClient client,
                               UserActor actor,
                               GetLeaderboardType type)

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

type - value of "type" parameter.

Method Detail

type

protected AppsGetLeaderboardQuery type(GetLeaderboardType value)

Leaderboard type. Possible values: *'level' — by level,, *'points' — by mission points,, *'score' — by score ().

Parameters:

value - value of "type" parameter.

Returns:

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

global

public AppsGetLeaderboardQuery global(java.lang.Boolean value)

Rating type. Possible values: *'1' — global rating among all players,, *'0' — rating among user friends.

Parameters:

value - value of "global" parameter. By default 1.

Returns:

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

extended

public AppsGetLeaderboardQuery extended(java.lang.Boolean value)

1 — to return additional info about users

Parameters:

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

Returns:

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

getThis

protected AppsGetLeaderboardQuery getThis()

Description copied from class: AbstractQueryBuilder

Get reference to this object

Specified by:

getThis in class AbstractQueryBuilder<AppsGetLeaderboardQuery,GetLeaderboardResponse>

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<AppsGetLeaderboardQuery,GetLeaderboardResponse>

Returns:

list of names