com.vk.api.sdk.queries.apps

Class AppsGetLeaderboardQueryWithExtended

java.lang.Object

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

com.vk.api.sdk.client.AbstractQueryBuilder<AppsGetLeaderboardQueryWithExtended,GetLeaderboardExtendedResponse>

com.vk.api.sdk.queries.apps.AppsGetLeaderboardQueryWithExtended

public class AppsGetLeaderboardQueryWithExtended
extends AbstractQueryBuilder<AppsGetLeaderboardQueryWithExtended,GetLeaderboardExtendedResponse>

Query for Apps.getLeaderboard method

Constructor Summary

Constructors

Constructor and Description
AppsGetLeaderboardQueryWithExtended(VkApiClient client, UserActor actor, GetLeaderboardType type) Creates a AbstractQueryBuilder instance that can be used to build user api request with various parameters

Method Summary

Modifier and Type	Method and Description
protected java.util.List<java.lang.String>	essentialKeys() Get list of required parameter names
protected AppsGetLeaderboardQueryWithExtended	extended(java.lang.Boolean value) 1 - to return additional info about users
protected AppsGetLeaderboardQueryWithExtended	getThis() Get reference to this object
AppsGetLeaderboardQueryWithExtended	global(java.lang.Boolean value) Rating type.
AppsGetLeaderboardQueryWithExtended	type(GetLeaderboardType value) Leaderboard type.

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

accessToken, build, captchaKey, captchaSid, clientSecret, confirm, getBody, getMethod, getParams, getQueryHeaders, lang, toString, unsafeParam, unsafeParam, unsafeParam, unsafeParam, unsafeParam, unsafeParam, unsafeParam, unsafeParam, unsafeParam, unsafeParam, unsafeParam, unsafeParam, version, withHeader, withHeaders

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

addHeader, addHeaders, execute, executeAsRaw, executeAsString, executeAsStringWithReturningFullInfo, executeTypeable, executeTypeableWithoutRetry, executeWithoutRetry, getClient, getCookie, getGson, getHeaders, getResponseClass, getUrl, setCookie, setCookies, setHeaders, setHeaders

Methods inherited from class java.lang.Object

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

Constructor Detail

AppsGetLeaderboardQueryWithExtended

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

Creates a AbstractQueryBuilder instance that can be used to build user api request with various parameters

Parameters:

client - VK API client

actor - actor with access token

type - value of "type" parameter.

Method Detail

type

public AppsGetLeaderboardQueryWithExtended 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 AppsGetLeaderboardQueryWithExtended 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 true.

Returns:

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

extended

protected AppsGetLeaderboardQueryWithExtended extended(java.lang.Boolean value)

1 - to return additional info about users

Parameters:

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

Returns:

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

getThis

protected AppsGetLeaderboardQueryWithExtended getThis()

Description copied from class: AbstractQueryBuilder

Get reference to this object

Specified by:

getThis in class AbstractQueryBuilder<AppsGetLeaderboardQueryWithExtended,GetLeaderboardExtendedResponse>

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<AppsGetLeaderboardQueryWithExtended,GetLeaderboardExtendedResponse>

Returns:

list of names