Doc fetchJoinedGroups

pull/21833/head
lukebarnard 2017-12-13 11:05:23 +00:00
parent a653ece99e
commit ddf5dbad89
1 changed files with 8 additions and 0 deletions

View File

@ -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());
};