Merge branch 'cs-api-0.4.0'

1 files changed, 11 insertions, 8 deletions

diff --git a/lib/csapi/filter.h b/lib/csapi/filter.h
index 87583a59..0ca7e953 100644
--- a/lib/csapi/filter.h
+++ b/lib/csapi/filter.h
@@ -14,7 +14,7 @@ namespace QMatrixClient
     // Operations
 
     /// Upload a new filter.
-    /// 
+    ///
     /// Uploads a new filter definition to the homeserver.
     /// Returns a filter ID that may be used in future requests to
     /// restrict which events are returned to the client.
@@ -22,19 +22,22 @@ namespace QMatrixClient
     {
         public:
             /*! Upload a new filter.
-             * \param userId 
+             * \param userId
              *   The id of the user uploading the filter. The access token must be authorized to make requests for this user id.
-             * \param filter 
+             * \param filter
              *   Uploads a new filter definition to the homeserver.
              *   Returns a filter ID that may be used in future requests to
              *   restrict which events are returned to the client.
              */
-            explicit DefineFilterJob(const QString& userId, const SyncFilter& filter);
+            explicit DefineFilterJob(const QString& userId, const Filter& filter);
             ~DefineFilterJob() override;
 
             // Result properties
 
-            /// The ID of the filter that was created.
+            /// The ID of the filter that was created. Cannot start
+            /// with a ``{`` as this character is used to determine
+            /// if the filter provided is inline JSON or a previously
+            /// declared filter by homeservers on some APIs.
             const QString& filterId() const;
 
         protected:
@@ -50,9 +53,9 @@ namespace QMatrixClient
     {
         public:
             /*! Download a filter
-             * \param userId 
+             * \param userId
              *   The user ID to download a filter for.
-             * \param filterId 
+             * \param filterId
              *   The filter ID to download.
              */
             explicit GetFilterJob(const QString& userId, const QString& filterId);
@@ -70,7 +73,7 @@ namespace QMatrixClient
             // Result properties
 
             /// "The filter defintion"
-            const SyncFilter& data() const;
+            const Filter& data() const;
 
         protected:
             Status parseJson(const QJsonDocument& data) override;