aboutsummaryrefslogtreecommitdiff
path: root/lib/csapi/wellknown.h
blob: 8615191ccbc77c998010c5d8caf49c233cfd9123 (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
42
43
44
45
/******************************************************************************
 * THIS FILE IS GENERATED - ANY EDITS WILL BE OVERWRITTEN
 */

#pragma once

#include "csapi/definitions/wellknown/full.h"

#include "jobs/basejob.h"

namespace Quotient {

/*! \brief Gets Matrix server discovery information about the domain.
 *
 * Gets discovery information about the domain. The file may include
 * additional keys, which MUST follow the Java package naming convention,
 * e.g. `com.example.myapp.property`. This ensures property names are
 * suitably namespaced for each application and reduces the risk of
 * clashes.
 *
 * Note that this endpoint is not necessarily handled by the homeserver,
 * but by another webserver, to be used for discovering the homeserver URL.
 */
class QUOTIENT_API GetWellknownJob : public BaseJob {
public:
    /// Gets Matrix server discovery information about the domain.
    explicit GetWellknownJob();

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

    // Result properties

    /// Server discovery information.
    DiscoveryInformation data() const
    {
        return fromJson<DiscoveryInformation>(jsonData());
    }
};

} // namespace Quotient