com.vk.api.sdk.queries.apps

Class AppsGetCatalogQuery

java.lang.Object

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

com.vk.api.sdk.client.AbstractQueryBuilder<AppsGetCatalogQuery,GetCatalogResponse>

com.vk.api.sdk.queries.apps.AppsGetCatalogQuery

public class AppsGetCatalogQuery
extends AbstractQueryBuilder<AppsGetCatalogQuery,GetCatalogResponse>

Query for Apps.getCatalog method

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
AppsGetCatalogQuery	count(java.lang.Integer value) Number of apps to return.
protected java.util.List<java.lang.String>	essentialKeys() Get list of required parameter names
AppsGetCatalogQuery	extended(java.lang.Boolean value) '1' - to return additional fields 'screenshots', 'MAU', 'catalog_position', and 'international'.
AppsGetCatalogQuery	fields(Fields... value) fields Set fields
AppsGetCatalogQuery	fields(java.util.List<Fields> value) Set fields
AppsGetCatalogQuery	filter(GetCatalogFilter value) 'installed' - to return list of installed apps (only for mobile platform).
AppsGetCatalogQuery	genreId(java.lang.Integer value) Set genre id
protected AppsGetCatalogQuery	getThis() Get reference to this object
AppsGetCatalogQuery	nameCase(java.lang.String value) Set name case
AppsGetCatalogQuery	offset(java.lang.Integer value) Offset required to return a specific subset of apps.
AppsGetCatalogQuery	platform(java.lang.String value) Set platform
AppsGetCatalogQuery	q(java.lang.String value) Search query string.
AppsGetCatalogQuery	returnFriends(java.lang.Boolean value) Set return friends
AppsGetCatalogQuery	sort(GetCatalogSort value) Sort order: 'popular_today' - popular for one day (default), 'visitors' - by visitors number , 'create_date' - by creation date, 'growth_rate' - by growth rate, 'popular_week' - popular for one week

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

AppsGetCatalogQuery

public AppsGetCatalogQuery(VkApiClient client,
                           UserActor actor)

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

AppsGetCatalogQuery

public AppsGetCatalogQuery(VkApiClient client,
                           ServiceActor actor)

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

Parameters:

client - VK API client

actor - actor with access token

Method Detail

sort

public AppsGetCatalogQuery sort(GetCatalogSort value)

Sort order: 'popular_today' - popular for one day (default), 'visitors' - by visitors number , 'create_date' - by creation date, 'growth_rate' - by growth rate, 'popular_week' - popular for one week

Parameters:

value - value of "sort" parameter.

Returns:

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

offset

public AppsGetCatalogQuery offset(java.lang.Integer value)

Offset required to return a specific subset of apps.

Parameters:

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

Returns:

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

count

public AppsGetCatalogQuery count(java.lang.Integer value)

Number of apps to return.

Parameters:

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

Returns:

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

platform

public AppsGetCatalogQuery platform(java.lang.String value)

Set platform

Parameters:

value - value of "platform" parameter.

Returns:

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

extended

public AppsGetCatalogQuery extended(java.lang.Boolean value)

'1' - to return additional fields 'screenshots', 'MAU', 'catalog_position', and 'international'. If set, 'count' must be less than or equal to '100'. '0' - not to return additional fields (default).

Parameters:

value - value of "extended" parameter.

Returns:

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

returnFriends

public AppsGetCatalogQuery returnFriends(java.lang.Boolean value)

Set return friends

Parameters:

value - value of "return friends" parameter.

Returns:

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

nameCase

public AppsGetCatalogQuery nameCase(java.lang.String value)

Set name case

Parameters:

value - value of "name case" parameter.

Returns:

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

q

public AppsGetCatalogQuery q(java.lang.String value)

Search query string.

Parameters:

value - value of "q" parameter.

Returns:

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

genreId

public AppsGetCatalogQuery genreId(java.lang.Integer value)

Set genre id

Parameters:

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

Returns:

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

filter

public AppsGetCatalogQuery filter(GetCatalogFilter value)

'installed' - to return list of installed apps (only for mobile platform).

Parameters:

value - value of "filter" parameter.

Returns:

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

fields

public AppsGetCatalogQuery fields(Fields... value)

fields Set fields

Parameters:

value - value of "fields" parameter.

Returns:

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

fields

public AppsGetCatalogQuery fields(java.util.List<Fields> value)

Set fields

Parameters:

value - value of "fields" parameter.

Returns:

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

getThis

protected AppsGetCatalogQuery getThis()

Description copied from class: AbstractQueryBuilder

Get reference to this object

Specified by:

getThis in class AbstractQueryBuilder<AppsGetCatalogQuery,GetCatalogResponse>

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<AppsGetCatalogQuery,GetCatalogResponse>

Returns:

list of names