Package com.vk.api.sdk.queries.groups

Class GroupsGetInvitedUsersQuery

java.lang.Object

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

com.vk.api.sdk.client.AbstractQueryBuilder<GroupsGetInvitedUsersQuery,GetInvitedUsersResponse>

com.vk.api.sdk.queries.groups.GroupsGetInvitedUsersQuery

public class GroupsGetInvitedUsersQuery
extends AbstractQueryBuilder<GroupsGetInvitedUsersQuery,GetInvitedUsersResponse>

Query for Groups.getInvitedUsers method

Constructor Summary

Constructors

Constructor	Description
GroupsGetInvitedUsersQuery(VkApiClient client, UserActor actor, int groupId)	Creates a AbstractQueryBuilder instance that can be used to build api request with various parameters

Method Summary

Modifier and Type	Method	Description
GroupsGetInvitedUsersQuery	count(java.lang.Integer value)	Number of results to return.
protected java.util.List<java.lang.String>	essentialKeys()	Get list of required parameter names
GroupsGetInvitedUsersQuery	fields(Fields... value)	fields List of additional fields to be returned.
GroupsGetInvitedUsersQuery	fields(java.util.List<Fields> value)	List of additional fields to be returned.
protected GroupsGetInvitedUsersQuery	getThis()	Get reference to this object
protected GroupsGetInvitedUsersQuery	groupId(int value)	Group ID to return invited users for.
GroupsGetInvitedUsersQuery	nameCase(GetInvitedUsersNameCase value)	Case for declension of user name and surname.
GroupsGetInvitedUsersQuery	offset(java.lang.Integer value)	Offset needed to return a specific subset of results.

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

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

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

execute, executeAsRaw, executeAsString, getClient, getGson, getHeaders, getResponseClass, getUrl, setHeaders

Methods inherited from class java.lang.Object

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

Constructor Detail

GroupsGetInvitedUsersQuery

public GroupsGetInvitedUsersQuery(VkApiClient client,
                                  UserActor actor,
                                  int groupId)

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

Parameters:

client - VK API client

actor - actor with access token

groupId - value of "group id" parameter. Minimum is 1.

Method Detail

groupId

protected GroupsGetInvitedUsersQuery groupId(int value)

Group ID to return invited users for.

Parameters:

value - value of "group id" parameter. Minimum is 1.

Returns:

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

offset

public GroupsGetInvitedUsersQuery offset(java.lang.Integer value)

Offset needed to return a specific subset of results.

Parameters:

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

Returns:

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

count

public GroupsGetInvitedUsersQuery count(java.lang.Integer value)

Number of results to return.

Parameters:

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

Returns:

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

nameCase

public GroupsGetInvitedUsersQuery nameCase(GetInvitedUsersNameCase value)

Case for declension of user name and surname. Possible values: *'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

public GroupsGetInvitedUsersQuery fields(Fields... value)

fields List of additional fields to be returned. Available values: 'sex, bdate, city, country, photo_50, photo_100, photo_200_orig, photo_200, photo_400_orig, photo_max, photo_max_orig, online, online_mobile, lists, domain, has_mobile, contacts, connections, site, education, universities, schools, can_post, can_see_all_posts, can_see_audio, can_write_private_message, status, last_seen, common_count, relation, relatives, counters'.

Parameters:

value - value of "fields" parameter.

Returns:

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

fields

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

List of additional fields to be returned. Available values: 'sex, bdate, city, country, photo_50, photo_100, photo_200_orig, photo_200, photo_400_orig, photo_max, photo_max_orig, online, online_mobile, lists, domain, has_mobile, contacts, connections, site, education, universities, schools, can_post, can_see_all_posts, can_see_audio, can_write_private_message, status, last_seen, common_count, relation, relatives, counters'.

Parameters:

value - value of "fields" parameter.

Returns:

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

getThis

protected GroupsGetInvitedUsersQuery getThis()

Description copied from class: AbstractQueryBuilder

Get reference to this object

Specified by:

getThis in class AbstractQueryBuilder<GroupsGetInvitedUsersQuery,GetInvitedUsersResponse>

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<GroupsGetInvitedUsersQuery,GetInvitedUsersResponse>

Returns:

list of names