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

#pragma once

#include "jobs/basejob.h"

#include "converters.h"

namespace QMatrixClient
{
    // Operations

    /// Informs the server that the user has started or stopped typing.
    /// 
    /// This tells the server that the user is typing for the next N
    /// milliseconds where N is the value specified in the ``timeout`` key.
    /// Alternatively, if ``typing`` is ``false``, it tells the server that the
    /// user has stopped typing.
    class SetTypingJob : public BaseJob
    {
        public:
            /*! Informs the server that the user has started or stopped typing.
             * \param userId 
             *   The user who has started to type.
             * \param roomId 
             *   The room in which the user is typing.
             * \param typing 
             *   Whether the user is typing or not. If ``false``, the ``timeout``
             *   key can be omitted.
             * \param timeout 
             *   The length of time in milliseconds to mark this user as typing.
             */
            explicit SetTypingJob(const QString& userId, const QString& roomId, bool typing, Omittable<int> timeout = none);
    };
} // namespace QMatrixClient