aboutsummaryrefslogtreecommitdiff
path: root/lib/csapi/third_party_lookup.h
diff options
context:
space:
mode:
authorKitsune Ral <Kitsune-Ral@users.sf.net>2018-09-29 22:22:49 +0900
committerKitsune Ral <Kitsune-Ral@users.sf.net>2018-09-29 22:22:49 +0900
commitb55334ac0fe89f780776bc4eab90ffe1ca3c57bb (patch)
tree1a45c0ccfec8f5f7ba37eb4385cdc7f61afa0c97 /lib/csapi/third_party_lookup.h
parentf5c2e47fa1ab84fdaffe03c30ba973d7dea5ac05 (diff)
parent1e6510790dab6b9141ae52993987b406399668cd (diff)
downloadlibquotient-b55334ac0fe89f780776bc4eab90ffe1ca3c57bb.tar.gz
libquotient-b55334ac0fe89f780776bc4eab90ffe1ca3c57bb.zip
Merge branch 'cs-api-0.4.0'
Diffstat (limited to 'lib/csapi/third_party_lookup.h')
-rw-r--r--lib/csapi/third_party_lookup.h34
1 files changed, 17 insertions, 17 deletions
diff --git a/lib/csapi/third_party_lookup.h b/lib/csapi/third_party_lookup.h
index 03d607a8..3a60432b 100644
--- a/lib/csapi/third_party_lookup.h
+++ b/lib/csapi/third_party_lookup.h
@@ -18,7 +18,7 @@ namespace QMatrixClient
// Operations
/// Retrieve metadata about all protocols that a homeserver supports.
- ///
+ ///
/// Fetches the overall metadata about protocols supported by the
/// homeserver. Includes both the available protocols and all fields
/// required for queries against each protocol.
@@ -51,13 +51,13 @@ namespace QMatrixClient
};
/// Retrieve metadata about a specific protocol that the homeserver supports.
- ///
+ ///
/// Fetches the metadata from the homeserver about a particular third party protocol.
class GetProtocolMetadataJob : public BaseJob
{
public:
/*! Retrieve metadata about a specific protocol that the homeserver supports.
- * \param protocol
+ * \param protocol
* The name of the protocol.
*/
explicit GetProtocolMetadataJob(const QString& protocol);
@@ -85,8 +85,8 @@ namespace QMatrixClient
QScopedPointer<Private> d;
};
- /// Retreive Matrix-side portals rooms leading to a third party location.
- ///
+ /// Retrieve Matrix-side portals rooms leading to a third party location.
+ ///
/// Requesting this endpoint with a valid protocol name results in a list
/// of successful mapping results in a JSON array. Each result contains
/// objects to represent the Matrix room or rooms that represent a portal
@@ -98,10 +98,10 @@ namespace QMatrixClient
class QueryLocationByProtocolJob : public BaseJob
{
public:
- /*! Retreive Matrix-side portals rooms leading to a third party location.
- * \param protocol
+ /*! Retrieve Matrix-side portals rooms leading to a third party location.
+ * \param protocol
* The protocol used to communicate to the third party network.
- * \param searchFields
+ * \param searchFields
* One or more custom fields to help identify the third party
* location.
*/
@@ -131,16 +131,16 @@ namespace QMatrixClient
};
/// Retrieve the Matrix User ID of a corresponding third party user.
- ///
+ ///
/// Retrieve a Matrix User ID linked to a user on the third party service, given
/// a set of user parameters.
class QueryUserByProtocolJob : public BaseJob
{
public:
/*! Retrieve the Matrix User ID of a corresponding third party user.
- * \param protocol
+ * \param protocol
* The name of the protocol.
- * \param fields
+ * \param fields
* One or more custom fields that are passed to the AS to help identify the user.
*/
explicit QueryUserByProtocolJob(const QString& protocol, const QString& fields = {});
@@ -169,14 +169,14 @@ namespace QMatrixClient
};
/// Reverse-lookup third party locations given a Matrix room alias.
- ///
- /// Retreive an array of third party network locations from a Matrix room
+ ///
+ /// Retrieve an array of third party network locations from a Matrix room
/// alias.
class QueryLocationByAliasJob : public BaseJob
{
public:
/*! Reverse-lookup third party locations given a Matrix room alias.
- * \param alias
+ * \param alias
* The Matrix room alias to look up.
*/
explicit QueryLocationByAliasJob(const QString& alias);
@@ -205,13 +205,13 @@ namespace QMatrixClient
};
/// Reverse-lookup third party users given a Matrix User ID.
- ///
- /// Retreive an array of third party users from a Matrix User ID.
+ ///
+ /// Retrieve an array of third party users from a Matrix User ID.
class QueryUserByIDJob : public BaseJob
{
public:
/*! Reverse-lookup third party users given a Matrix User ID.
- * \param userid
+ * \param userid
* The Matrix User ID to look up.
*/
explicit QueryUserByIDJob(const QString& userid);