matrix/matrix-js-sdk
1
0
Fork 0
mirror of https://github.com/matrix-org/matrix-js-sdk.git synced 2025-11-26 17:03:12 +03:00
Code Activity

More useful doc

Browse Source
This commit is contained in:
David Baker
2017-07-24 09:55:04 +01:00
parent 055590c0c6
commit ed029fe348
1 changed files with 5 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
src/base-apis.js
View File

@@ -413,8 +413,11 @@ MatrixBaseApis.prototype.getGroupSummary = function(groupId) {
/**
* @param {string} groupId
* @param {Object} profile The group profile object, with name, avatar_url,
* short_description and long_description keys.
* @param {Object} profile The group profile object
* @param {string=} profile.name Name of the group
* @param {string=} profile.avatar_url MXC avatar URL
* @param {string=} profile.short_description A short description of the room
* @param {string=} profile.long_description A longer HTML description of the room
* @return {module:client.Promise} Resolves: Empty object
* @return {module:http-api.MatrixError} Rejects: with an error response.
*/