1 | /****************************************************************************** |
2 | * THIS FILE IS GENERATED - ANY EDITS WILL BE OVERWRITTEN |
3 | */ |
4 | |
5 | #pragma once |
6 | |
7 | #include <Quotient/jobs/basejob.h> |
8 | |
9 | namespace Quotient { |
10 | |
11 | /*! \brief Informs the server that the user has started or stopped typing. |
12 | * |
13 | * This tells the server that the user is typing for the next N |
14 | * milliseconds where N is the value specified in the `timeout` key. |
15 | * Alternatively, if `typing` is `false`, it tells the server that the |
16 | * user has stopped typing. |
17 | */ |
18 | class QUOTIENT_API SetTypingJob : public BaseJob { |
19 | public: |
20 | /*! \brief Informs the server that the user has started or stopped typing. |
21 | * |
22 | * \param userId |
23 | * The user who has started to type. |
24 | * |
25 | * \param roomId |
26 | * The room in which the user is typing. |
27 | * |
28 | * \param typing |
29 | * Whether the user is typing or not. If `false`, the `timeout` |
30 | * key can be omitted. |
31 | * |
32 | * \param timeout |
33 | * The length of time in milliseconds to mark this user as typing. |
34 | */ |
35 | explicit SetTypingJob(const QString& userId, const QString& roomId, |
36 | bool typing, Omittable<int> timeout = none); |
37 | }; |
38 | |
39 | } // namespace Quotient |
40 | |