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

Add docs to event

Browse Source 
to say that sender won't always be set
This commit is contained in:
David Baker
2017-02-15 14:27:38 +00:00
parent 94a8915f6c
commit 0416816329
1 changed files with 3 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
src/models/event.js
View File

@@ -61,7 +61,9 @@ module.exports.EventStatus = {
* from changes to event JSON between Matrix versions.
*
* @prop {RoomMember} sender The room member who sent this event, or null e.g.
* this is a presence event.
* this is a presence event. This is only guarenteed to be set for events that
* appear in a timeline, ie. do not guarentee that it will be set on state
* events.
* @prop {RoomMember} target The room member who is the target of this event, e.g.
* the invitee, the person being banned, etc.
* @prop {EventStatus} status The sending status of the event.