aboutsummaryrefslogtreecommitdiff
path: root/lib/csapi/appservice_room_directory.h
blob: f35198b36b3b7016d20d0d3a6bb54eecd8e32685 (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
38
39
40
41
/******************************************************************************
 * THIS FILE IS GENERATED - ANY EDITS WILL BE OVERWRITTEN
 */

#pragma once

#include "jobs/basejob.h"


namespace QMatrixClient
{
    // Operations

    /// Updates a room's visibility in the application service's room directory.
    ///
    /// Updates the visibility of a given room on the application service's room
    /// directory.
    /// 
    /// This API is similar to the room directory visibility API used by clients
    /// to update the homeserver's more general room directory.
    /// 
    /// This API requires the use of an application service access token (``as_token``)
    /// instead of a typical client's access_token. This API cannot be invoked by
    /// users who are not identified as application services.
    class UpdateAppserviceRoomDirectoryVsibilityJob : public BaseJob
    {
        public:
            /*! Updates a room's visibility in the application service's room directory.
             * \param networkId
             *   The protocol (network) ID to update the room list for. This would
             *   have been provided by the application service as being listed as
             *   a supported protocol.
             * \param roomId
             *   The room ID to add to the directory.
             * \param visibility
             *   Whether the room should be visible (public) in the directory
             *   or not (private).
             */
            explicit UpdateAppserviceRoomDirectoryVsibilityJob(const QString& networkId, const QString& roomId, const QString& visibility);
    };
} // namespace QMatrixClient