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

Class MessagesSendQuery

    • Constructor Detail

      • MessagesSendQuery

        public MessagesSendQuery​(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

      • MessagesSendQuery

        public MessagesSendQuery​(VkApiClient client,
                         GroupActor 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 Detail

      • userId

        public MessagesSendQuery userId​(java.lang.Integer value)
        User ID (by default — current user).
        Parameters:
        value - value of "user id" parameter.
        Returns:
        a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

      • randomId

        public MessagesSendQuery randomId​(java.lang.Integer value)
        Unique identifier to avoid resending the message.
        Parameters:
        value - value of "random id" parameter.
        Returns:
        a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

      • peerId

        public MessagesSendQuery peerId​(java.lang.Integer 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.

      • domain

        public MessagesSendQuery domain​(java.lang.String value)
        User's short address (for example, 'illarionov').
        Parameters:
        value - value of "domain" parameter.
        Returns:
        a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

      • chatId

        public MessagesSendQuery chatId​(java.lang.Integer value)
        ID of conversation the message will relate to.
        Parameters:
        value - value of "chat id" parameter. Maximum is 100000000. Minimum is 0.
        Returns:
        a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

      • message

        public MessagesSendQuery 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 MessagesSendQuery 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 MessagesSendQuery 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 MessagesSendQuery 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.

      • replyTo

        public MessagesSendQuery replyTo​(java.lang.Integer value)
        Set reply to
        Parameters:
        value - value of "reply to" parameter.
        Returns:
        a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

      • forward

        public MessagesSendQuery forward​(Forward value)
        JSON describing the forwarded message or reply
        Parameters:
        value - value of "forward" parameter.
        Returns:
        a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

      • stickerId

        public MessagesSendQuery stickerId​(java.lang.Integer value)
        Sticker id.
        Parameters:
        value - value of "sticker id" parameter. Minimum is 0.
        Returns:
        a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

      • groupId

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

      • keyboard

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

      • template

        public MessagesSendQuery 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.

      • payload

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

      • contentSource

        public MessagesSendQuery contentSource​(java.lang.String value)
        JSON describing the content source in the message
        Parameters:
        value - value of "content source" parameter.
        Returns:
        a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

      • dontParseLinks

        public MessagesSendQuery 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.

      • disableMentions

        public MessagesSendQuery disableMentions​(java.lang.Boolean value)
        Set disable mentions
        Parameters:
        value - value of "disable mentions" parameter. By default false.
        Returns:
        a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

      • intent

        public MessagesSendQuery intent​(SendIntent value)
        Set intent
        Parameters:
        value - value of "intent" parameter. By default default.
        Returns:
        a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

      • subscribeId

        public MessagesSendQuery subscribeId​(java.lang.Integer value)
        Set subscribe id
        Parameters:
        value - value of "subscribe id" parameter. Maximum is 100. Minimum is 0.
        Returns:
        a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

      • peerIds

        public MessagesSendQuery peerIds​(java.lang.Integer... value)
        peer_ids IDs of message recipients. (See peer_id)
        Parameters:
        value - value of "peer ids" parameter.
        Returns:
        a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

      • peerIds

        public MessagesSendQuery peerIds​(java.util.List<java.lang.Integer> value)
        IDs of message recipients. (See peer_id)
        Parameters:
        value - value of "peer ids" parameter.
        Returns:
        a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

      • userIds

        public MessagesSendQuery userIds​(java.lang.Integer... value)
        user_ids IDs of message recipients (if new conversation shall be started).
        Parameters:
        value - value of "user ids" parameter.
        Returns:
        a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

      • userIds

        public MessagesSendQuery userIds​(java.util.List<java.lang.Integer> value)
        IDs of message recipients (if new conversation shall be started).
        Parameters:
        value - value of "user ids" parameter.
        Returns:
        a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

      • forwardMessages

        public MessagesSendQuery forwardMessages​(java.lang.Integer... value)
        forward_messages ID of forwarded messages, separated with a comma. Listed messages of the sender will be shown in the message body at the recipient's. Example: "123,431,544"
        Parameters:
        value - value of "forward messages" parameter.
        Returns:
        a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

      • forwardMessages

        public MessagesSendQuery forwardMessages​(java.util.List<java.lang.Integer> value)
        ID of forwarded messages, separated with a comma. Listed messages of the sender will be shown in the message body at the recipient's. Example: "123,431,544"
        Parameters:
        value - value of "forward messages" parameter.
        Returns:
        a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.