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

event jsdoc

Browse Source 
Add a comment on the event event
This commit is contained in:
Richard van der Hoff
2016-11-08 16:52:12 +00:00
parent 6c3eb19b74
commit 77508f38bb
1 changed files with 4 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
lib/client.js
View File

@@ -2872,6 +2872,10 @@ module.exports.CRYPTO_ENABLED = CRYPTO_ENABLED;
/** /**
* Fires whenever the SDK receives a new event. * Fires whenever the SDK receives a new event.
* <p>
* This is only fired for live events received via /sync - it is not fired for
* events received over context, search, or pagination APIs.
*
* @event module:client~MatrixClient#"event" * @event module:client~MatrixClient#"event"
* @param {MatrixEvent} event The matrix event which caused this event to fire. * @param {MatrixEvent} event The matrix event which caused this event to fire.
* @example * @example