appservice_room_directory.h

Go to the documentation of this file.

// THIS FILE IS GENERATED - ANY EDITS WILL BE OVERWRITTEN
 
#pragma once
 
#include <Quotient/jobs/basejob.h>
 
namespace Quotient {
 
//! \brief 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 QUOTIENT_API UpdateAppserviceRoomDirectoryVisibilityJob : public BaseJob {
public:
    //! \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 UpdateAppserviceRoomDirectoryVisibilityJob(const QString& networkId,
                                                        const QString& roomId,
                                                        const QString& visibility);
};
 
} // namespace Quotient