com.vk.api.sdk.queries.apps

Class AppsGetQuery

java.lang.Object

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

com.vk.api.sdk.client.AbstractQueryBuilder<AppsGetQuery,GetResponse>

com.vk.api.sdk.queries.apps.AppsGetQuery

public class AppsGetQuery
extends AbstractQueryBuilder<AppsGetQuery,GetResponse>

Query for Apps.get method

Constructor Summary

Constructors

Constructor and Description
AppsGetQuery(VkApiClient client, ServiceActor actor) Creates a AbstractQueryBuilder instance that can be used to build service api request with various parameters
AppsGetQuery(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
AppsGetQuery	appFields(AppFields... value) appFields List of app fields to return.
AppsGetQuery	appFields(java.util.List<AppFields> value) List of app fields to return.
AppsGetQuery	appId(java.lang.Integer value) Application ID
AppsGetQuery	appIds(java.lang.Integer... value) appIds List of application ID
AppsGetQuery	appIds(java.util.List<java.lang.Integer> value) List of application ID
protected java.util.List<java.lang.String>	essentialKeys() Get list of required parameter names
AppsGetQuery	extended(java.lang.Boolean value) Set extended
AppsGetQuery	fields(Fields... value) fields Profile fields to return.
AppsGetQuery	fields(java.util.List<Fields> value) Profile fields to return.
protected AppsGetQuery	getThis() Get reference to this object
AppsGetQuery	nameCase(NameCase value) Case for declension of user name and surname: 'nom' - nominative (default),, 'gen' - genitive,, 'dat' - dative,, 'acc' - accusative,, 'ins' - instrumental,, 'abl' - prepositional.
AppsGetQuery	platform(GetPlatform value) Platform.
AppsGetQuery	returnFriends(java.lang.Boolean value) Set return friends

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

AppsGetQuery

public AppsGetQuery(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

AppsGetQuery

public AppsGetQuery(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

appId

public AppsGetQuery appId(java.lang.Integer value)

Application ID

Parameters:

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

Returns:

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

platform

public AppsGetQuery platform(GetPlatform value)

Platform. Possible values: *'ios' - iOS,, *'android' - Android,, *'winphone' - Windows Phone,, *'web' - приложения на vk.com. By default: 'web'.

Parameters:

value - value of "platform" parameter. By default web.

Returns:

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

extended

public AppsGetQuery extended(java.lang.Boolean value)

Set extended

Parameters:

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

Returns:

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

returnFriends

public AppsGetQuery returnFriends(java.lang.Boolean value)

Set return friends

Parameters:

value - value of "return friends" parameter. By default 0.

Returns:

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

nameCase

public AppsGetQuery nameCase(NameCase value)

Case for declension of user name and surname: 'nom' - nominative (default),, 'gen' - genitive,, 'dat' - dative,, 'acc' - accusative,, 'ins' - instrumental,, 'abl' - prepositional. (only if 'return_friends' = '1')

Parameters:

value - value of "name case" parameter.

Returns:

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

appIds

public AppsGetQuery appIds(java.lang.Integer... value)

appIds List of application ID

Parameters:

value - value of "app ids" parameter.

Returns:

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

appIds

public AppsGetQuery appIds(java.util.List<java.lang.Integer> value)

List of application ID

Parameters:

value - value of "app ids" parameter.

Returns:

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

fields

public AppsGetQuery fields(Fields... value)

fields Profile fields to return. Sample values: 'nickname', 'screen_name', 'sex', 'bdate' (birthdate), 'city', 'country', 'timezone', 'photo', 'photo_medium', 'photo_big', 'has_mobile', 'contacts', 'education', 'online', 'counters', 'relation', 'last_seen', 'activity', 'can_write_private_message', 'can_see_all_posts', 'can_post', 'universities', (only if return_friends - 1)

Parameters:

value - value of "fields" parameter.

Returns:

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

fields

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

Profile fields to return. Sample values: 'nickname', 'screen_name', 'sex', 'bdate' (birthdate), 'city', 'country', 'timezone', 'photo', 'photo_medium', 'photo_big', 'has_mobile', 'contacts', 'education', 'online', 'counters', 'relation', 'last_seen', 'activity', 'can_write_private_message', 'can_see_all_posts', 'can_post', 'universities', (only if return_friends - 1)

Parameters:

value - value of "fields" parameter.

Returns:

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

appFields

public AppsGetQuery appFields(AppFields... value)

appFields List of app fields to return. Fields 'id', 'type' and 'title' will always be in response. Leave this field empty to get all fields

Parameters:

value - value of "app fields" parameter.

Returns:

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

appFields

public AppsGetQuery appFields(java.util.List<AppFields> value)

List of app fields to return. Fields 'id', 'type' and 'title' will always be in response. Leave this field empty to get all fields

Parameters:

value - value of "app fields" parameter.

Returns:

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

getThis

protected AppsGetQuery getThis()

Description copied from class: AbstractQueryBuilder

Get reference to this object

Specified by:

getThis in class AbstractQueryBuilder<AppsGetQuery,GetResponse>

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<AppsGetQuery,GetResponse>

Returns:

list of names