aboutsummaryrefslogtreecommitdiff
path: root/lib/csapi/account-data.h
diff options
context:
space:
mode:
Diffstat (limited to 'lib/csapi/account-data.h')
-rw-r--r--lib/csapi/account-data.h69
1 files changed, 35 insertions, 34 deletions
diff --git a/lib/csapi/account-data.h b/lib/csapi/account-data.h
index 0c760e80..70d4e492 100644
--- a/lib/csapi/account-data.h
+++ b/lib/csapi/account-data.h
@@ -8,46 +8,47 @@
namespace Quotient {
-/*! \brief Set some account_data for the user.
+/*! \brief Set some account data for the user.
*
- * Set some account_data for the client. This config is only visible to the user
- * that set the account_data. The config will be synced to clients in the
- * top-level `account_data`.
+ * Set some account data for the client. This config is only visible to the user
+ * that set the account data. The config will be available to clients through
+ * the top-level `account_data` field in the homeserver response to
+ * [/sync](#get_matrixclientv3sync).
*/
-class SetAccountDataJob : public BaseJob {
+class QUOTIENT_API SetAccountDataJob : public BaseJob {
public:
- /*! \brief Set some account_data for the user.
+ /*! \brief Set some account data for the user.
*
* \param userId
- * The ID of the user to set account_data for. The access token must be
+ * The ID of the user to set account data for. The access token must be
* authorized to make requests for this user ID.
*
* \param type
- * The event type of the account_data to set. Custom types should be
+ * The event type of the account data to set. Custom types should be
* namespaced to avoid clashes.
*
* \param content
- * The content of the account_data
+ * The content of the account data.
*/
explicit SetAccountDataJob(const QString& userId, const QString& type,
const QJsonObject& content = {});
};
-/*! \brief Get some account_data for the user.
+/*! \brief Get some account data for the user.
*
- * Get some account_data for the client. This config is only visible to the user
- * that set the account_data.
+ * Get some account data for the client. This config is only visible to the user
+ * that set the account data.
*/
-class GetAccountDataJob : public BaseJob {
+class QUOTIENT_API GetAccountDataJob : public BaseJob {
public:
- /*! \brief Get some account_data for the user.
+ /*! \brief Get some account data for the user.
*
* \param userId
- * The ID of the user to get account_data for. The access token must be
+ * The ID of the user to get account data for. The access token must be
* authorized to make requests for this user ID.
*
* \param type
- * The event type of the account_data to get. Custom types should be
+ * The event type of the account data to get. Custom types should be
* namespaced to avoid clashes.
*/
explicit GetAccountDataJob(const QString& userId, const QString& type);
@@ -61,53 +62,53 @@ public:
const QString& type);
};
-/*! \brief Set some account_data for the user.
+/*! \brief Set some account data for the user that is specific to a room.
*
- * Set some account_data for the client on a given room. This config is only
- * visible to the user that set the account_data. The config will be synced to
- * clients in the per-room `account_data`.
+ * Set some account data for the client on a given room. This config is only
+ * visible to the user that set the account data. The config will be delivered
+ * to clients in the per-room entries via [/sync](#get_matrixclientv3sync).
*/
-class SetAccountDataPerRoomJob : public BaseJob {
+class QUOTIENT_API SetAccountDataPerRoomJob : public BaseJob {
public:
- /*! \brief Set some account_data for the user.
+ /*! \brief Set some account data for the user that is specific to a room.
*
* \param userId
- * The ID of the user to set account_data for. The access token must be
+ * The ID of the user to set account data for. The access token must be
* authorized to make requests for this user ID.
*
* \param roomId
- * The ID of the room to set account_data on.
+ * The ID of the room to set account data on.
*
* \param type
- * The event type of the account_data to set. Custom types should be
+ * The event type of the account data to set. Custom types should be
* namespaced to avoid clashes.
*
* \param content
- * The content of the account_data
+ * The content of the account data.
*/
explicit SetAccountDataPerRoomJob(const QString& userId,
const QString& roomId, const QString& type,
const QJsonObject& content = {});
};
-/*! \brief Get some account_data for the user.
+/*! \brief Get some account data for the user that is specific to a room.
*
- * Get some account_data for the client on a given room. This config is only
- * visible to the user that set the account_data.
+ * Get some account data for the client on a given room. This config is only
+ * visible to the user that set the account data.
*/
-class GetAccountDataPerRoomJob : public BaseJob {
+class QUOTIENT_API GetAccountDataPerRoomJob : public BaseJob {
public:
- /*! \brief Get some account_data for the user.
+ /*! \brief Get some account data for the user that is specific to a room.
*
* \param userId
- * The ID of the user to set account_data for. The access token must be
+ * The ID of the user to get account data for. The access token must be
* authorized to make requests for this user ID.
*
* \param roomId
- * The ID of the room to get account_data for.
+ * The ID of the room to get account data for.
*
* \param type
- * The event type of the account_data to get. Custom types should be
+ * The event type of the account data to get. Custom types should be
* namespaced to avoid clashes.
*/
explicit GetAccountDataPerRoomJob(const QString& userId,