aboutsummaryrefslogtreecommitdiff
path: root/lib/csapi/read_markers.h
blob: f19f46b0ae0e41c80e2330999f4473a5eeb24f06 (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
/******************************************************************************
 * THIS FILE IS GENERATED - ANY EDITS WILL BE OVERWRITTEN
 */

#pragma once

#include "jobs/basejob.h"


namespace QMatrixClient
{
    // Operations

    /// Set the position of the read marker for a room.
    ///
    /// Sets the position of the read marker for a given room, and optionally
    /// the read receipt's location.
    class SetReadMarkerJob : public BaseJob
    {
        public:
            /*! Set the position of the read marker for a room.
             * \param roomId
             *   The room ID to set the read marker in for the user.
             * \param mFullyRead
             *   The event ID the read marker should be located at. The
             *   event MUST belong to the room.
             * \param mRead
             *   The event ID to set the read receipt location at. This is
             *   equivalent to calling ``/receipt/m.read/$elsewhere:domain.com``
             *   and is provided here to save that extra call.
             */
            explicit SetReadMarkerJob(const QString& roomId, const QString& mFullyRead, const QString& mRead = {});
    };
} // namespace QMatrixClient