Package com.vk.api.sdk.actions

Class Market

    • Constructor Detail

      • Market

        public Market​(VkApiClient client)
        Constructor
        Parameters:
        client - vk api client

    • Method Detail

      • add

        public MarketAddQuery add​(UserActor actor,
                          int ownerId,
                          java.lang.String name,
                          java.lang.String description,
                          int categoryId)
        Ads a new item to the market.
        Parameters:
        actor - vk actor
        ownerId - ID of an item owner community.
        name - Item name.
        description - Item description.
        categoryId - Item category ID.
        Returns:
        query

      • addAlbum

        public MarketAddAlbumQuery addAlbum​(UserActor actor,
                                    int ownerId,
                                    java.lang.String title)
        Creates new collection of items
        Parameters:
        actor - vk actor
        ownerId - ID of an item owner community.
        title - Collection title.
        Returns:
        query

      • addToAlbum

        public MarketAddToAlbumQuery addToAlbum​(UserActor actor,
                                        int ownerId,
                                        java.lang.Integer[] itemIds,
                                        java.lang.Integer... albumIds)
        Adds an item to one or multiple collections.
        Parameters:
        actor - vk actor
        ownerId - ID of an item owner community.
        itemIds -
        albumIds - Collections IDs to add item to.
        Returns:
        query

      • addToAlbum

        public MarketAddToAlbumQuery addToAlbum​(UserActor actor,
                                        int ownerId,
                                        java.util.List<java.lang.Integer> itemIds,
                                        java.util.List<java.lang.Integer> albumIds)
        Adds an item to one or multiple collections.
        Parameters:
        actor - vk actor
        ownerId - ID of an item owner community.
        itemIds -
        albumIds - Collections IDs to add item to.
        Returns:
        query

      • createComment

        public MarketCreateCommentQuery createComment​(UserActor actor,
                                              int ownerId,
                                              int itemId)
        Creates a new comment for an item.
        Parameters:
        actor - vk actor
        ownerId - ID of an item owner community.
        itemId - Item ID.
        Returns:
        query

      • delete

        public MarketDeleteQuery delete​(UserActor actor,
                                int ownerId,
                                int itemId)
        Deletes an item.
        Parameters:
        actor - vk actor
        ownerId - ID of an item owner community.
        itemId - Item ID.
        Returns:
        query

      • deleteAlbum

        public MarketDeleteAlbumQuery deleteAlbum​(UserActor actor,
                                          int ownerId,
                                          int albumId)
        Deletes a collection of items.
        Parameters:
        actor - vk actor
        ownerId - ID of an collection owner community.
        albumId - Collection ID.
        Returns:
        query

      • deleteComment

        public MarketDeleteCommentQuery deleteComment​(UserActor actor,
                                              int ownerId,
                                              int commentId)
        Deletes an item's comment
        Parameters:
        actor - vk actor
        ownerId - identifier of an item owner community, "Note that community id in the 'owner_id' parameter should be negative number. For example 'owner_id'=-1 matches the [vk.com/apiclub|VK API] community "
        commentId - comment id
        Returns:
        query

      • edit

        public MarketEditQuery edit​(UserActor actor,
                            int ownerId,
                            int itemId,
                            java.lang.String name,
                            java.lang.String description,
                            int categoryId)
        Edits an item.
        Parameters:
        actor - vk actor
        ownerId - ID of an item owner community.
        itemId - Item ID.
        name - Item name.
        description - Item description.
        categoryId - Item category ID.
        Returns:
        query

      • editAlbum

        public MarketEditAlbumQuery editAlbum​(UserActor actor,
                                      int ownerId,
                                      int albumId,
                                      java.lang.String title)
        Edits a collection of items
        Parameters:
        actor - vk actor
        ownerId - ID of an collection owner community.
        albumId - Collection ID.
        title - Collection title.
        Returns:
        query

      • editComment

        public MarketEditCommentQuery editComment​(UserActor actor,
                                          int ownerId,
                                          int commentId)
        Chages item comment's text
        Parameters:
        actor - vk actor
        ownerId - ID of an item owner community.
        commentId - Comment ID.
        Returns:
        query

      • editOrder

        public MarketEditOrderQuery editOrder​(UserActor actor,
                                      int userId,
                                      int orderId)
        Edit order
        Parameters:
        actor - vk actor
        userId -
        orderId -
        Returns:
        query

      • editOrder

        public MarketEditOrderQuery editOrder​(GroupActor actor,
                                      int userId,
                                      int orderId)
        Edit order
        Parameters:
        actor - vk actor
        userId -
        orderId -
        Returns:
        query

      • getExtended

        public MarketGetQueryWithExtended getExtended​(UserActor actor,
                                              int ownerId)
        Returns items list for a community.
        Parameters:
        actor - vk actor
        ownerId - ID of an item owner community, "Note that community id in the 'owner_id' parameter should be negative number. For example 'owner_id'=-1 matches the [vk.com/apiclub|VK API] community "
        Returns:
        query

      • get

        public MarketGetQuery get​(UserActor actor,
                          int ownerId)
        Returns items list for a community.
        Parameters:
        actor - vk actor
        ownerId - ID of an item owner community, "Note that community id in the 'owner_id' parameter should be negative number. For example 'owner_id'=-1 matches the [vk.com/apiclub|VK API] community "
        Returns:
        query

      • getAlbumById

        public MarketGetAlbumByIdQuery getAlbumById​(UserActor actor,
                                            int ownerId,
                                            java.lang.Integer... albumIds)
        Returns items album's data
        Parameters:
        actor - vk actor
        ownerId - identifier of an album owner community, "Note that community id in the 'owner_id' parameter should be negative number. For example 'owner_id'=-1 matches the [vk.com/apiclub|VK API] community "
        albumIds - collections identifiers to obtain data from
        Returns:
        query

      • getAlbumById

        public MarketGetAlbumByIdQuery getAlbumById​(UserActor actor,
                                            int ownerId,
                                            java.util.List<java.lang.Integer> albumIds)
        Returns items album's data
        Parameters:
        actor - vk actor
        ownerId - identifier of an album owner community, "Note that community id in the 'owner_id' parameter should be negative number. For example 'owner_id'=-1 matches the [vk.com/apiclub|VK API] community "
        albumIds - collections identifiers to obtain data from
        Returns:
        query

      • getAlbums

        public MarketGetAlbumsQuery getAlbums​(UserActor actor,
                                      int ownerId)
        Returns community's market collections list.
        Parameters:
        actor - vk actor
        ownerId - ID of an items owner community.
        Returns:
        query

      • getById

        public MarketGetByIdQuery getById​(UserActor actor,
                                  java.lang.String... itemIds)
        Returns information about market items by their ids.
        Parameters:
        actor - vk actor
        itemIds - Comma-separated ids list: {user id}_{item id}. If an item belongs to a community -{community id} is used. " 'Videos' value example: , '-4363_136089719,13245770_137352259'"
        Returns:
        query

      • getById

        public MarketGetByIdQuery getById​(UserActor actor,
                                  java.util.List<java.lang.String> itemIds)
        Returns information about market items by their ids.
        Parameters:
        actor - vk actor
        itemIds - Comma-separated ids list: {user id}_{item id}. If an item belongs to a community -{community id} is used. " 'Videos' value example: , '-4363_136089719,13245770_137352259'"
        Returns:
        query

      • getByIdExtended

        public MarketGetByIdQueryWithExtended getByIdExtended​(UserActor actor,
                                                      java.lang.String... itemIds)
        Returns information about market items by their ids.
        Parameters:
        actor - vk actor
        itemIds - Comma-separated ids list: {user id}_{item id}. If an item belongs to a community -{community id} is used. " 'Videos' value example: , '-4363_136089719,13245770_137352259'"
        Returns:
        query

      • getByIdExtended

        public MarketGetByIdQueryWithExtended getByIdExtended​(UserActor actor,
                                                      java.util.List<java.lang.String> itemIds)
        Returns information about market items by their ids.
        Parameters:
        actor - vk actor
        itemIds - Comma-separated ids list: {user id}_{item id}. If an item belongs to a community -{community id} is used. " 'Videos' value example: , '-4363_136089719,13245770_137352259'"
        Returns:
        query

      • getCategories

        public MarketGetCategoriesQuery getCategories​(UserActor actor)
        Returns a list of market categories.
        Parameters:
        actor - vk actor
        Returns:
        query

      • getComments

        public MarketGetCommentsQuery getComments​(UserActor actor,
                                          int ownerId,
                                          int itemId)
        Returns comments list for an item.
        Parameters:
        actor - vk actor
        ownerId - ID of an item owner community
        itemId - Item ID.
        Returns:
        query

      • getGroupOrders

        public MarketGetGroupOrdersQuery getGroupOrders​(UserActor actor,
                                                int groupId)
        Get market orders
        Parameters:
        actor - vk actor
        groupId -
        Returns:
        query

      • getOrderItems

        public MarketGetOrderItemsQuery getOrderItems​(UserActor actor,
                                              int orderId)
        Get market items in the order
        Parameters:
        actor - vk actor
        orderId -
        Returns:
        query

      • getOrderItems

        public MarketGetOrderItemsQuery getOrderItems​(GroupActor actor,
                                              int orderId)
        Get market items in the order
        Parameters:
        actor - vk actor
        orderId -
        Returns:
        query

      • removeFromAlbum

        public MarketRemoveFromAlbumQuery removeFromAlbum​(UserActor actor,
                                                  int ownerId,
                                                  int itemId,
                                                  java.lang.Integer... albumIds)
        Removes an item from one or multiple collections.
        Parameters:
        actor - vk actor
        ownerId - ID of an item owner community.
        itemId - Item ID.
        albumIds - Collections IDs to remove item from.
        Returns:
        query

      • removeFromAlbum

        public MarketRemoveFromAlbumQuery removeFromAlbum​(UserActor actor,
                                                  int ownerId,
                                                  int itemId,
                                                  java.util.List<java.lang.Integer> albumIds)
        Removes an item from one or multiple collections.
        Parameters:
        actor - vk actor
        ownerId - ID of an item owner community.
        itemId - Item ID.
        albumIds - Collections IDs to remove item from.
        Returns:
        query

      • reorderAlbums

        public MarketReorderAlbumsQuery reorderAlbums​(UserActor actor,
                                              int ownerId,
                                              int albumId)
        Reorders the collections list.
        Parameters:
        actor - vk actor
        ownerId - ID of an item owner community.
        albumId - Collection ID.
        Returns:
        query

      • reorderItems

        public MarketReorderItemsQuery reorderItems​(UserActor actor,
                                            int ownerId,
                                            int itemId)
        Changes item place in a collection.
        Parameters:
        actor - vk actor
        ownerId - ID of an item owner community.
        itemId - Item ID.
        Returns:
        query

      • report

        public MarketReportQuery report​(UserActor actor,
                                int ownerId,
                                int itemId)
        Sends a complaint to the item.
        Parameters:
        actor - vk actor
        ownerId - ID of an item owner community.
        itemId - Item ID.
        Returns:
        query

      • reportComment

        public MarketReportCommentQuery reportComment​(UserActor actor,
                                              int ownerId,
                                              int commentId,
                                              int reason)
        Sends a complaint to the item's comment.
        Parameters:
        actor - vk actor
        ownerId - ID of an item owner community.
        commentId - Comment ID.
        reason - Complaint reason. Possible values: *'0' — spam,, *'1' — child porn,, *'2' — extremism,, *'3' — violence,, *'4' — drugs propaganda,, *'5' — adult materials,, *'6' — insult.
        Returns:
        query

      • restore

        public MarketRestoreQuery restore​(UserActor actor,
                                  int ownerId,
                                  int itemId)
        Restores recently deleted item
        Parameters:
        actor - vk actor
        ownerId - ID of an item owner community.
        itemId - Deleted item ID.
        Returns:
        query

      • restoreComment

        public MarketRestoreCommentQuery restoreComment​(UserActor actor,
                                                int ownerId,
                                                int commentId)
        Restores a recently deleted comment
        Parameters:
        actor - vk actor
        ownerId - identifier of an item owner community, "Note that community id in the 'owner_id' parameter should be negative number. For example 'owner_id'=-1 matches the [vk.com/apiclub|VK API] community "
        commentId - deleted comment id
        Returns:
        query

      • searchExtended

        public MarketSearchQueryWithExtended searchExtended​(UserActor actor,
                                                    int ownerId)
        Searches market items in a community's catalog
        Parameters:
        actor - vk actor
        ownerId - ID of an items owner community.
        Returns:
        query

      • search

        public MarketSearchQuery search​(UserActor actor,
                                int ownerId)
        Searches market items in a community's catalog
        Parameters:
        actor - vk actor
        ownerId - ID of an items owner community.
        Returns:
        query