lib/csapi/list_joined_rooms.h


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

/******************************************************************************
 * THIS FILE IS GENERATED - ANY EDITS WILL BE OVERWRITTEN
 */

#pragma once

#include "jobs/basejob.h"

namespace Quotient {

/*! \brief Lists the user's current rooms.
 *
 * This API returns a list of the user's current rooms.
 */
class GetJoinedRoomsJob : public BaseJob {
public:
    /// Lists the user's current rooms.
    explicit GetJoinedRoomsJob();

    /*! \brief Construct a URL without creating a full-fledged job object
     *
     * This function can be used when a URL for GetJoinedRoomsJob
     * is necessary but the job itself isn't.
     */
    static QUrl makeRequestUrl(QUrl baseUrl);

    // Result properties

    /// The ID of each room in which the user has ``joined`` membership.
    QStringList joinedRooms() const
    {
        return loadFromJson<QStringList>("joined_rooms"_ls);
    }
};

} // namespace Quotient