Class Groups

    • Constructor Detail

      • Groups

        public Groups​(VkApiClient client)
        Constructor
        Parameters:
        client - vk api client
    • Method Detail

      • addAddress

        public GroupsAddAddressQuery addAddress​(UserActor actor,
                                                int groupId,
                                                java.lang.String title,
                                                java.lang.String address,
                                                int countryId,
                                                int cityId,
                                                double latitude,
                                                double longitude)
        Parameters:
        actor - vk actor
        groupId -
        title -
        address -
        countryId -
        cityId -
        latitude -
        longitude -
        Returns:
        query
      • addAddress

        public GroupsAddAddressQuery addAddress​(GroupActor actor,
                                                int groupId,
                                                java.lang.String title,
                                                java.lang.String address,
                                                int countryId,
                                                int cityId,
                                                double latitude,
                                                double longitude)
        Parameters:
        actor - vk actor
        groupId -
        title -
        address -
        countryId -
        cityId -
        latitude -
        longitude -
        Returns:
        query
      • addCallbackServer

        public GroupsAddCallbackServerQuery addCallbackServer​(UserActor actor,
                                                              int groupId,
                                                              java.lang.String url,
                                                              java.lang.String title)
        Parameters:
        actor - vk actor
        groupId -
        url -
        title -
        Returns:
        query
      • addCallbackServer

        public GroupsAddCallbackServerQuery addCallbackServer​(GroupActor actor,
                                                              int groupId,
                                                              java.lang.String url,
                                                              java.lang.String title)
        Parameters:
        actor - vk actor
        groupId -
        url -
        title -
        Returns:
        query
      • addLink

        public GroupsAddLinkQuery addLink​(UserActor actor,
                                          int groupId,
                                          java.lang.String link)
        Allows to add a link to the community.
        Parameters:
        actor - vk actor
        groupId - Community ID.
        link - Link URL.
        Returns:
        query
      • approveRequest

        public GroupsApproveRequestQuery approveRequest​(UserActor actor,
                                                        int groupId,
                                                        int userId)
        Allows to approve join request to the community.
        Parameters:
        actor - vk actor
        groupId - Community ID.
        userId - User ID.
        Returns:
        query
      • ban

        public GroupsBanQuery ban​(UserActor actor,
                                  int groupId)
        Parameters:
        actor - vk actor
        groupId -
        Returns:
        query
      • create

        public GroupsCreateQuery create​(UserActor actor,
                                        java.lang.String title)
        Creates a new community.
        Parameters:
        actor - vk actor
        title - Community title.
        Returns:
        query
      • deleteAddress

        public GroupsDeleteAddressQuery deleteAddress​(UserActor actor,
                                                      int groupId,
                                                      int addressId)
        Parameters:
        actor - vk actor
        groupId -
        addressId -
        Returns:
        query
      • deleteAddress

        public GroupsDeleteAddressQuery deleteAddress​(GroupActor actor,
                                                      int groupId,
                                                      int addressId)
        Parameters:
        actor - vk actor
        groupId -
        addressId -
        Returns:
        query
      • deleteLink

        public GroupsDeleteLinkQuery deleteLink​(UserActor actor,
                                                int groupId,
                                                int linkId)
        Allows to delete a link from the community.
        Parameters:
        actor - vk actor
        groupId - Community ID.
        linkId - Link ID.
        Returns:
        query
      • edit

        public GroupsEditQuery edit​(UserActor actor,
                                    int groupId)
        Edits a community.
        Parameters:
        actor - vk actor
        groupId - Community ID.
        Returns:
        query
      • edit

        public GroupsEditQuery edit​(GroupActor actor,
                                    int groupId)
        Edits a community.
        Parameters:
        actor - vk actor
        groupId - Community ID.
        Returns:
        query
      • editAddress

        public GroupsEditAddressQuery editAddress​(UserActor actor,
                                                  int groupId,
                                                  int addressId)
        Parameters:
        actor - vk actor
        groupId -
        addressId -
        Returns:
        query
      • editAddress

        public GroupsEditAddressQuery editAddress​(GroupActor actor,
                                                  int groupId,
                                                  int addressId)
        Parameters:
        actor - vk actor
        groupId -
        addressId -
        Returns:
        query
      • editCallbackServer

        public GroupsEditCallbackServerQuery editCallbackServer​(UserActor actor,
                                                                int groupId,
                                                                int serverId,
                                                                java.lang.String url,
                                                                java.lang.String title)
        Parameters:
        actor - vk actor
        groupId -
        serverId -
        url -
        title -
        Returns:
        query
      • editCallbackServer

        public GroupsEditCallbackServerQuery editCallbackServer​(GroupActor actor,
                                                                int groupId,
                                                                int serverId,
                                                                java.lang.String url,
                                                                java.lang.String title)
        Parameters:
        actor - vk actor
        groupId -
        serverId -
        url -
        title -
        Returns:
        query
      • editLink

        public GroupsEditLinkQuery editLink​(UserActor actor,
                                            int groupId,
                                            int linkId)
        Allows to edit a link in the community.
        Parameters:
        actor - vk actor
        groupId - Community ID.
        linkId - Link ID.
        Returns:
        query
      • editManager

        public GroupsEditManagerQuery editManager​(UserActor actor,
                                                  int groupId,
                                                  int userId)
        Allows to add, remove or edit the community manager.
        Parameters:
        actor - vk actor
        groupId - Community ID.
        userId - User ID.
        Returns:
        query
      • get

        public GroupsGetQuery get​(UserActor actor)
        Returns a list of the communities to which a user belongs.
        Parameters:
        actor - vk actor
        Returns:
        query
      • getAddresses

        public GroupsGetAddressesQuery getAddresses​(UserActor actor,
                                                    int groupId)
        Returns a list of community addresses.
        Parameters:
        actor - vk actor
        groupId - ID or screen name of the community.
        Returns:
        query
      • getAddresses

        public GroupsGetAddressesQuery getAddresses​(ServiceActor actor,
                                                    int groupId)
        Returns a list of community addresses.
        Parameters:
        actor - vk actor
        groupId - ID or screen name of the community.
        Returns:
        query
      • getBanned

        public GroupsGetBannedQuery getBanned​(UserActor actor,
                                              int groupId)
        Returns a list of users on a community blacklist.
        Parameters:
        actor - vk actor
        groupId - Community ID.
        Returns:
        query
      • getBanned

        public GroupsGetBannedQuery getBanned​(GroupActor actor,
                                              int groupId)
        Returns a list of users on a community blacklist.
        Parameters:
        actor - vk actor
        groupId - Community ID.
        Returns:
        query
      • getCallbackConfirmationCode

        public GroupsGetCallbackConfirmationCodeQuery getCallbackConfirmationCode​(UserActor actor,
                                                                                  int groupId)
        Returns Callback API confirmation code for the community.
        Parameters:
        actor - vk actor
        groupId - Community ID.
        Returns:
        query
      • getCallbackConfirmationCode

        public GroupsGetCallbackConfirmationCodeQuery getCallbackConfirmationCode​(GroupActor actor,
                                                                                  int groupId)
        Returns Callback API confirmation code for the community.
        Parameters:
        actor - vk actor
        groupId - Community ID.
        Returns:
        query
      • getCallbackSettings

        public GroupsGetCallbackSettingsQuery getCallbackSettings​(UserActor actor,
                                                                  int groupId)
        Returns [vk.com/dev/callback_api|Callback API] notifications settings.
        Parameters:
        actor - vk actor
        groupId - Community ID.
        Returns:
        query
      • getCallbackSettings

        public GroupsGetCallbackSettingsQuery getCallbackSettings​(GroupActor actor,
                                                                  int groupId)
        Returns [vk.com/dev/callback_api|Callback API] notifications settings.
        Parameters:
        actor - vk actor
        groupId - Community ID.
        Returns:
        query
      • getCatalog

        public GroupsGetCatalogQuery getCatalog​(UserActor actor)
        Returns communities list for a catalog category.
        Parameters:
        actor - vk actor
        Returns:
        query
      • getCatalogInfo

        public GroupsGetCatalogInfoQuery getCatalogInfo​(UserActor actor)
        Returns categories list for communities catalog
        Parameters:
        actor - vk actor
        Returns:
        query
      • getInvitedUsers

        public GroupsGetInvitedUsersQuery getInvitedUsers​(UserActor actor,
                                                          int groupId)
        Returns invited users list of a community
        Parameters:
        actor - vk actor
        groupId - Group ID to return invited users for.
        Returns:
        query
      • getInvites

        public GroupsGetInvitesQuery getInvites​(UserActor actor)
        Returns a list of invitations to join communities and events.
        Parameters:
        actor - vk actor
        Returns:
        query
      • getLongPollServer

        public GroupsGetLongPollServerQuery getLongPollServer​(UserActor actor,
                                                              int groupId)
        Returns the data needed to query a Long Poll server for events
        Parameters:
        actor - vk actor
        groupId - Community ID
        Returns:
        query
      • getLongPollServer

        public GroupsGetLongPollServerQuery getLongPollServer​(GroupActor actor,
                                                              int groupId)
        Returns the data needed to query a Long Poll server for events
        Parameters:
        actor - vk actor
        groupId - Community ID
        Returns:
        query
      • getLongPollSettings

        public GroupsGetLongPollSettingsQuery getLongPollSettings​(UserActor actor,
                                                                  int groupId)
        Returns Long Poll notification settings
        Parameters:
        actor - vk actor
        groupId - Community ID.
        Returns:
        query
      • getLongPollSettings

        public GroupsGetLongPollSettingsQuery getLongPollSettings​(GroupActor actor,
                                                                  int groupId)
        Returns Long Poll notification settings
        Parameters:
        actor - vk actor
        groupId - Community ID.
        Returns:
        query
      • getMembers

        public GroupsGetMembersQuery getMembers​(UserActor actor)
        Returns a list of community members.
        Parameters:
        actor - vk actor
        Returns:
        query
      • getMembers

        public GroupsGetMembersQuery getMembers​(GroupActor actor)
        Returns a list of community members.
        Parameters:
        actor - vk actor
        Returns:
        query
      • getMembersWithFields

        public GroupsGetMembersQueryWithFields getMembersWithFields​(UserActor actor,
                                                                    Fields... fields)
        Returns a list of community members.
        Parameters:
        actor - vk actor
        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'.
        Returns:
        query
      • getMembersWithFields

        public GroupsGetMembersQueryWithFields getMembersWithFields​(GroupActor actor,
                                                                    Fields... fields)
        Returns a list of community members.
        Parameters:
        actor - vk actor
        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'.
        Returns:
        query
      • getMembersWithFields

        public GroupsGetMembersQueryWithFields getMembersWithFields​(ServiceActor actor,
                                                                    Fields... fields)
        Returns a list of community members.
        Parameters:
        actor - vk actor
        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'.
        Returns:
        query
      • getMembersWithFilter

        public GroupsGetMembersQueryWithFilter getMembersWithFilter​(UserActor actor,
                                                                    GetMembersFilter filter)
        Returns a list of community members.
        Parameters:
        actor - vk actor
        filter - *'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).
        Returns:
        query
      • getMembersWithFilter

        public GroupsGetMembersQueryWithFilter getMembersWithFilter​(GroupActor actor,
                                                                    GetMembersFilter filter)
        Returns a list of community members.
        Parameters:
        actor - vk actor
        filter - *'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).
        Returns:
        query
      • getMembersWithFilter

        public GroupsGetMembersQueryWithFilter getMembersWithFilter​(ServiceActor actor,
                                                                    GetMembersFilter filter)
        Returns a list of community members.
        Parameters:
        actor - vk actor
        filter - *'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).
        Returns:
        query
      • getRequestsWithFields

        public GroupsGetRequestsQueryWithFields getRequestsWithFields​(UserActor actor,
                                                                      int groupId,
                                                                      Fields... fields)
        Returns a list of requests to the community.
        Parameters:
        actor - vk actor
        groupId - Community ID.
        fields - Profile fields to return.
        Returns:
        query
      • getRequests

        public GroupsGetRequestsQuery getRequests​(UserActor actor,
                                                  int groupId)
        Returns a list of requests to the community.
        Parameters:
        actor - vk actor
        groupId - Community ID.
        Returns:
        query
      • getSettings

        public GroupsGetSettingsQuery getSettings​(UserActor actor,
                                                  int groupId)
        Returns community settings.
        Parameters:
        actor - vk actor
        groupId - Community ID.
        Returns:
        query
      • getTagList

        public GroupsGetTagListQuery getTagList​(UserActor actor,
                                                int groupId)
        List of group's tags
        Parameters:
        actor - vk actor
        groupId -
        Returns:
        query
      • invite

        public GroupsInviteQuery invite​(UserActor actor,
                                        int groupId,
                                        int userId)
        Allows to invite friends to the community.
        Parameters:
        actor - vk actor
        groupId - Community ID.
        userId - User ID.
        Returns:
        query
      • isMemberExtended

        public GroupsIsMemberQueryWithExtended isMemberExtended​(UserActor actor,
                                                                java.lang.String groupId)
        Returns information specifying whether a user is a member of a community.
        Parameters:
        actor - vk actor
        groupId - ID or screen name of the community.
        Returns:
        query
      • isMemberExtended

        public GroupsIsMemberQueryWithExtended isMemberExtended​(GroupActor actor,
                                                                java.lang.String groupId)
        Returns information specifying whether a user is a member of a community.
        Parameters:
        actor - vk actor
        groupId - ID or screen name of the community.
        Returns:
        query
      • isMemberExtended

        public GroupsIsMemberQueryWithExtended isMemberExtended​(ServiceActor actor,
                                                                java.lang.String groupId)
        Returns information specifying whether a user is a member of a community.
        Parameters:
        actor - vk actor
        groupId - ID or screen name of the community.
        Returns:
        query
      • isMemberUserIdsExtended

        public GroupsIsMemberQueryWithUserIdsExtended isMemberUserIdsExtended​(UserActor actor,
                                                                              java.lang.String groupId)
        Returns information specifying whether a user is a member of a community.
        Parameters:
        actor - vk actor
        groupId - ID or screen name of the community.
        Returns:
        query
      • isMemberUserIdsExtended

        public GroupsIsMemberQueryWithUserIdsExtended isMemberUserIdsExtended​(GroupActor actor,
                                                                              java.lang.String groupId)
        Returns information specifying whether a user is a member of a community.
        Parameters:
        actor - vk actor
        groupId - ID or screen name of the community.
        Returns:
        query
      • isMemberUserIdsExtended

        public GroupsIsMemberQueryWithUserIdsExtended isMemberUserIdsExtended​(ServiceActor actor,
                                                                              java.lang.String groupId)
        Returns information specifying whether a user is a member of a community.
        Parameters:
        actor - vk actor
        groupId - ID or screen name of the community.
        Returns:
        query
      • isMemberWithUserIds

        public GroupsIsMemberQueryWithUserIds isMemberWithUserIds​(UserActor actor,
                                                                  java.lang.String groupId,
                                                                  java.lang.Integer... userIds)
        Returns information specifying whether a user is a member of a community.
        Parameters:
        actor - vk actor
        groupId - ID or screen name of the community.
        userIds - User IDs.
        Returns:
        query
      • isMemberWithUserIds

        public GroupsIsMemberQueryWithUserIds isMemberWithUserIds​(GroupActor actor,
                                                                  java.lang.String groupId,
                                                                  java.lang.Integer... userIds)
        Returns information specifying whether a user is a member of a community.
        Parameters:
        actor - vk actor
        groupId - ID or screen name of the community.
        userIds - User IDs.
        Returns:
        query
      • isMemberWithUserIds

        public GroupsIsMemberQueryWithUserIds isMemberWithUserIds​(ServiceActor actor,
                                                                  java.lang.String groupId,
                                                                  java.lang.Integer... userIds)
        Returns information specifying whether a user is a member of a community.
        Parameters:
        actor - vk actor
        groupId - ID or screen name of the community.
        userIds - User IDs.
        Returns:
        query
      • isMember

        public GroupsIsMemberQuery isMember​(UserActor actor,
                                            java.lang.String groupId)
        Returns information specifying whether a user is a member of a community.
        Parameters:
        actor - vk actor
        groupId - ID or screen name of the community.
        Returns:
        query
      • isMember

        public GroupsIsMemberQuery isMember​(GroupActor actor,
                                            java.lang.String groupId)
        Returns information specifying whether a user is a member of a community.
        Parameters:
        actor - vk actor
        groupId - ID or screen name of the community.
        Returns:
        query
      • isMember

        public GroupsIsMemberQuery isMember​(ServiceActor actor,
                                            java.lang.String groupId)
        Returns information specifying whether a user is a member of a community.
        Parameters:
        actor - vk actor
        groupId - ID or screen name of the community.
        Returns:
        query
      • join

        public GroupsJoinQuery join​(UserActor actor)
        With this method you can join the group or public page, and also confirm your participation in an event.
        Parameters:
        actor - vk actor
        Returns:
        query
      • leave

        public GroupsLeaveQuery leave​(UserActor actor,
                                      int groupId)
        With this method you can leave a group, public page, or event.
        Parameters:
        actor - vk actor
        groupId - ID or screen name of the community.
        Returns:
        query
      • removeUser

        public GroupsRemoveUserQuery removeUser​(UserActor actor,
                                                int groupId,
                                                int userId)
        Removes a user from the community.
        Parameters:
        actor - vk actor
        groupId - Community ID.
        userId - User ID.
        Returns:
        query
      • reorderLink

        public GroupsReorderLinkQuery reorderLink​(UserActor actor,
                                                  int groupId,
                                                  int linkId)
        Allows to reorder links in the community.
        Parameters:
        actor - vk actor
        groupId - Community ID.
        linkId - Link ID.
        Returns:
        query
      • search

        public GroupsSearchQuery search​(UserActor actor,
                                        java.lang.String q)
        Returns a list of communities matching the search criteria.
        Parameters:
        actor - vk actor
        q - Search query string.
        Returns:
        query
      • setCallbackSettings

        public GroupsSetCallbackSettingsQuery setCallbackSettings​(UserActor actor,
                                                                  int groupId)
        Allow to set notifications settings for group.
        Parameters:
        actor - vk actor
        groupId - Community ID.
        Returns:
        query
      • setCallbackSettings

        public GroupsSetCallbackSettingsQuery setCallbackSettings​(GroupActor actor,
                                                                  int groupId)
        Allow to set notifications settings for group.
        Parameters:
        actor - vk actor
        groupId - Community ID.
        Returns:
        query
      • setLongPollSettings

        public GroupsSetLongPollSettingsQuery setLongPollSettings​(UserActor actor,
                                                                  int groupId)
        Sets Long Poll notification settings
        Parameters:
        actor - vk actor
        groupId - Community ID.
        Returns:
        query
      • setLongPollSettings

        public GroupsSetLongPollSettingsQuery setLongPollSettings​(GroupActor actor,
                                                                  int groupId)
        Sets Long Poll notification settings
        Parameters:
        actor - vk actor
        groupId - Community ID.
        Returns:
        query
      • setUserNote

        public GroupsSetUserNoteQuery setUserNote​(UserActor actor,
                                                  int groupId,
                                                  int userId)
        In order to save note about group participant
        Parameters:
        actor - vk actor
        groupId -
        userId -
        Returns:
        query
      • tagAdd

        public GroupsTagAddQuery tagAdd​(UserActor actor,
                                        int groupId,
                                        java.lang.String tagName)
        Add new group's tag
        Parameters:
        actor - vk actor
        groupId -
        tagName -
        Returns:
        query
      • tagBind

        public GroupsTagBindQuery tagBind​(UserActor actor,
                                          int groupId,
                                          int tagId,
                                          int userId,
                                          TagBindAct act)
        Bind or unbind group's tag to user
        Parameters:
        actor - vk actor
        groupId -
        tagId -
        userId -
        act - Describe the action
        Returns:
        query
      • tagDelete

        public GroupsTagDeleteQuery tagDelete​(UserActor actor,
                                              int groupId,
                                              int tagId)
        Delete group's tag
        Parameters:
        actor - vk actor
        groupId -
        tagId -
        Returns:
        query
      • tagUpdate

        public GroupsTagUpdateQuery tagUpdate​(UserActor actor,
                                              int groupId,
                                              int tagId,
                                              java.lang.String tagName)
        Update group's tag
        Parameters:
        actor - vk actor
        groupId -
        tagId -
        tagName -
        Returns:
        query
      • unban

        public GroupsUnbanQuery unban​(UserActor actor,
                                      int groupId)
        Parameters:
        actor - vk actor
        groupId -
        Returns:
        query