imterah/element-portable
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Even better docs

Browse source
This commit is contained in:
Luke Barnard 2017-12-13 18:28:43 +00:00
parent 6b02f59fb7
commit 629cd13319
3 changed files with 22 additions and 15 deletions
Download patch file Download diff file Expand all files Collapse all files

9
src/actions/GroupActions.js
View file

@ -19,12 +19,13 @@ import { asyncAction } from './actionCreators';
const GroupActions = {};
/**
* Create a GroupActions.fetchJoinedGroups action that represents an
* asynchronous request to fetch the groups to which a user is joined.
* Creates an action thunk that will do an asynchronous request to fetch
* the groups to which a user is joined.
*
* @param {MatrixClient} matrixClient the matrix client to query.
* @returns {function} an asynchronous action of type
* GroupActions.fetchJoinedGroups.
* @returns {function} an action thunk that will dispatch actions
* indicating the status of the request.
* @see asyncAction
*/
GroupActions.fetchJoinedGroups = function(matrixClient) {
return asyncAction('GroupActions.fetchJoinedGroups', () => matrixClient.getJoinedGroups());