aboutsummaryrefslogtreecommitdiff
path: root/lib/csapi/search.h
blob: 206bacca4af7fbc102d98f54d8c7634bb45937fd (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
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
/******************************************************************************
 * THIS FILE IS GENERATED - ANY EDITS WILL BE OVERWRITTEN
 */

#pragma once

#include "jobs/basejob.h"

#include <unordered_map>
#include <QtCore/QHash>
#include <QtCore/QJsonObject>
#include "events/event.h"
#include "converters.h"
#include <QtCore/QVector>

namespace QMatrixClient
{
    // Operations

    class SearchJob : public BaseJob
    {
        public:
            // Inner data structures

            struct IncludeEventContext
            {
                Omittable<int> beforeLimit;
                Omittable<int> afterLimit;
                bool includeProfile;
            };

            struct Group
            {
                QString key;
            };

            struct Groupings
            {
                QVector<Group> groupBy;
            };

            struct RoomEventsCriteria
            {
                QString searchTerm;
                QStringList keys;
                QJsonObject filter;
                QString orderBy;
                Omittable<IncludeEventContext> eventContext;
                bool includeState;
                Omittable<Groupings> groupings;
            };

            struct Categories
            {
                Omittable<RoomEventsCriteria> roomEvents;
            };

            struct UserProfile
            {
                QString displayname;
                QString avatarUrl;
            };

            struct EventContext
            {
                QString begin;
                QString end;
                QHash<QString, UserProfile> profileInfo;
                RoomEvents eventsBefore;
                RoomEvents eventsAfter;
            };

            struct Result
            {
                Omittable<double> rank;
                RoomEventPtr result;
                Omittable<EventContext> context;
            };

            struct GroupValue
            {
                QString nextBatch;
                Omittable<int> order;
                QStringList results;
            };

            struct ResultRoomEvents
            {
                Omittable<qint64> count;
                std::vector<Result> results;
                std::unordered_map<QString, StateEvents> state;
                QHash<QString, QHash<QString, GroupValue>> groups;
                QString nextBatch;
            };

            struct ResultCategories
            {
                Omittable<ResultRoomEvents> roomEvents;
            };

            // Construction/destruction

            explicit SearchJob(const Categories& searchCategories, const QString& nextBatch = {});
            ~SearchJob() override;

            // Result properties

            const ResultCategories& searchCategories() const;

        protected:
            Status parseJson(const QJsonDocument& data) override;

        private:
            class Private;
            QScopedPointer<Private> d;
    };
} // namespace QMatrixClient