rooms.h

Go to the documentation of this file.

// THIS FILE IS GENERATED - ANY EDITS WILL BE OVERWRITTEN
 
#pragma once
 
#include <Quotient/events/roomevent.h>
#include <Quotient/events/stateevent.h>
#include <Quotient/jobs/basejob.h>
 
namespace Quotient {
 
//! \brief Get a single event by event ID.
//!
//! Get a single event based on `roomId/eventId`. You must have permission to
//! retrieve this event e.g. by being a member in the room for this event.
class QUOTIENT_API GetOneRoomEventJob : public BaseJob {
public:
    //! \param roomId
    //!   The ID of the room the event is in.
    //!
    //! \param eventId
    //!   The event ID to get.
    explicit GetOneRoomEventJob(const QString& roomId, const QString& eventId);
 
    //! \brief Construct a URL without creating a full-fledged job object
    //!
    //! This function can be used when a URL for GetOneRoomEventJob
    //! is necessary but the job itself isn't.
    static QUrl makeRequestUrl(const HomeserverData& hsData, const QString& roomId,
                               const QString& eventId);
 
    // Result properties
 
    //! The full event.
    RoomEventPtr event() { return fromJson<RoomEventPtr>(jsonData()); }
};
 
inline auto collectResponse(GetOneRoomEventJob* job) { return job->event(); }
 
//! \brief Get the state identified by the type and key.
//!
//! Looks up the contents of a state event in a room. If the user is
//! joined to the room then the state is taken from the current
//! state of the room. If the user has left the room then the state is
//! taken from the state of the room when they left.
class QUOTIENT_API GetRoomStateWithKeyJob : public BaseJob {
public:
    //! \param roomId
    //!   The room to look up the state in.
    //!
    //! \param eventType
    //!   The type of state to look up.
    //!
    //! \param stateKey
    //!   The key of the state to look up. Defaults to an empty string. When
    //!   an empty string, the trailing slash on this endpoint is optional.
    explicit GetRoomStateWithKeyJob(const QString& roomId, const QString& eventType,
                                    const QString& stateKey);
 
    //! \brief Construct a URL without creating a full-fledged job object
    //!
    //! This function can be used when a URL for GetRoomStateWithKeyJob
    //! is necessary but the job itself isn't.
    static QUrl makeRequestUrl(const HomeserverData& hsData, const QString& roomId,
                               const QString& eventType, const QString& stateKey);
 
    // Result properties
 
    //! The content of the state event.
    QJsonObject content() const { return fromJson<QJsonObject>(jsonData()); }
};
 
inline auto collectResponse(const GetRoomStateWithKeyJob* job) { return job->content(); }
 
//! \brief Get all state events in the current state of a room.
//!
//! Get the state events for the current state of a room.
class QUOTIENT_API GetRoomStateJob : public BaseJob {
public:
    //! \param roomId
    //!   The room to look up the state for.
    explicit GetRoomStateJob(const QString& roomId);
 
    //! \brief Construct a URL without creating a full-fledged job object
    //!
    //! This function can be used when a URL for GetRoomStateJob
    //! is necessary but the job itself isn't.
    static QUrl makeRequestUrl(const HomeserverData& hsData, const QString& roomId);
 
    // Result properties
 
    //! The current state of the room
    StateEvents events() { return fromJson<StateEvents>(jsonData()); }
};
 
inline auto collectResponse(GetRoomStateJob* job) { return job->events(); }
 
//! \brief Get the m.room.member events for the room.
//!
//! Get the list of members for this room.
class QUOTIENT_API GetMembersByRoomJob : public BaseJob {
public:
    //! \param roomId
    //!   The room to get the member events for.
    //!
    //! \param at
    //!   The point in time (pagination token) to return members for in the room.
    //!   This token can be obtained from a `prev_batch` token returned for
    //!   each room by the sync API. Defaults to the current state of the room,
    //!   as determined by the server.
    //!
    //! \param membership
    //!   The kind of membership to filter for. Defaults to no filtering if
    //!   unspecified. When specified alongside `not_membership`, the two
    //!   parameters create an 'or' condition: either the membership *is*
    //!   the same as `membership` **or** *is not* the same as `not_membership`.
    //!
    //! \param notMembership
    //!   The kind of membership to exclude from the results. Defaults to no
    //!   filtering if unspecified.
    explicit GetMembersByRoomJob(const QString& roomId, const QString& at = {},
                                 const QString& membership = {}, const QString& notMembership = {});
 
    //! \brief Construct a URL without creating a full-fledged job object
    //!
    //! This function can be used when a URL for GetMembersByRoomJob
    //! is necessary but the job itself isn't.
    static QUrl makeRequestUrl(const HomeserverData& hsData, const QString& roomId,
                               const QString& at = {}, const QString& membership = {},
                               const QString& notMembership = {});
 
    // Result properties
 
    StateEvents chunk() { return takeFromJson<StateEvents>("chunk"_L1); }
};
 
inline auto collectResponse(GetMembersByRoomJob* job) { return job->chunk(); }
 
//! \brief Gets the list of currently joined users and their profile data.
//!
//! This API returns a map of MXIDs to member info objects for members of the room. The current user
//! must be in the room for it to work, unless it is an Application Service in which case any of the
//! AS's users must be in the room. This API is primarily for Application Services and should be
//! faster to respond than `/members` as it can be implemented more efficiently on the server.
class QUOTIENT_API GetJoinedMembersByRoomJob : public BaseJob {
public:
    // Inner data structures
 
    struct QUOTIENT_API RoomMember {
        //! The display name of the user this object is representing.
        QString displayName{};
 
        //! The avatar of the user this object is representing, as an [`mxc://`
        //! URI](/client-server-api/#matrix-content-mxc-uris).
        QUrl avatarUrl{};
    };
 
    // Construction/destruction
 
    //! \param roomId
    //!   The room to get the members of.
    explicit GetJoinedMembersByRoomJob(const QString& roomId);
 
    //! \brief Construct a URL without creating a full-fledged job object
    //!
    //! This function can be used when a URL for GetJoinedMembersByRoomJob
    //! is necessary but the job itself isn't.
    static QUrl makeRequestUrl(const HomeserverData& hsData, const QString& roomId);
 
    // Result properties
 
    //! A map from user ID to a RoomMember object.
    QHash<UserId, RoomMember> joined() const
    {
        return loadFromJson<QHash<UserId, RoomMember>>("joined"_L1);
    }
};
 
inline auto collectResponse(const GetJoinedMembersByRoomJob* job) { return job->joined(); }
 
template <>
struct QUOTIENT_API JsonObjectConverter<GetJoinedMembersByRoomJob::RoomMember> {
    static void fillFrom(const QJsonObject& jo, GetJoinedMembersByRoomJob::RoomMember& result)
    {
        fillFromJson(jo.value("display_name"_L1), result.displayName);
        fillFromJson(jo.value("avatar_url"_L1), result.avatarUrl);
    }
};
 
} // namespace Quotient