com.vk.api.sdk.queries.users

Class UsersGetFollowersQueryWithFields

java.lang.Object

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

com.vk.api.sdk.client.AbstractQueryBuilder<UsersGetFollowersQueryWithFields,GetFollowersFieldsResponse>

com.vk.api.sdk.queries.users.UsersGetFollowersQueryWithFields

public class UsersGetFollowersQueryWithFields
extends AbstractQueryBuilder<UsersGetFollowersQueryWithFields,GetFollowersFieldsResponse>

Query for Users.getFollowers method

Constructor Summary

Constructors

Constructor and Description
UsersGetFollowersQueryWithFields(VkApiClient client, ServiceActor actor, Fields... fields) Creates a AbstractQueryBuilder instance that can be used to build service api request with various parameters
UsersGetFollowersQueryWithFields(VkApiClient client, ServiceActor actor, java.util.List<Fields> fields) Creates a AbstractQueryBuilder instance that can be used to build service api request with various parameters
UsersGetFollowersQueryWithFields(VkApiClient client, UserActor actor, Fields... fields) Creates a AbstractQueryBuilder instance that can be used to build user api request with various parameters
UsersGetFollowersQueryWithFields(VkApiClient client, UserActor actor, java.util.List<Fields> fields) Creates a AbstractQueryBuilder instance that can be used to build user api request with various parameters

Method Summary

Modifier and Type	Method and Description
UsersGetFollowersQueryWithFields	count(java.lang.Integer value) Number of followers to return.
protected java.util.List<java.lang.String>	essentialKeys() Get list of required parameter names
protected UsersGetFollowersQueryWithFields	fields(Fields... value) fields Profile fields to return.
protected UsersGetFollowersQueryWithFields	fields(java.util.List<Fields> value) Profile fields to return.
protected UsersGetFollowersQueryWithFields	getThis() Get reference to this object
UsersGetFollowersQueryWithFields	nameCase(NameCase value) Case for declension of user name and surname: 'nom' - nominative (default), 'gen' - genitive , 'dat' - dative, 'acc' - accusative , 'ins' - instrumental , 'abl' - prepositional
UsersGetFollowersQueryWithFields	offset(java.lang.Integer value) Offset needed to return a specific subset of followers.
UsersGetFollowersQueryWithFields	userId(java.lang.Long value) User ID.

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

UsersGetFollowersQueryWithFields

public UsersGetFollowersQueryWithFields(VkApiClient client,
                                        UserActor actor,
                                        Fields... fields)

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

UsersGetFollowersQueryWithFields

public UsersGetFollowersQueryWithFields(VkApiClient client,
                                        UserActor actor,
                                        java.util.List<Fields> fields)

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

UsersGetFollowersQueryWithFields

public UsersGetFollowersQueryWithFields(VkApiClient client,
                                        ServiceActor actor,
                                        Fields... fields)

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

UsersGetFollowersQueryWithFields

public UsersGetFollowersQueryWithFields(VkApiClient client,
                                        ServiceActor actor,
                                        java.util.List<Fields> fields)

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

userId

public UsersGetFollowersQueryWithFields userId(java.lang.Long value)

User ID.

Parameters:

value - value of "user id" parameter. Minimum is 0. Entity - owner

Returns:

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

offset

public UsersGetFollowersQueryWithFields offset(java.lang.Integer value)

Offset needed to return a specific subset of followers.

Parameters:

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

Returns:

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

count

public UsersGetFollowersQueryWithFields count(java.lang.Integer value)

Number of followers to return.

Parameters:

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

Returns:

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

nameCase

public UsersGetFollowersQueryWithFields 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.

fields

protected UsersGetFollowersQueryWithFields 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', 'rate', 'contacts', 'education', 'online'.

Parameters:

value - value of "fields" parameter.

Returns:

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

fields

protected UsersGetFollowersQueryWithFields 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', 'rate', 'contacts', 'education', 'online'.

Parameters:

value - value of "fields" parameter.

Returns:

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

getThis

protected UsersGetFollowersQueryWithFields getThis()

Description copied from class: AbstractQueryBuilder

Get reference to this object

Specified by:

getThis in class AbstractQueryBuilder<UsersGetFollowersQueryWithFields,GetFollowersFieldsResponse>

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<UsersGetFollowersQueryWithFields,GetFollowersFieldsResponse>

Returns:

list of names