com.vk.api.sdk.queries.groups

Class GroupsGetMembersQueryWithFilter

java.lang.Object

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

com.vk.api.sdk.client.AbstractQueryBuilder<GroupsGetMembersQueryWithFilter,GetMembersFilterResponse>

com.vk.api.sdk.queries.groups.GroupsGetMembersQueryWithFilter

public class GroupsGetMembersQueryWithFilter
extends AbstractQueryBuilder<GroupsGetMembersQueryWithFilter,GetMembersFilterResponse>

Query for Groups.getMembers method

Constructor Summary

Constructors

Constructor and Description
GroupsGetMembersQueryWithFilter(VkApiClient client, GroupActor actor, GetMembersFilter filter) Creates a AbstractQueryBuilder instance that can be used to build group api request with various parameters
GroupsGetMembersQueryWithFilter(VkApiClient client, ServiceActor actor, GetMembersFilter filter) Creates a AbstractQueryBuilder instance that can be used to build service api request with various parameters
GroupsGetMembersQueryWithFilter(VkApiClient client, UserActor actor, GetMembersFilter filter) Creates a AbstractQueryBuilder instance that can be used to build user api request with various parameters

Method Summary

Modifier and Type	Method and Description
GroupsGetMembersQueryWithFilter	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
GroupsGetMembersQueryWithFilter	fields(Fields... value) fields List of additional fields to be returned.
GroupsGetMembersQueryWithFilter	fields(java.util.List<Fields> value) List of additional fields to be returned.
protected GroupsGetMembersQueryWithFilter	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 GroupsGetMembersQueryWithFilter	getThis() Get reference to this object
GroupsGetMembersQueryWithFilter	groupId(java.lang.String value) ID or screen name of the community.
GroupsGetMembersQueryWithFilter	offset(java.lang.Integer value) Offset needed to return a specific subset of community members.
GroupsGetMembersQueryWithFilter	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

GroupsGetMembersQueryWithFilter

public GroupsGetMembersQueryWithFilter(VkApiClient client,
                                       GroupActor actor,
                                       GetMembersFilter filter)

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

GroupsGetMembersQueryWithFilter

public GroupsGetMembersQueryWithFilter(VkApiClient client,
                                       UserActor actor,
                                       GetMembersFilter filter)

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

GroupsGetMembersQueryWithFilter

public GroupsGetMembersQueryWithFilter(VkApiClient client,
                                       ServiceActor actor,
                                       GetMembersFilter filter)

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 GroupsGetMembersQueryWithFilter 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 GroupsGetMembersQueryWithFilter 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 GroupsGetMembersQueryWithFilter 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 GroupsGetMembersQueryWithFilter 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

protected GroupsGetMembersQueryWithFilter 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 GroupsGetMembersQueryWithFilter 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 GroupsGetMembersQueryWithFilter 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 GroupsGetMembersQueryWithFilter getThis()

Description copied from class: AbstractQueryBuilder

Get reference to this object

Specified by:

getThis in class AbstractQueryBuilder<GroupsGetMembersQueryWithFilter,GetMembersFilterResponse>

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<GroupsGetMembersQueryWithFilter,GetMembersFilterResponse>

Returns:

list of names