Package com.vk.api.sdk.actions

Class Messages

  • public class Messages
extends AbstractAction
    List of Messages methods

    • Constructor Detail

      • Messages

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

    • Method Detail

      • addChatUser

        public MessagesAddChatUserQuery addChatUser​(UserActor actor,
                                            int chatId)
        Adds a new user to a chat.
        Parameters:
        actor - vk actor
        chatId - Chat ID.
        Returns:
        query

      • allowMessagesFromGroup

        public MessagesAllowMessagesFromGroupQuery allowMessagesFromGroup​(UserActor actor,
                                                                  int groupId)
        Allows sending messages from community to the current user.
        Parameters:
        actor - vk actor
        groupId - Group ID.
        Returns:
        query

      • createChat

        public MessagesCreateChatQuery createChat​(UserActor actor)
        Creates a chat with several participants.
        Parameters:
        actor - vk actor
        Returns:
        query

      • deleteChatPhoto

        public MessagesDeleteChatPhotoQuery deleteChatPhoto​(UserActor actor,
                                                    int chatId)
        Deletes a chat's cover picture.
        Parameters:
        actor - vk actor
        chatId - Chat ID.
        Returns:
        query

      • deleteChatPhoto

        public MessagesDeleteChatPhotoQuery deleteChatPhoto​(GroupActor actor,
                                                    int chatId)
        Deletes a chat's cover picture.
        Parameters:
        actor - vk actor
        chatId - Chat ID.
        Returns:
        query

      • denyMessagesFromGroup

        public MessagesDenyMessagesFromGroupQuery denyMessagesFromGroup​(UserActor actor,
                                                                int groupId)
        Denies sending message from community to the current user.
        Parameters:
        actor - vk actor
        groupId - Group ID.
        Returns:
        query

      • edit

        public MessagesEditQuery edit​(UserActor actor,
                              int peerId)
        Edits the message.
        Parameters:
        actor - vk actor
        peerId - Destination ID. "For user: 'User ID', e.g. '12345'. For chat: '2000000000' + 'chat_id', e.g. '2000000001'. For community: '- community ID', e.g. '-12345'. "
        Returns:
        query

      • edit

        public MessagesEditQuery edit​(GroupActor actor,
                              int peerId)
        Edits the message.
        Parameters:
        actor - vk actor
        peerId - Destination ID. "For user: 'User ID', e.g. '12345'. For chat: '2000000000' + 'chat_id', e.g. '2000000001'. For community: '- community ID', e.g. '-12345'. "
        Returns:
        query

      • editChat

        public MessagesEditChatQuery editChat​(UserActor actor,
                                      int chatId)
        Edits the title of a chat.
        Parameters:
        actor - vk actor
        chatId - Chat ID.
        Returns:
        query

      • editChat

        public MessagesEditChatQuery editChat​(GroupActor actor,
                                      int chatId)
        Edits the title of a chat.
        Parameters:
        actor - vk actor
        chatId - Chat ID.
        Returns:
        query

      • getByConversationMessageId

        public MessagesGetByConversationMessageIdQuery getByConversationMessageId​(UserActor actor,
                                                                          int peerId,
                                                                          java.lang.Integer... conversationMessageIds)
        Returns messages by their IDs within the conversation.
        Parameters:
        actor - vk actor
        peerId - Destination ID. "For user: 'User ID', e.g. '12345'. For chat: '2000000000' + 'chat_id', e.g. '2000000001'. For community: '- community ID', e.g. '-12345'. "
        conversationMessageIds - Conversation message IDs.
        Returns:
        query

      • getByConversationMessageId

        public MessagesGetByConversationMessageIdQuery getByConversationMessageId​(UserActor actor,
                                                                          int peerId,
                                                                          java.util.List<java.lang.Integer> conversationMessageIds)
        Returns messages by their IDs within the conversation.
        Parameters:
        actor - vk actor
        peerId - Destination ID. "For user: 'User ID', e.g. '12345'. For chat: '2000000000' + 'chat_id', e.g. '2000000001'. For community: '- community ID', e.g. '-12345'. "
        conversationMessageIds - Conversation message IDs.
        Returns:
        query

      • getByConversationMessageId

        public MessagesGetByConversationMessageIdQuery getByConversationMessageId​(GroupActor actor,
                                                                          int peerId,
                                                                          java.lang.Integer... conversationMessageIds)
        Returns messages by their IDs within the conversation.
        Parameters:
        actor - vk actor
        peerId - Destination ID. "For user: 'User ID', e.g. '12345'. For chat: '2000000000' + 'chat_id', e.g. '2000000001'. For community: '- community ID', e.g. '-12345'. "
        conversationMessageIds - Conversation message IDs.
        Returns:
        query

      • getByConversationMessageId

        public MessagesGetByConversationMessageIdQuery getByConversationMessageId​(GroupActor actor,
                                                                          int peerId,
                                                                          java.util.List<java.lang.Integer> conversationMessageIds)
        Returns messages by their IDs within the conversation.
        Parameters:
        actor - vk actor
        peerId - Destination ID. "For user: 'User ID', e.g. '12345'. For chat: '2000000000' + 'chat_id', e.g. '2000000001'. For community: '- community ID', e.g. '-12345'. "
        conversationMessageIds - Conversation message IDs.
        Returns:
        query

      • getById

        public MessagesGetByIdQuery getById​(UserActor actor,
                                    java.lang.Integer... messageIds)
        Returns messages by their IDs.
        Parameters:
        actor - vk actor
        messageIds - Message IDs.
        Returns:
        query

      • getById

        public MessagesGetByIdQuery getById​(UserActor actor,
                                    java.util.List<java.lang.Integer> messageIds)
        Returns messages by their IDs.
        Parameters:
        actor - vk actor
        messageIds - Message IDs.
        Returns:
        query

      • getById

        public MessagesGetByIdQuery getById​(GroupActor actor,
                                    java.lang.Integer... messageIds)
        Returns messages by their IDs.
        Parameters:
        actor - vk actor
        messageIds - Message IDs.
        Returns:
        query

      • getById

        public MessagesGetByIdQuery getById​(GroupActor actor,
                                    java.util.List<java.lang.Integer> messageIds)
        Returns messages by their IDs.
        Parameters:
        actor - vk actor
        messageIds - Message IDs.
        Returns:
        query

      • getByIdExtended

        public MessagesGetByIdQueryWithExtended getByIdExtended​(UserActor actor,
                                                        java.lang.Integer... messageIds)
        Returns messages by their IDs.
        Parameters:
        actor - vk actor
        messageIds - Message IDs.
        Returns:
        query

      • getByIdExtended

        public MessagesGetByIdQueryWithExtended getByIdExtended​(UserActor actor,
                                                        java.util.List<java.lang.Integer> messageIds)
        Returns messages by their IDs.
        Parameters:
        actor - vk actor
        messageIds - Message IDs.
        Returns:
        query

      • getByIdExtended

        public MessagesGetByIdQueryWithExtended getByIdExtended​(GroupActor actor,
                                                        java.lang.Integer... messageIds)
        Returns messages by their IDs.
        Parameters:
        actor - vk actor
        messageIds - Message IDs.
        Returns:
        query

      • getByIdExtended

        public MessagesGetByIdQueryWithExtended getByIdExtended​(GroupActor actor,
                                                        java.util.List<java.lang.Integer> messageIds)
        Returns messages by their IDs.
        Parameters:
        actor - vk actor
        messageIds - Message IDs.
        Returns:
        query

      • getConversationMembers

        public MessagesGetConversationMembersQuery getConversationMembers​(UserActor actor,
                                                                  int peerId)
        Returns a list of IDs of users participating in a chat.
        Parameters:
        actor - vk actor
        peerId - Peer ID.
        Returns:
        query

      • getConversationMembers

        public MessagesGetConversationMembersQuery getConversationMembers​(GroupActor actor,
                                                                  int peerId)
        Returns a list of IDs of users participating in a chat.
        Parameters:
        actor - vk actor
        peerId - Peer ID.
        Returns:
        query

      • getConversations

        public MessagesGetConversationsQuery getConversations​(UserActor actor)
        Returns a list of the current user's conversations.
        Parameters:
        actor - vk actor
        Returns:
        query

      • getConversationsById

        public MessagesGetConversationsByIdQuery getConversationsById​(UserActor actor,
                                                              java.lang.Integer... peerIds)
        Returns conversations by their IDs
        Parameters:
        actor - vk actor
        peerIds - Destination IDs. "For user: 'User ID', e.g. '12345'. For chat: '2000000000' + 'chat_id', e.g. '2000000001'. For community: '- community ID', e.g. '-12345'. "
        Returns:
        query

      • getConversationsById

        public MessagesGetConversationsByIdQuery getConversationsById​(UserActor actor,
                                                              java.util.List<java.lang.Integer> peerIds)
        Returns conversations by their IDs
        Parameters:
        actor - vk actor
        peerIds - Destination IDs. "For user: 'User ID', e.g. '12345'. For chat: '2000000000' + 'chat_id', e.g. '2000000001'. For community: '- community ID', e.g. '-12345'. "
        Returns:
        query

      • getConversationsById

        public MessagesGetConversationsByIdQuery getConversationsById​(GroupActor actor,
                                                              java.lang.Integer... peerIds)
        Returns conversations by their IDs
        Parameters:
        actor - vk actor
        peerIds - Destination IDs. "For user: 'User ID', e.g. '12345'. For chat: '2000000000' + 'chat_id', e.g. '2000000001'. For community: '- community ID', e.g. '-12345'. "
        Returns:
        query

      • getConversationsById

        public MessagesGetConversationsByIdQuery getConversationsById​(GroupActor actor,
                                                              java.util.List<java.lang.Integer> peerIds)
        Returns conversations by their IDs
        Parameters:
        actor - vk actor
        peerIds - Destination IDs. "For user: 'User ID', e.g. '12345'. For chat: '2000000000' + 'chat_id', e.g. '2000000001'. For community: '- community ID', e.g. '-12345'. "
        Returns:
        query

      • getConversationsByIdExtended

        public MessagesGetConversationsByIdQueryWithExtended getConversationsByIdExtended​(UserActor actor,
                                                                                  java.lang.Integer... peerIds)
        Returns conversations by their IDs
        Parameters:
        actor - vk actor
        peerIds - Destination IDs. "For user: 'User ID', e.g. '12345'. For chat: '2000000000' + 'chat_id', e.g. '2000000001'. For community: '- community ID', e.g. '-12345'. "
        Returns:
        query

      • getConversationsByIdExtended

        public MessagesGetConversationsByIdQueryWithExtended getConversationsByIdExtended​(UserActor actor,
                                                                                  java.util.List<java.lang.Integer> peerIds)
        Returns conversations by their IDs
        Parameters:
        actor - vk actor
        peerIds - Destination IDs. "For user: 'User ID', e.g. '12345'. For chat: '2000000000' + 'chat_id', e.g. '2000000001'. For community: '- community ID', e.g. '-12345'. "
        Returns:
        query

      • getConversationsByIdExtended

        public MessagesGetConversationsByIdQueryWithExtended getConversationsByIdExtended​(GroupActor actor,
                                                                                  java.lang.Integer... peerIds)
        Returns conversations by their IDs
        Parameters:
        actor - vk actor
        peerIds - Destination IDs. "For user: 'User ID', e.g. '12345'. For chat: '2000000000' + 'chat_id', e.g. '2000000001'. For community: '- community ID', e.g. '-12345'. "
        Returns:
        query

      • getConversationsByIdExtended

        public MessagesGetConversationsByIdQueryWithExtended getConversationsByIdExtended​(GroupActor actor,
                                                                                  java.util.List<java.lang.Integer> peerIds)
        Returns conversations by their IDs
        Parameters:
        actor - vk actor
        peerIds - Destination IDs. "For user: 'User ID', e.g. '12345'. For chat: '2000000000' + 'chat_id', e.g. '2000000001'. For community: '- community ID', e.g. '-12345'. "
        Returns:
        query

      • getHistory

        public MessagesGetHistoryQuery getHistory​(UserActor actor)
        Returns message history for the specified user or group chat.
        Parameters:
        actor - vk actor
        Returns:
        query

      • getHistory

        public MessagesGetHistoryQuery getHistory​(GroupActor actor)
        Returns message history for the specified user or group chat.
        Parameters:
        actor - vk actor
        Returns:
        query

      • getHistoryAttachments

        public MessagesGetHistoryAttachmentsQuery getHistoryAttachments​(UserActor actor,
                                                                int peerId)
        Returns media files from the dialog or group chat.
        Parameters:
        actor - vk actor
        peerId - Peer ID. ", For group chat: '2000000000 + chat ID' , , For community: '-community ID'"
        Returns:
        query

      • getHistoryAttachments

        public MessagesGetHistoryAttachmentsQuery getHistoryAttachments​(GroupActor actor,
                                                                int peerId)
        Returns media files from the dialog or group chat.
        Parameters:
        actor - vk actor
        peerId - Peer ID. ", For group chat: '2000000000 + chat ID' , , For community: '-community ID'"
        Returns:
        query

      • getLastActivity

        public MessagesGetLastActivityQuery getLastActivity​(UserActor actor,
                                                    int userId)
        Returns a user's current status and date of last activity.
        Parameters:
        actor - vk actor
        userId - User ID.
        Returns:
        query

      • getLongPollServer

        public MessagesGetLongPollServerQuery getLongPollServer​(UserActor actor)
        Returns data required for connection to a Long Poll server.
        Parameters:
        actor - vk actor
        Returns:
        query

      • getLongPollServer

        public MessagesGetLongPollServerQuery getLongPollServer​(GroupActor actor)
        Returns data required for connection to a Long Poll server.
        Parameters:
        actor - vk actor
        Returns:
        query

      • isMessagesFromGroupAllowed

        public MessagesIsMessagesFromGroupAllowedQuery isMessagesFromGroupAllowed​(UserActor actor,
                                                                          int groupId,
                                                                          int userId)
        Returns information whether sending messages from the community to current user is allowed.
        Parameters:
        actor - vk actor
        groupId - Group ID.
        userId - User ID.
        Returns:
        query

      • isMessagesFromGroupAllowed

        public MessagesIsMessagesFromGroupAllowedQuery isMessagesFromGroupAllowed​(GroupActor actor,
                                                                          int groupId,
                                                                          int userId)
        Returns information whether sending messages from the community to current user is allowed.
        Parameters:
        actor - vk actor
        groupId - Group ID.
        userId - User ID.
        Returns:
        query

      • markAsAnsweredConversation

        public MessagesMarkAsAnsweredConversationQuery markAsAnsweredConversation​(UserActor actor,
                                                                          int peerId)
        Marks and unmarks conversations as unanswered.
        Parameters:
        actor - vk actor
        peerId - ID of conversation to mark as important.
        Returns:
        query

      • markAsAnsweredConversation

        public MessagesMarkAsAnsweredConversationQuery markAsAnsweredConversation​(GroupActor actor,
                                                                          int peerId)
        Marks and unmarks conversations as unanswered.
        Parameters:
        actor - vk actor
        peerId - ID of conversation to mark as important.
        Returns:
        query

      • markAsImportant

        public MessagesMarkAsImportantQuery markAsImportant​(UserActor actor)
        Marks and unmarks messages as important (starred).
        Parameters:
        actor - vk actor
        Returns:
        query

      • markAsImportantConversation

        public MessagesMarkAsImportantConversationQuery markAsImportantConversation​(UserActor actor,
                                                                            int peerId)
        Marks and unmarks conversations as important.
        Parameters:
        actor - vk actor
        peerId - ID of conversation to mark as important.
        Returns:
        query

      • markAsImportantConversation

        public MessagesMarkAsImportantConversationQuery markAsImportantConversation​(GroupActor actor,
                                                                            int peerId)
        Marks and unmarks conversations as important.
        Parameters:
        actor - vk actor
        peerId - ID of conversation to mark as important.
        Returns:
        query

      • pin

        public MessagesPinQuery pin​(UserActor actor,
                            int peerId)
        Pin a message.
        Parameters:
        actor - vk actor
        peerId - Destination ID. "For user: 'User ID', e.g. '12345'. For chat: '2000000000' + 'Chat ID', e.g. '2000000001'. For community: '- Community ID', e.g. '-12345'. "
        Returns:
        query

      • pin

        public MessagesPinQuery pin​(GroupActor actor,
                            int peerId)
        Pin a message.
        Parameters:
        actor - vk actor
        peerId - Destination ID. "For user: 'User ID', e.g. '12345'. For chat: '2000000000' + 'Chat ID', e.g. '2000000001'. For community: '- Community ID', e.g. '-12345'. "
        Returns:
        query

      • removeChatUser

        public MessagesRemoveChatUserQuery removeChatUser​(UserActor actor,
                                                  int chatId)
        Allows the current user to leave a chat or, if the current user started the chat, allows the user to remove another user from the chat.
        Parameters:
        actor - vk actor
        chatId - Chat ID.
        Returns:
        query

      • removeChatUser

        public MessagesRemoveChatUserQuery removeChatUser​(GroupActor actor,
                                                  int chatId)
        Allows the current user to leave a chat or, if the current user started the chat, allows the user to remove another user from the chat.
        Parameters:
        actor - vk actor
        chatId - Chat ID.
        Returns:
        query

      • restore

        public MessagesRestoreQuery restore​(UserActor actor,
                                    int messageId)
        Restores a deleted message.
        Parameters:
        actor - vk actor
        messageId - ID of a previously-deleted message to restore.
        Returns:
        query

      • restore

        public MessagesRestoreQuery restore​(GroupActor actor,
                                    int messageId)
        Restores a deleted message.
        Parameters:
        actor - vk actor
        messageId - ID of a previously-deleted message to restore.
        Returns:
        query

      • search

        public MessagesSearchQuery search​(UserActor actor)
        Returns a list of the current user's private messages that match search criteria.
        Parameters:
        actor - vk actor
        Returns:
        query

      • search

        public MessagesSearchQuery search​(GroupActor actor)
        Returns a list of the current user's private messages that match search criteria.
        Parameters:
        actor - vk actor
        Returns:
        query

      • searchExtended

        public MessagesSearchQueryWithExtended searchExtended​(UserActor actor)
        Returns a list of the current user's private messages that match search criteria.
        Parameters:
        actor - vk actor
        Returns:
        query

      • searchExtended

        public MessagesSearchQueryWithExtended searchExtended​(GroupActor actor)
        Returns a list of the current user's private messages that match search criteria.
        Parameters:
        actor - vk actor
        Returns:
        query

      • searchConversations

        public MessagesSearchConversationsQuery searchConversations​(UserActor actor)
        Returns a list of the current user's conversations that match search criteria.
        Parameters:
        actor - vk actor
        Returns:
        query

      • searchConversations

        public MessagesSearchConversationsQuery searchConversations​(GroupActor actor)
        Returns a list of the current user's conversations that match search criteria.
        Parameters:
        actor - vk actor
        Returns:
        query

      • sendWithUserIds

        public MessagesSendQueryWithUserIds sendWithUserIds​(UserActor actor,
                                                    java.lang.Integer[] userIds)
        Sends a message.
        Parameters:
        actor - vk actor
        userIds - IDs of message recipients (if new conversation shall be started).
        Returns:
        query

      • sendWithUserIds

        public MessagesSendQueryWithUserIds sendWithUserIds​(GroupActor actor,
                                                    java.lang.Integer[] userIds)
        Sends a message.
        Parameters:
        actor - vk actor
        userIds - IDs of message recipients (if new conversation shall be started).
        Returns:
        query

      • sendMessageEventAnswer

        public MessagesSendMessageEventAnswerQuery sendMessageEventAnswer​(GroupActor actor,
                                                                  java.lang.String eventId,
                                                                  int userId,
                                                                  int peerId)
        Parameters:
        actor - vk actor
        eventId -
        userId -
        peerId -
        Returns:
        query

      • setActivity

        public MessagesSetActivityQuery setActivity​(UserActor actor)
        Changes the status of a user as typing in a conversation.
        Parameters:
        actor - vk actor
        Returns:
        query

      • setActivity

        public MessagesSetActivityQuery setActivity​(GroupActor actor)
        Changes the status of a user as typing in a conversation.
        Parameters:
        actor - vk actor
        Returns:
        query

      • setChatPhoto

        public MessagesSetChatPhotoQuery setChatPhoto​(UserActor actor,
                                              java.lang.String file)
        Sets a previously-uploaded picture as the cover picture of a chat.
        Parameters:
        actor - vk actor
        file - Upload URL from the 'response' field returned by the [vk.com/dev/photos.getChatUploadServer|photos.getChatUploadServer] method upon successfully uploading an image.
        Returns:
        query

      • setChatPhoto

        public MessagesSetChatPhotoQuery setChatPhoto​(GroupActor actor,
                                              java.lang.String file)
        Sets a previously-uploaded picture as the cover picture of a chat.
        Parameters:
        actor - vk actor
        file - Upload URL from the 'response' field returned by the [vk.com/dev/photos.getChatUploadServer|photos.getChatUploadServer] method upon successfully uploading an image.
        Returns:
        query