aboutsummaryrefslogtreecommitdiff
path: root/lib/csapi/room_send.h
blob: 38e246e1a31d367b86e5dd1982ce488b65acca6a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
/******************************************************************************
 * THIS FILE IS GENERATED - ANY EDITS WILL BE OVERWRITTEN
 */

#pragma once

#include "jobs/basejob.h"

#include <QtCore/QJsonObject>

namespace QMatrixClient {
    // Operations

    /// Send a message event to the given room.
    ///
    /// This endpoint is used to send a message event to a room. Message events
    /// allow access to historical events and pagination, making them suited
    /// for "once-off" activity in a room.
    ///
    /// The body of the request should be the content object of the event; the
    /// fields in this object will vary depending on the type of event. See
    /// `Room Events`_ for the m. event specification.
    class SendMessageJob : public BaseJob
    {
        public:
        /*! Send a message event to the given room.
         * \param roomId
         *   The room to send the event to.
         * \param eventType
         *   The type of event to send.
         * \param txnId
         *   The transaction ID for this event. Clients should generate an
         *   ID unique across requests with the same access token; it will be
         *   used by the server to ensure idempotency of requests.
         * \param body
         *   This endpoint is used to send a message event to a room. Message
         * events allow access to historical events and pagination, making them
         * suited for "once-off" activity in a room.
         *
         *   The body of the request should be the content object of the event;
         * the fields in this object will vary depending on the type of event.
         * See `Room Events`_ for the m. event specification.
         */
        explicit SendMessageJob(const QString& roomId, const QString& eventType,
                                const QString& txnId,
                                const QJsonObject& body = {});
        ~SendMessageJob() override;

        // Result properties

        /// A unique identifier for the event.
        const QString& eventId() const;

        protected:
        Status parseJson(const QJsonDocument& data) override;

        private:
        class Private;
        QScopedPointer<Private> d;
    };
} // namespace QMatrixClient