diff options
| -rw-r--r-- | lib/csapi/admin.h | 10 | ||||
| -rw-r--r-- | lib/csapi/administrative_contact.h | 10 | ||||
| -rw-r--r-- | lib/csapi/create_room.h | 12 | ||||
| -rw-r--r-- | lib/csapi/joining.h | 18 | ||||
| -rw-r--r-- | lib/csapi/keys.h | 8 | ||||
| -rw-r--r-- | lib/csapi/list_public_rooms.h | 48 | ||||
| -rw-r--r-- | lib/csapi/login.h | 4 | ||||
| -rw-r--r-- | lib/csapi/notifications.h | 18 | ||||
| -rw-r--r-- | lib/csapi/pusher.h | 42 | ||||
| -rw-r--r-- | lib/csapi/rooms.h | 4 | ||||
| -rw-r--r-- | lib/csapi/search.h | 126 | ||||
| -rw-r--r-- | lib/csapi/users.h | 6 | ||||
| -rw-r--r-- | lib/csapi/{{base}}.h.mustache | 2 |
13 files changed, 154 insertions, 154 deletions
diff --git a/lib/csapi/admin.h b/lib/csapi/admin.h index b1b23ded..a0c43fb9 100644 --- a/lib/csapi/admin.h +++ b/lib/csapi/admin.h @@ -33,11 +33,11 @@ namespace QMatrixClient /// specified in this document. struct ConnectionInfo { - /// Most recently seen IP address of the session. + /// Most recently seen IP address of the session. QString ip; - /// Unix timestamp that the session was last active. + /// Unix timestamp that the session was last active. Omittable<qint64> lastSeen; - /// User agent string last seen in the session. + /// User agent string last seen in the session. QString userAgent; }; @@ -48,7 +48,7 @@ namespace QMatrixClient /// specified in this document. struct SessionInfo { - /// Information particular connections in the session. + /// Information particular connections in the session. QVector<ConnectionInfo> connections; }; @@ -59,7 +59,7 @@ namespace QMatrixClient /// specified in this document. struct DeviceInfo { - /// A user's sessions (i.e. what they did with an access token from one login). + /// A user's sessions (i.e. what they did with an access token from one login). QVector<SessionInfo> sessions; }; diff --git a/lib/csapi/administrative_contact.h b/lib/csapi/administrative_contact.h index b9a5ee4b..decf7e3c 100644 --- a/lib/csapi/administrative_contact.h +++ b/lib/csapi/administrative_contact.h @@ -38,9 +38,9 @@ namespace QMatrixClient /// identifiers that it will accept to reset the user's account password. struct ThirdPartyIdentifier { - /// The medium of the third party identifier. + /// The medium of the third party identifier. QString medium; - /// The third party identifier address. + /// The third party identifier address. QString address; }; @@ -89,11 +89,11 @@ namespace QMatrixClient /// The third party credentials to associate with the account. struct ThreePidCredentials { - /// The client secret used in the session with the Identity Server. + /// The client secret used in the session with the Identity Server. QString clientSecret; - /// The Identity Server to use. + /// The Identity Server to use. QString idServer; - /// The session identifier given by the Identity Server. + /// The session identifier given by the Identity Server. QString sid; }; diff --git a/lib/csapi/create_room.h b/lib/csapi/create_room.h index ee09fb35..79ea2385 100644 --- a/lib/csapi/create_room.h +++ b/lib/csapi/create_room.h @@ -77,11 +77,11 @@ namespace QMatrixClient /// ======================== ============== ====================== ================ ========= struct Invite3pid { - /// The hostname+port of the identity server which should be used for third party identifier lookups. + /// The hostname+port of the identity server which should be used for third party identifier lookups. QString idServer; - /// The kind of address being passed in the address field, for example ``email``. + /// The kind of address being passed in the address field, for example ``email``. QString medium; - /// The invitee's third party identifier. + /// The invitee's third party identifier. QString address; }; @@ -114,11 +114,11 @@ namespace QMatrixClient /// ======================== ============== ====================== ================ ========= struct StateEvent { - /// The type of event to send. + /// The type of event to send. QString type; - /// The state_key of the state event. Defaults to an empty string. + /// The state_key of the state event. Defaults to an empty string. QString stateKey; - /// The content of the event. + /// The content of the event. QJsonObject content; }; diff --git a/lib/csapi/joining.h b/lib/csapi/joining.h index 67dce4c9..a73b1896 100644 --- a/lib/csapi/joining.h +++ b/lib/csapi/joining.h @@ -36,13 +36,13 @@ namespace QMatrixClient /// A signature of an ``m.third_party_invite`` token to prove that this user owns a third party identity which has been invited to the room. struct ThirdPartySigned { - /// The Matrix ID of the user who issued the invite. + /// The Matrix ID of the user who issued the invite. QString sender; - /// The Matrix ID of the invitee. + /// The Matrix ID of the invitee. QString mxid; - /// The state key of the m.third_party_invite event. + /// The state key of the m.third_party_invite event. QString token; - /// A signatures object containing a signature of the entire signed object. + /// A signatures object containing a signature of the entire signed object. QJsonObject signatures; }; @@ -105,20 +105,20 @@ namespace QMatrixClient /// room, and perform key validity checking if required by the event. struct Signed { - /// The Matrix ID of the user who issued the invite. + /// The Matrix ID of the user who issued the invite. QString sender; - /// The Matrix ID of the invitee. + /// The Matrix ID of the invitee. QString mxid; - /// The state key of the m.third_party_invite event. + /// The state key of the m.third_party_invite event. QString token; - /// A signatures object containing a signature of the entire signed object. + /// A signatures object containing a signature of the entire signed object. QJsonObject signatures; }; /// A signature of an ``m.third_party_invite`` token to prove that this user owns a third party identity which has been invited to the room. struct ThirdPartySigned { - /// A signature of an ``m.third_party_invite`` token to prove that this user owns a third party identity which has been invited to the room. + /// A signature of an ``m.third_party_invite`` token to prove that this user owns a third party identity which has been invited to the room. Signed signedData; }; diff --git a/lib/csapi/keys.h b/lib/csapi/keys.h index 1384faf8..1842b943 100644 --- a/lib/csapi/keys.h +++ b/lib/csapi/keys.h @@ -64,16 +64,16 @@ namespace QMatrixClient /// signatures. struct UnsignedDeviceInfo { - /// The display name which the user set on the device. + /// The display name which the user set on the device. QString deviceDisplayName; }; /// Returns the current devices and identity keys for the given users. struct DeviceInformation : DeviceKeys { - /// Additional data added to the device key information - /// by intermediate servers, and not covered by the - /// signatures. + /// Additional data added to the device key information + /// by intermediate servers, and not covered by the + /// signatures. Omittable<UnsignedDeviceInfo> unsignedData; }; diff --git a/lib/csapi/list_public_rooms.h b/lib/csapi/list_public_rooms.h index 6e8eb7b3..e955f8e5 100644 --- a/lib/csapi/list_public_rooms.h +++ b/lib/csapi/list_public_rooms.h @@ -86,25 +86,25 @@ namespace QMatrixClient /// of joined members, with the largest rooms first. struct PublicRoomsChunk { - /// Aliases of the room. May be empty. + /// Aliases of the room. May be empty. QStringList aliases; - /// The canonical alias of the room, if any. + /// The canonical alias of the room, if any. QString canonicalAlias; - /// The name of the room, if any. + /// The name of the room, if any. QString name; - /// The number of members joined to the room. + /// The number of members joined to the room. qint64 numJoinedMembers; - /// The ID of the room. + /// The ID of the room. QString roomId; - /// The topic of the room, if any. + /// The topic of the room, if any. QString topic; - /// Whether the room may be viewed by guest users without joining. + /// Whether the room may be viewed by guest users without joining. bool worldReadable; - /// Whether guest users may join the room and participate in it. - /// If they can, they will be subject to ordinary power level - /// rules like any other user. + /// Whether guest users may join the room and participate in it. + /// If they can, they will be subject to ordinary power level + /// rules like any other user. bool guestCanJoin; - /// The URL for the room's avatar, if one is set. + /// The URL for the room's avatar, if one is set. QString avatarUrl; }; @@ -172,8 +172,8 @@ namespace QMatrixClient /// Filter to apply to the results. struct Filter { - /// A string to search for in the room metadata, e.g. name, - /// topic, canonical alias etc. (Optional). + /// A string to search for in the room metadata, e.g. name, + /// topic, canonical alias etc. (Optional). QString genericSearchTerm; }; @@ -183,25 +183,25 @@ namespace QMatrixClient /// of joined members, with the largest rooms first. struct PublicRoomsChunk { - /// Aliases of the room. May be empty. + /// Aliases of the room. May be empty. QStringList aliases; - /// The canonical alias of the room, if any. + /// The canonical alias of the room, if any. QString canonicalAlias; - /// The name of the room, if any. + /// The name of the room, if any. QString name; - /// The number of members joined to the room. + /// The number of members joined to the room. qint64 numJoinedMembers; - /// The ID of the room. + /// The ID of the room. QString roomId; - /// The topic of the room, if any. + /// The topic of the room, if any. QString topic; - /// Whether the room may be viewed by guest users without joining. + /// Whether the room may be viewed by guest users without joining. bool worldReadable; - /// Whether guest users may join the room and participate in it. - /// If they can, they will be subject to ordinary power level - /// rules like any other user. + /// Whether guest users may join the room and participate in it. + /// If they can, they will be subject to ordinary power level + /// rules like any other user. bool guestCanJoin; - /// The URL for the room's avatar, if one is set. + /// The URL for the room's avatar, if one is set. QString avatarUrl; }; diff --git a/lib/csapi/login.h b/lib/csapi/login.h index 31d4dc64..57113813 100644 --- a/lib/csapi/login.h +++ b/lib/csapi/login.h @@ -26,8 +26,8 @@ namespace QMatrixClient /// should pick one of these and supply it as the ``type`` when logging in. struct LoginFlow { - /// The login type. This is supplied as the ``type`` when - /// logging in. + /// The login type. This is supplied as the ``type`` when + /// logging in. QString type; }; diff --git a/lib/csapi/notifications.h b/lib/csapi/notifications.h index 25db7052..4edb9c3e 100644 --- a/lib/csapi/notifications.h +++ b/lib/csapi/notifications.h @@ -29,20 +29,20 @@ namespace QMatrixClient /// user has been, or would have been notified about. struct Notification { - /// The action(s) to perform when the conditions for this rule are met. - /// See `Push Rules: API`_. + /// The action(s) to perform when the conditions for this rule are met. + /// See `Push Rules: API`_. QVector<QVariant> actions; - /// The Event object for the event that triggered the notification. + /// The Event object for the event that triggered the notification. EventPtr event; - /// The profile tag of the rule that matched this event. + /// The profile tag of the rule that matched this event. QString profileTag; - /// Indicates whether the user has sent a read receipt indicating - /// that they have read this message. + /// Indicates whether the user has sent a read receipt indicating + /// that they have read this message. bool read; - /// The ID of the room in which the event was posted. + /// The ID of the room in which the event was posted. QString roomId; - /// The unix timestamp at which the event notification was sent, - /// in milliseconds. + /// The unix timestamp at which the event notification was sent, + /// in milliseconds. qint64 ts; }; diff --git a/lib/csapi/pusher.h b/lib/csapi/pusher.h index 34423dde..2d192669 100644 --- a/lib/csapi/pusher.h +++ b/lib/csapi/pusher.h @@ -25,38 +25,38 @@ namespace QMatrixClient /// itself. struct PusherData { - /// Required if ``kind`` is ``http``. The URL to use to send - /// notifications to. + /// Required if ``kind`` is ``http``. The URL to use to send + /// notifications to. QString url; }; /// Gets all currently active pushers for the authenticated user struct Pusher { - /// This is a unique identifier for this pusher. See `/set` for - /// more detail. - /// Max length, 512 bytes. + /// This is a unique identifier for this pusher. See `/set` for + /// more detail. + /// Max length, 512 bytes. QString pushkey; - /// The kind of pusher. ``"http"`` is a pusher that - /// sends HTTP pokes. + /// The kind of pusher. ``"http"`` is a pusher that + /// sends HTTP pokes. QString kind; - /// This is a reverse-DNS style identifier for the application. - /// Max length, 64 chars. + /// This is a reverse-DNS style identifier for the application. + /// Max length, 64 chars. QString appId; - /// A string that will allow the user to identify what application - /// owns this pusher. + /// A string that will allow the user to identify what application + /// owns this pusher. QString appDisplayName; - /// A string that will allow the user to identify what device owns - /// this pusher. + /// A string that will allow the user to identify what device owns + /// this pusher. QString deviceDisplayName; - /// This string determines which set of device specific rules this - /// pusher executes. + /// This string determines which set of device specific rules this + /// pusher executes. QString profileTag; - /// The preferred language for receiving notifications (e.g. 'en' - /// or 'en-US') + /// The preferred language for receiving notifications (e.g. 'en' + /// or 'en-US') QString lang; - /// A dictionary of information for the pusher implementation - /// itself. + /// A dictionary of information for the pusher implementation + /// itself. Omittable<PusherData> data; }; @@ -102,8 +102,8 @@ namespace QMatrixClient /// which is the URL to use to send notifications to. struct PusherData { - /// Required if ``kind`` is ``http``. The URL to use to send - /// notifications to. + /// Required if ``kind`` is ``http``. The URL to use to send + /// notifications to. QString url; }; diff --git a/lib/csapi/rooms.h b/lib/csapi/rooms.h index 5b09f43f..8d508e94 100644 --- a/lib/csapi/rooms.h +++ b/lib/csapi/rooms.h @@ -221,9 +221,9 @@ namespace QMatrixClient /// 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. struct RoomMember { - /// The display name of the user this object is representing. + /// The display name of the user this object is representing. QString displayName; - /// The mxc avatar url of the user this object is representing. + /// The mxc avatar url of the user this object is representing. QString avatarUrl; }; diff --git a/lib/csapi/search.h b/lib/csapi/search.h index e1995cff..6cb0ac19 100644 --- a/lib/csapi/search.h +++ b/lib/csapi/search.h @@ -29,23 +29,23 @@ namespace QMatrixClient /// returned are included in the response. struct IncludeEventContext { - /// How many events before the result are - /// returned. By default, this is ``5``. + /// How many events before the result are + /// returned. By default, this is ``5``. Omittable<int> beforeLimit; - /// How many events after the result are - /// returned. By default, this is ``5``. + /// How many events after the result are + /// returned. By default, this is ``5``. Omittable<int> afterLimit; - /// Requests that the server returns the - /// historic profile information for the users - /// that sent the events that were returned. - /// By default, this is ``false``. + /// Requests that the server returns the + /// historic profile information for the users + /// that sent the events that were returned. + /// By default, this is ``false``. bool includeProfile; }; /// Configuration for group. struct Group { - /// Key that defines the group. + /// Key that defines the group. QString key; }; @@ -53,128 +53,128 @@ namespace QMatrixClient /// based on the provided list of keys. struct Groupings { - /// List of groups to request. + /// List of groups to request. QVector<Group> groupBy; }; /// Mapping of category name to search criteria. struct RoomEventsCriteria { - /// The string to search events for + /// The string to search events for QString searchTerm; - /// The keys to search. Defaults to all. + /// The keys to search. Defaults to all. QStringList keys; - /// This takes a `filter`_. + /// This takes a `filter`_. QJsonObject filter; - /// The order in which to search for results. - /// By default, this is ``"rank"``. + /// The order in which to search for results. + /// By default, this is ``"rank"``. QString orderBy; - /// Configures whether any context for the events - /// returned are included in the response. + /// Configures whether any context for the events + /// returned are included in the response. Omittable<IncludeEventContext> eventContext; - /// Requests the server return the current state for - /// each room returned. + /// Requests the server return the current state for + /// each room returned. bool includeState; - /// Requests that the server partitions the result set - /// based on the provided list of keys. + /// Requests that the server partitions the result set + /// based on the provided list of keys. Omittable<Groupings> groupings; }; /// Describes which categories to search in and their criteria. struct Categories { - /// Mapping of category name to search criteria. + /// Mapping of category name to search criteria. Omittable<RoomEventsCriteria> roomEvents; }; /// Performs a full text search across different categories. struct UserProfile { - /// Performs a full text search across different categories. + /// Performs a full text search across different categories. QString displayname; - /// Performs a full text search across different categories. + /// Performs a full text search across different categories. QString avatarUrl; }; /// Context for result, if requested. struct EventContext { - /// Pagination token for the start of the chunk + /// Pagination token for the start of the chunk QString begin; - /// Pagination token for the end of the chunk + /// Pagination token for the end of the chunk QString end; - /// The historic profile information of the - /// users that sent the events returned. - /// - /// The ``string`` key is the user ID for which - /// the profile belongs to. + /// The historic profile information of the + /// users that sent the events returned. + /// + /// The ``string`` key is the user ID for which + /// the profile belongs to. QHash<QString, UserProfile> profileInfo; - /// Events just before the result. + /// Events just before the result. RoomEvents eventsBefore; - /// Events just after the result. + /// Events just after the result. RoomEvents eventsAfter; }; /// The result object. struct Result { - /// A number that describes how closely this result matches the search. Higher is closer. + /// A number that describes how closely this result matches the search. Higher is closer. Omittable<double> rank; - /// The event that matched. + /// The event that matched. RoomEventPtr result; - /// Context for result, if requested. + /// Context for result, if requested. Omittable<EventContext> context; }; /// The results for a particular group value. struct GroupValue { - /// Token that can be used to get the next batch - /// of results in the group, by passing as the - /// `next_batch` parameter to the next call. If - /// this field is absent, there are no more - /// results in this group. + /// Token that can be used to get the next batch + /// of results in the group, by passing as the + /// `next_batch` parameter to the next call. If + /// this field is absent, there are no more + /// results in this group. QString nextBatch; - /// Key that can be used to order different - /// groups. + /// Key that can be used to order different + /// groups. Omittable<int> order; - /// Which results are in this group. + /// Which results are in this group. QStringList results; }; /// Mapping of category name to search criteria. struct ResultRoomEvents { - /// An approximate count of the total number of results found. + /// An approximate count of the total number of results found. Omittable<qint64> count; - /// List of words which should be highlighted, useful for stemming which may change the query terms. + /// List of words which should be highlighted, useful for stemming which may change the query terms. QStringList highlights; - /// List of results in the requested order. + /// List of results in the requested order. std::vector<Result> results; - /// The current state for every room in the results. - /// This is included if the request had the - /// ``include_state`` key set with a value of ``true``. - /// - /// The ``string`` key is the room ID for which the ``State - /// Event`` array belongs to. + /// The current state for every room in the results. + /// This is included if the request had the + /// ``include_state`` key set with a value of ``true``. + /// + /// The ``string`` key is the room ID for which the ``State + /// Event`` array belongs to. std::unordered_map<QString, StateEvents> state; - /// Any groups that were requested. - /// - /// The outer ``string`` key is the group key requested (eg: ``room_id`` - /// or ``sender``). The inner ``string`` key is the grouped value (eg: - /// a room's ID or a user's ID). + /// Any groups that were requested. + /// + /// The outer ``string`` key is the group key requested (eg: ``room_id`` + /// or ``sender``). The inner ``string`` key is the grouped value (eg: + /// a room's ID or a user's ID). QHash<QString, QHash<QString, GroupValue>> groups; - /// Token that can be used to get the next batch of - /// results, by passing as the `next_batch` parameter to - /// the next call. If this field is absent, there are no - /// more results. + /// Token that can be used to get the next batch of + /// results, by passing as the `next_batch` parameter to + /// the next call. If this field is absent, there are no + /// more results. QString nextBatch; }; /// Describes which categories to search in and their criteria. struct ResultCategories { - /// Mapping of category name to search criteria. + /// Mapping of category name to search criteria. Omittable<ResultRoomEvents> roomEvents; }; diff --git a/lib/csapi/users.h b/lib/csapi/users.h index 178d5c21..3ff10db6 100644 --- a/lib/csapi/users.h +++ b/lib/csapi/users.h @@ -26,11 +26,11 @@ namespace QMatrixClient /// It searches user ID and displayname case-insensitively for users that you share a room with or that are in public rooms. struct User { - /// The user's matrix user ID. + /// The user's matrix user ID. QString userId; - /// The display name of the user, if one exists. + /// The display name of the user, if one exists. QString displayName; - /// The avatar url, as an MXC, if one exists. + /// The avatar url, as an MXC, if one exists. QString avatarUrl; }; diff --git a/lib/csapi/{{base}}.h.mustache b/lib/csapi/{{base}}.h.mustache index 38d80669..1e7c0132 100644 --- a/lib/csapi/{{base}}.h.mustache +++ b/lib/csapi/{{base}}.h.mustache @@ -38,7 +38,7 @@ namespace QMatrixClient /// {{_}}{{/description}} struct {{name}}{{#parents?}} : {{#parents}}{{name}}{{>cjoin}}{{/parents}}{{/parents?}} { -{{#vars}}{{#description}} /// {{_}} +{{#vars}}{{#description}} /// {{_}} {{/description}} {{>maybeOmittableType}} {{nameCamelCase}}; {{/vars}} }; {{/ model}} |