Package com.vk.api.sdk.queries.messages

Class MessagesEditQuery

    • Constructor Detail

      • MessagesEditQuery

        public MessagesEditQuery​(VkApiClient client,
                         UserActor actor,
                         int peerId)
        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
        peerId - value of "peer id" parameter.

      • MessagesEditQuery

        public MessagesEditQuery​(VkApiClient client,
                         GroupActor actor,
                         int peerId)
        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
        peerId - value of "peer id" parameter.

    • Method Detail

      • peerId

        protected MessagesEditQuery peerId​(int value)
        Destination ID. "For user: 'User ID', e.g. '12345'. For chat: '2000000000' + 'chat_id', e.g. '2000000001'. For community: '- community ID', e.g. '-12345'. "
        Parameters:
        value - value of "peer id" parameter.
        Returns:
        a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

      • message

        public MessagesEditQuery message​(java.lang.String value)
        (Required if 'attachments' is not set.) Text of the message.
        Parameters:
        value - value of "message" parameter.
        Returns:
        a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

      • lat

        public MessagesEditQuery lat​(java.lang.Number value)
        Geographical latitude of a check-in, in degrees (from -90 to 90).
        Parameters:
        value - value of "lat" parameter.
        Returns:
        a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

      • lng

        public MessagesEditQuery lng​(java.lang.Number value)
        Geographical longitude of a check-in, in degrees (from -180 to 180).
        Parameters:
        value - value of "long" parameter.
        Returns:
        a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

      • attachment

        public MessagesEditQuery attachment​(java.lang.String value)
        (Required if 'message' is not set.) List of objects attached to the message, separated by commas, in the following format: "_", ' — Type of media attachment: 'photo' — photo, 'video' — video, 'audio' — audio, 'doc' — document, 'wall' — wall post, '' — ID of the media attachment owner. '' — media attachment ID. Example: "photo100172_166443618"
        Parameters:
        value - value of "attachment" parameter.
        Returns:
        a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

      • keepForwardMessages

        public MessagesEditQuery keepForwardMessages​(java.lang.Boolean value)
        '1' — to keep forwarded, messages.
        Parameters:
        value - value of "keep forward messages" parameter.
        Returns:
        a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

      • keepSnippets

        public MessagesEditQuery keepSnippets​(java.lang.Boolean value)
        '1' — to keep attached snippets.
        Parameters:
        value - value of "keep snippets" parameter.
        Returns:
        a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

      • groupId

        public MessagesEditQuery groupId​(java.lang.Integer value)
        Group ID (for group messages with user access token)
        Parameters:
        value - value of "group id" parameter. Minimum is 0.
        Returns:
        a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

      • dontParseLinks

        public MessagesEditQuery dontParseLinks​(java.lang.Boolean value)
        Set dont parse links
        Parameters:
        value - value of "dont parse links" parameter. By default false.
        Returns:
        a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

      • messageId

        public MessagesEditQuery messageId​(java.lang.Integer value)
        Set message id
        Parameters:
        value - value of "message id" parameter. Minimum is 0.
        Returns:
        a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

      • conversationMessageId

        public MessagesEditQuery conversationMessageId​(java.lang.Integer value)
        Set conversation message id
        Parameters:
        value - value of "conversation message id" parameter. Minimum is 0.
        Returns:
        a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

      • template

        public MessagesEditQuery template​(java.lang.String value)
        Set template
        Parameters:
        value - value of "template" parameter.
        Returns:
        a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

      • keyboard

        public MessagesEditQuery keyboard​(java.lang.String value)
        Set keyboard
        Parameters:
        value - value of "keyboard" parameter.
        Returns:
        a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.