Package com.vk.api.sdk.queries.groups
Class GroupsGetMembersQueryWithFields
- java.lang.Object
-
- com.vk.api.sdk.client.ApiRequest<R>
-
- com.vk.api.sdk.client.AbstractQueryBuilder<GroupsGetMembersQueryWithFields,GetMembersFieldsResponse>
-
- com.vk.api.sdk.queries.groups.GroupsGetMembersQueryWithFields
-
public class GroupsGetMembersQueryWithFields extends AbstractQueryBuilder<GroupsGetMembersQueryWithFields,GetMembersFieldsResponse>
Query for Groups.getMembers method
-
-
Constructor Summary
Constructors Constructor Description GroupsGetMembersQueryWithFields(VkApiClient client, GroupActor actor, Fields... fields)Creates a AbstractQueryBuilder instance that can be used to build api request with various parametersGroupsGetMembersQueryWithFields(VkApiClient client, GroupActor actor, java.util.List<Fields> fields)Creates a AbstractQueryBuilder instance that can be used to build api request with various parametersGroupsGetMembersQueryWithFields(VkApiClient client, ServiceActor actor, Fields... fields)Creates a AbstractQueryBuilder instance that can be used to build api request with various parametersGroupsGetMembersQueryWithFields(VkApiClient client, ServiceActor actor, java.util.List<Fields> fields)Creates a AbstractQueryBuilder instance that can be used to build api request with various parametersGroupsGetMembersQueryWithFields(VkApiClient client, UserActor actor, Fields... fields)Creates a AbstractQueryBuilder instance that can be used to build api request with various parametersGroupsGetMembersQueryWithFields(VkApiClient client, UserActor actor, java.util.List<Fields> fields)Creates a AbstractQueryBuilder instance that can be used to build api request with various parameters
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description GroupsGetMembersQueryWithFieldscount(java.lang.Integer value)Number of community members to return.protected java.util.List<java.lang.String>essentialKeys()Get list of required parameter namesprotected GroupsGetMembersQueryWithFieldsfields(Fields... value)fields List of additional fields to be returned.protected GroupsGetMembersQueryWithFieldsfields(java.util.List<Fields> value)List of additional fields to be returned.GroupsGetMembersQueryWithFieldsfilter(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 GroupsGetMembersQueryWithFieldsgetThis()Get reference to this objectGroupsGetMembersQueryWithFieldsgroupId(java.lang.String value)ID or screen name of the community.GroupsGetMembersQueryWithFieldsoffset(java.lang.Integer value)Offset needed to return a specific subset of community members.GroupsGetMembersQueryWithFieldssort(GetMembersSort value)Sort order.-
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
-
-
-
-
Constructor Detail
-
GroupsGetMembersQueryWithFields
public GroupsGetMembersQueryWithFields(VkApiClient client, UserActor actor, Fields... fields)
Creates a AbstractQueryBuilder instance that can be used to build api request with various parameters- Parameters:
client- VK API clientactor- actor with access token
-
GroupsGetMembersQueryWithFields
public GroupsGetMembersQueryWithFields(VkApiClient client, UserActor actor, java.util.List<Fields> fields)
Creates a AbstractQueryBuilder instance that can be used to build api request with various parameters- Parameters:
client- VK API clientactor- actor with access token
-
GroupsGetMembersQueryWithFields
public GroupsGetMembersQueryWithFields(VkApiClient client, GroupActor actor, Fields... fields)
Creates a AbstractQueryBuilder instance that can be used to build api request with various parameters- Parameters:
client- VK API clientactor- actor with access token
-
GroupsGetMembersQueryWithFields
public GroupsGetMembersQueryWithFields(VkApiClient client, GroupActor actor, java.util.List<Fields> fields)
Creates a AbstractQueryBuilder instance that can be used to build api request with various parameters- Parameters:
client- VK API clientactor- actor with access token
-
GroupsGetMembersQueryWithFields
public GroupsGetMembersQueryWithFields(VkApiClient client, ServiceActor actor, Fields... fields)
Creates a AbstractQueryBuilder instance that can be used to build api request with various parameters- Parameters:
client- VK API clientactor- actor with access token
-
GroupsGetMembersQueryWithFields
public GroupsGetMembersQueryWithFields(VkApiClient client, ServiceActor actor, java.util.List<Fields> fields)
Creates a AbstractQueryBuilder instance that can be used to build api request with various parameters- Parameters:
client- VK API clientactor- actor with access token
-
-
Method Detail
-
groupId
public GroupsGetMembersQueryWithFields groupId(java.lang.String value)
ID or screen name of the community.- Parameters:
value- value of "group id" parameter.- Returns:
- a reference to this
AbstractQueryBuilderobject to fulfill the "Builder" pattern.
-
sort
public GroupsGetMembersQueryWithFields 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
AbstractQueryBuilderobject to fulfill the "Builder" pattern.
-
offset
public GroupsGetMembersQueryWithFields 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
AbstractQueryBuilderobject to fulfill the "Builder" pattern.
-
count
public GroupsGetMembersQueryWithFields 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
AbstractQueryBuilderobject to fulfill the "Builder" pattern.
-
filter
public GroupsGetMembersQueryWithFields 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
AbstractQueryBuilderobject to fulfill the "Builder" pattern.
-
fields
protected GroupsGetMembersQueryWithFields 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
AbstractQueryBuilderobject to fulfill the "Builder" pattern.
-
fields
protected GroupsGetMembersQueryWithFields 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
AbstractQueryBuilderobject to fulfill the "Builder" pattern.
-
getThis
protected GroupsGetMembersQueryWithFields getThis()
Description copied from class:AbstractQueryBuilderGet reference to this object- Specified by:
getThisin classAbstractQueryBuilder<GroupsGetMembersQueryWithFields,GetMembersFieldsResponse>- Returns:
- a reference to this
AbstractQueryBuilderobject to fulfill the "Builder" pattern.
-
essentialKeys
protected java.util.List<java.lang.String> essentialKeys()
Description copied from class:AbstractQueryBuilderGet list of required parameter names- Specified by:
essentialKeysin classAbstractQueryBuilder<GroupsGetMembersQueryWithFields,GetMembersFieldsResponse>- Returns:
- list of names
-
-