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 Updates a room's visibility in the application service's room |
12 | * directory. |
13 | * |
14 | * Updates the visibility of a given room on the application service's room |
15 | * directory. |
16 | * |
17 | * This API is similar to the room directory visibility API used by clients |
18 | * to update the homeserver's more general room directory. |
19 | * |
20 | * This API requires the use of an application service access token (`as_token`) |
21 | * instead of a typical client's access_token. This API cannot be invoked by |
22 | * users who are not identified as application services. |
23 | */ |
24 | class QUOTIENT_API UpdateAppserviceRoomDirectoryVisibilityJob : public BaseJob { |
25 | public: |
26 | /*! \brief Updates a room's visibility in the application service's room |
27 | * directory. |
28 | * |
29 | * \param networkId |
30 | * The protocol (network) ID to update the room list for. This would |
31 | * have been provided by the application service as being listed as |
32 | * a supported protocol. |
33 | * |
34 | * \param roomId |
35 | * The room ID to add to the directory. |
36 | * |
37 | * \param visibility |
38 | * Whether the room should be visible (public) in the directory |
39 | * or not (private). |
40 | */ |
41 | explicit UpdateAppserviceRoomDirectoryVisibilityJob( |
42 | const QString& networkId, const QString& roomId, |
43 | const QString& visibility); |
44 | }; |
45 | |
46 | } // namespace Quotient |
47 | |