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
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
|
/******************************************************************************
* THIS FILE IS GENERATED - ANY EDITS WILL BE OVERWRITTEN
*/
#pragma once
#include "csapi/definitions/third_party_signed.h"
#include "jobs/basejob.h"
namespace Quotient {
/*! \brief Start the requesting user participating in a particular room.
*
* *Note that this API requires a room ID, not alias.*
* ``/join/{roomIdOrAlias}`` *exists if you have a room alias.*
*
* This API starts a user participating in a particular room, if that user
* is allowed to participate in that room. After this call, the client is
* allowed to see all current state events in the room, and all subsequent
* events associated with the room until the user leaves the room.
*
* After a user has joined a room, the room will appear as an entry in the
* response of the |/initialSync|_ and |/sync|_ APIs.
*/
class JoinRoomByIdJob : public BaseJob {
public:
/*! \brief Start the requesting user participating in a particular room.
*
* \param roomId
* The room identifier (not alias) to join.
*
* \param thirdPartySigned
* If supplied, the homeserver must verify that it matches a pending
* ``m.room.third_party_invite`` event in the room, and perform
* key validity checking if required by the event.
*/
explicit JoinRoomByIdJob(
const QString& roomId,
const Omittable<ThirdPartySigned>& thirdPartySigned = none);
// Result properties
/// The joined room ID.
QString roomId() const { return loadFromJson<QString>("room_id"_ls); }
};
/*! \brief Start the requesting user participating in a particular room.
*
* *Note that this API takes either a room ID or alias, unlike*
* ``/room/{roomId}/join``.
*
* This API starts a user participating in a particular room, if that user
* is allowed to participate in that room. After this call, the client is
* allowed to see all current state events in the room, and all subsequent
* events associated with the room until the user leaves the room.
*
* After a user has joined a room, the room will appear as an entry in the
* response of the |/initialSync|_ and |/sync|_ APIs.
*/
class JoinRoomJob : public BaseJob {
public:
/*! \brief Start the requesting user participating in a particular room.
*
* \param roomIdOrAlias
* The room identifier or alias to join.
*
* \param serverName
* The servers to attempt to join the room through. One of the servers
* must be participating in the room.
*
* \param thirdPartySigned
* If a ``third_party_signed`` was supplied, the homeserver must verify
* that it matches a pending ``m.room.third_party_invite`` event in the
* room, and perform key validity checking if required by the event.
*/
explicit JoinRoomJob(
const QString& roomIdOrAlias, const QStringList& serverName = {},
const Omittable<ThirdPartySigned>& thirdPartySigned = none);
// Result properties
/// The joined room ID.
QString roomId() const { return loadFromJson<QString>("room_id"_ls); }
};
} // namespace Quotient
|
