From e62c6b7a72a49628becc25af0159b9f3ca8382a2 Mon Sep 17 00:00:00 2001
From: David Baker <dave@matrix.org>
Date: Tue, 27 Jun 2017 14:07:41 +0100
Subject: [PATCH] Add doc for group summary API
and remove callback param as it's deprecated
---
src/base-apis.js | 9 +++++++--
1 file changed, 7 insertions(+), 2 deletions(-)
diff --git a/src/base-apis.js b/src/base-apis.js
index 5a1768701..765e6ce8d 100644
--- a/src/base-apis.js
+++ b/src/base-apis.js
@@ -398,9 +398,14 @@ MatrixBaseApis.prototype.roomState = function(roomId, callback) {
return this._http.authedRequest(callback, "GET", path);
};
-MatrixBaseApis.prototype.getGroupSummary = function(groupId, callback) {
+/**
+ * @param {string} groupId
+ * @return {module:client.Promise} Resolves: Group summary object
+ * @return {module:http-api.MatrixError} Rejects: with an error response.
+ */
+MatrixBaseApis.prototype.getGroupSummary = function(groupId) {
const path = utils.encodeUri("/groups/$groupId/summary", {$groupId: groupId});
- return this._http.authedRequest(callback, "GET", path);
+ return this._http.authedRequest(undefined, "GET", path);
};
/**
--
GitLab