From ddf5dbad89a4991cad0a8208cd7a55c821775e43 Mon Sep 17 00:00:00 2001 From: lukebarnard Date: Wed, 13 Dec 2017 11:05:23 +0000 Subject: [PATCH] Doc fetchJoinedGroups --- src/actions/GroupActions.js | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/src/actions/GroupActions.js b/src/actions/GroupActions.js index 8e5484bb8c..f3337eda25 100644 --- a/src/actions/GroupActions.js +++ b/src/actions/GroupActions.js @@ -18,6 +18,14 @@ import { asyncAction } from './actionCreators'; const GroupActions = {}; +/** + * Create a GroupActions.fetchJoinedGroups action that represents an + * asyncronous request to fetch the groups to which a user is joined. + * + * @param {MatrixClient} matrixClient the matrix client to query. + * @returns {function} an asyncronous action of type + * GroupActions.fetchJoinedGroups. + */ GroupActions.fetchJoinedGroups = function(matrixClient) { return asyncAction('GroupActions.fetchJoinedGroups', () => matrixClient.getJoinedGroups()); };