com.vk.api.sdk.queries.groups

Class GroupsGetMembersQuery

java.lang.Object

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

com.vk.api.sdk.client.AbstractQueryBuilder<GroupsGetMembersQuery,GetMembersResponse>

com.vk.api.sdk.queries.groups.GroupsGetMembersQuery

public class GroupsGetMembersQuery
extends AbstractQueryBuilder<GroupsGetMembersQuery,GetMembersResponse>

Query for Groups.getMembers method

Constructor Summary

Constructors

Constructor and Description
GroupsGetMembersQuery(VkApiClient client, GroupActor actor) Creates a AbstractQueryBuilder instance that can be used to build group api request with various parameters
GroupsGetMembersQuery(VkApiClient client, ServiceActor actor) Creates a AbstractQueryBuilder instance that can be used to build service api request with various parameters
GroupsGetMembersQuery(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
GroupsGetMembersQuery	count(java.lang.Integer value) Number of community members to return.
protected java.util.List<java.lang.String>	essentialKeys() Get list of required parameter names
GroupsGetMembersQuery	fields(Fields... value) fields List of additional fields to be returned.
GroupsGetMembersQuery	fields(java.util.List<Fields> value) List of additional fields to be returned.
GroupsGetMembersQuery	filter(GetMembersFilter value) *'friends' - only friends in this community will be returned,, *'unsure' - only those who pressed 'I may attend' will be returned (if it's an event).
protected GroupsGetMembersQuery	getThis() Get reference to this object
GroupsGetMembersQuery	groupId(java.lang.String value) ID or screen name of the community.
GroupsGetMembersQuery	offset(java.lang.Integer value) Offset needed to return a specific subset of community members.
GroupsGetMembersQuery	sort(GetMembersSort value) Sort order.

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

GroupsGetMembersQuery

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

GroupsGetMembersQuery

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

GroupsGetMembersQuery

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

groupId

public GroupsGetMembersQuery groupId(java.lang.String value)

ID or screen name of the community.

Parameters:

value - value of "group id" parameter. Entity - groups

Returns:

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

sort

public GroupsGetMembersQuery sort(GetMembersSort value)

Sort order. Available values: 'id_asc', 'id_desc', 'time_asc', 'time_desc'. 'time_asc' and 'time_desc' are availavle only if the method is called by the group's 'moderator'.

Parameters:

value - value of "sort" parameter. By default id_asc.

Returns:

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

offset

public GroupsGetMembersQuery offset(java.lang.Integer value)

Offset needed to return a specific subset of community members.

Parameters:

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

Returns:

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

count

public GroupsGetMembersQuery count(java.lang.Integer value)

Number of community members to return.

Parameters:

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

Returns:

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

filter

public GroupsGetMembersQuery filter(GetMembersFilter value)

*'friends' - only friends in this community will be returned,, *'unsure' - only those who pressed 'I may attend' will be returned (if it's an event).

Parameters:

value - value of "filter" parameter.

Returns:

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

fields

public GroupsGetMembersQuery 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 GroupsGetMembersQuery 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 GroupsGetMembersQuery getThis()

Description copied from class: AbstractQueryBuilder

Get reference to this object

Specified by:

getThis in class AbstractQueryBuilder<GroupsGetMembersQuery,GetMembersResponse>

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<GroupsGetMembersQuery,GetMembersResponse>

Returns:

list of names