com.vk.api.sdk.queries.users

Class UsersGetQuery

java.lang.Object

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

com.vk.api.sdk.client.AbstractQueryBuilder<UsersGetQuery,java.util.List<GetResponse>>

com.vk.api.sdk.queries.users.UsersGetQuery

public class UsersGetQuery
extends AbstractQueryBuilder<UsersGetQuery,java.util.List<GetResponse>>

Query for Users.get method

Constructor Summary

Constructors

Constructor and Description
UsersGetQuery(VkApiClient client, GroupActor actor) Creates a AbstractQueryBuilder instance that can be used to build group api request with various parameters
UsersGetQuery(VkApiClient client, ServiceActor actor) Creates a AbstractQueryBuilder instance that can be used to build service api request with various parameters
UsersGetQuery(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
protected java.util.List<java.lang.String>	essentialKeys() Get list of required parameter names
UsersGetQuery	fields(Fields... value) fields Profile fields to return.
UsersGetQuery	fields(java.util.List<Fields> value) Profile fields to return.
protected UsersGetQuery	getThis() Get reference to this object
UsersGetQuery	nameCase(NameCase value) Case for declension of user name and surname: 'nom' - nominative (default), 'gen' - genitive , 'dat' - dative, 'acc' - accusative , 'ins' - instrumental , 'abl' - prepositional
UsersGetQuery	userIds(java.util.List<java.lang.String> value) User IDs or screen names ('screen_name').
UsersGetQuery	userIds(java.lang.String... value) userIds User IDs or screen names ('screen_name').

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

UsersGetQuery

public UsersGetQuery(VkApiClient client,
                     GroupActor actor)

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

Parameters:

client - VK API client

actor - actor with access token

UsersGetQuery

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

UsersGetQuery

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

nameCase

public UsersGetQuery nameCase(NameCase value)

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

Parameters:

value - value of "name case" parameter.

Returns:

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

userIds

public UsersGetQuery userIds(java.lang.String... value)

userIds User IDs or screen names ('screen_name'). By default, current user ID.

Parameters:

value - value of "user ids" parameter.

Returns:

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

userIds

public UsersGetQuery userIds(java.util.List<java.lang.String> value)

User IDs or screen names ('screen_name'). By default, current user ID.

Parameters:

value - value of "user ids" parameter.

Returns:

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

fields

public UsersGetQuery 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', 'can_invite_to_chats'

Parameters:

value - value of "fields" parameter.

Returns:

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

fields

public UsersGetQuery 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', 'can_invite_to_chats'

Parameters:

value - value of "fields" parameter.

Returns:

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

getThis

protected UsersGetQuery getThis()

Description copied from class: AbstractQueryBuilder

Get reference to this object

Specified by:

getThis in class AbstractQueryBuilder<UsersGetQuery,java.util.List<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<UsersGetQuery,java.util.List<GetResponse>>

Returns:

list of names