diff --git a/src/actions/MatrixActionCreators.js b/src/actions/MatrixActionCreators.js index a18dc77551..31bcac3e52 100644 --- a/src/actions/MatrixActionCreators.js +++ b/src/actions/MatrixActionCreators.js @@ -144,23 +144,25 @@ function createRoomTimelineAction(matrixClient, timelineEvent, room, toStartOfTi /** * @typedef RoomMembershipAction * @type {Object} - * @property {string} action 'MatrixActions.RoomMember.membership'. - * @property {RoomMember} member the member whose membership was updated. + * @property {string} action 'MatrixActions.Room.myMembership'. + * @property {Room} room to room for which the self-membership changed. + * @property {string} membership the new membership + * @property {string} oldMembership the previous membership, can be null. */ /** * Create a MatrixActions.Room.myMembership action that represents - * a MatrixClient `RoomMember.membership` matrix event for the syncing user, - * emitted when the member's membership is updated. + * a MatrixClient `Room.myMembership` event for the syncing user, + * emitted when the syncing user's membership is updated for a room. * * @param {MatrixClient} matrixClient the matrix client. - * @param {MatrixEvent} membershipEvent the m.room.member event. - * @param {RoomMember} member the member whose membership was updated. - * @param {string} oldMembership the member's previous membership. - * @returns {RoomMembershipAction} an action of type `MatrixActions.RoomMember.membership`. + * @param {Room} room to room for which the self-membership changed. + * @param {string} membership the new membership + * @param {string} oldMembership the previous membership, can be null. + * @returns {RoomMembershipAction} an action of type `MatrixActions.Room.myMembership`. */ function createSelfMembershipAction(matrixClient, room, membership, oldMembership) { - return { action: 'MatrixActions.Room.myMembership', room, membership, oldMembership}; + return { action: 'MatrixActions.Room.myMembership', room, membership, oldMembership}; } /**