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

Class GroupsGetQuery

java.lang.Object
com.vk.api.sdk.client.ApiRequest<R>
com.vk.api.sdk.client.AbstractQueryBuilder<GroupsGetQuery,​GetResponse>
com.vk.api.sdk.queries.groups.GroupsGetQuery
public class GroupsGetQuery
extends AbstractQueryBuilder<GroupsGetQuery,​GetResponse>
Query for Groups.get method

  • Constructor Details

    • GroupsGetQuery

      public GroupsGetQuery​(VkApiClient client, UserActor actor)
      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

  • Method Details

    • userId

      public GroupsGetQuery userId​(java.lang.Integer value)
      User ID.
      Parameters:
      value - value of "user id" parameter. Minimum is 0.
      Returns:
      a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

    • extended

      public GroupsGetQuery extended​(java.lang.Boolean value)
      '1' — to return complete information about a user's communities, '0' — to return a list of community IDs without any additional fields (default),
      Parameters:
      value - value of "extended" parameter.
      Returns:
      a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

    • offset

      public GroupsGetQuery offset​(java.lang.Integer value)
      Offset needed to return a specific subset of communities.
      Parameters:
      value - value of "offset" parameter. Minimum is 0.
      Returns:
      a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

    • count

      public GroupsGetQuery count​(java.lang.Integer value)
      Number of communities to return.
      Parameters:
      value - value of "count" parameter. Maximum is 1000. Minimum is 0.
      Returns:
      a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

    • filter

      public GroupsGetQuery filter​(Filter... value)
      filter Types of communities to return: 'admin' — to return communities administered by the user , 'editor' — to return communities where the user is an administrator or editor, 'moder' — to return communities where the user is an administrator, editor, or moderator, 'groups' — to return only groups, 'publics' — to return only public pages, 'events' — to return only events
      Parameters:
      value - value of "filter" parameter.
      Returns:
      a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

    • filter

      public GroupsGetQuery filter​(java.util.List<Filter> value)
      Types of communities to return: 'admin' — to return communities administered by the user , 'editor' — to return communities where the user is an administrator or editor, 'moder' — to return communities where the user is an administrator, editor, or moderator, 'groups' — to return only groups, 'publics' — to return only public pages, 'events' — to return only events
      Parameters:
      value - value of "filter" parameter.
      Returns:
      a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

    • fields

      public GroupsGetQuery fields​(Fields... value)
      fields Profile fields to return.
      Parameters:
      value - value of "fields" parameter.
      Returns:
      a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

    • fields

      public GroupsGetQuery fields​(java.util.List<Fields> value)
      Profile fields to return.
      Parameters:
      value - value of "fields" parameter.
      Returns:
      a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

    • getThis

      protected GroupsGetQuery getThis()
      Description copied from class: AbstractQueryBuilder
      Get reference to this object
      Specified by:
      getThis in class AbstractQueryBuilder<GroupsGetQuery,​GetResponse>
      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<GroupsGetQuery,​GetResponse>
      Returns:
      list of names