aboutsummaryrefslogtreecommitdiff
path: root/lib/csapi/device_management.h
diff options
context:
space:
mode:
authorKitsune Ral <Kitsune-Ral@users.sf.net>2018-09-24 19:20:10 +0900
committerKitsune Ral <Kitsune-Ral@users.sf.net>2018-09-29 21:59:39 +0900
commit4244cee8d5e0f760cccd2b45ad587670573ef03c (patch)
tree4806108543f1402247e6cce1dba987a98d6fe83b /lib/csapi/device_management.h
parentf5c2e47fa1ab84fdaffe03c30ba973d7dea5ac05 (diff)
downloadlibquotient-4244cee8d5e0f760cccd2b45ad587670573ef03c.tar.gz
libquotient-4244cee8d5e0f760cccd2b45ad587670573ef03c.zip
Prepare for CS API 0.4.0
This commit consists of two parts: upgrading the API infrastructure and trivial but sweeping update to the generated files. 1. The API infrastructure (converters.h, *.mustache and some other non-generated files) now can deal with top-level JSON arrays and response inlining; better supports property maps; and gets some formatting fixes in generated code. 2. Generated files now use QJsonValue instead of QJsonObject as a default type to (un)marshall Matrix API data structures, to match the change in the infrastructure above This commit is still using the old Matrix API definitions, before CS API 0.4.0. Getting to CS API 0.4.0 will come next.
Diffstat (limited to 'lib/csapi/device_management.h')
-rw-r--r--lib/csapi/device_management.h24
1 files changed, 12 insertions, 12 deletions
diff --git a/lib/csapi/device_management.h b/lib/csapi/device_management.h
index 338f8529..f41efdbc 100644
--- a/lib/csapi/device_management.h
+++ b/lib/csapi/device_management.h
@@ -16,7 +16,7 @@ namespace QMatrixClient
// Operations
/// List registered devices for the current user
- ///
+ ///
/// Gets information about all devices for the current user.
class GetDevicesJob : public BaseJob
{
@@ -47,13 +47,13 @@ namespace QMatrixClient
};
/// Get a single device
- ///
+ ///
/// Gets information on a single device, by device id.
class GetDeviceJob : public BaseJob
{
public:
/*! Get a single device
- * \param deviceId
+ * \param deviceId
* The device to retrieve.
*/
explicit GetDeviceJob(const QString& deviceId);
@@ -82,15 +82,15 @@ namespace QMatrixClient
};
/// Update a device
- ///
+ ///
/// Updates the metadata on the given device.
class UpdateDeviceJob : public BaseJob
{
public:
/*! Update a device
- * \param deviceId
+ * \param deviceId
* The device to update.
- * \param displayName
+ * \param displayName
* The new display name for this device. If not given, the
* display name is unchanged.
*/
@@ -98,7 +98,7 @@ namespace QMatrixClient
};
/// Delete a device
- ///
+ ///
/// This API endpoint uses the `User-Interactive Authentication API`_.
///
/// Deletes the given device, and invalidates any access token associated with it.
@@ -106,9 +106,9 @@ namespace QMatrixClient
{
public:
/*! Delete a device
- * \param deviceId
+ * \param deviceId
* The device to delete.
- * \param auth
+ * \param auth
* Additional authentication information for the
* user-interactive authentication API.
*/
@@ -116,7 +116,7 @@ namespace QMatrixClient
};
/// Bulk deletion of devices
- ///
+ ///
/// This API endpoint uses the `User-Interactive Authentication API`_.
///
/// Deletes the given devices, and invalidates any access token associated with them.
@@ -124,9 +124,9 @@ namespace QMatrixClient
{
public:
/*! Bulk deletion of devices
- * \param devices
+ * \param devices
* The list of device IDs to delete.
- * \param auth
+ * \param auth
* Additional authentication information for the
* user-interactive authentication API.
*/