matrix/matrix-js-sdk
1
0
Fork 0
mirror of https://github.com/matrix-org/matrix-js-sdk.git synced 2025-11-29 16:43:09 +03:00
Code Activity

Merge pull request #72 from matrix-org/dbkr/document_getroom

Browse Source 
Add docs to getRoom noting how you shouldn't assume it will return so…
This commit is contained in:
David Baker
2016-02-02 17:16:30 +00:00
parent 0a7efe3e8b 8a77b29d17
commit f172272dd3
1 changed files with 3 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
lib/client.js
View File

@@ -592,6 +592,9 @@ MatrixClient.prototype.isRoomEncrypted = function(roomId) {
/**
* Get the room for the given room ID.
* This function will return a valid room for any room for which a Room event
* has been emitted. Note in particular that other events, eg. RoomState.members
* will be emitted for a room before this function will return the given room.
* @param {string} roomId The room ID
* @return {Room} The Room or null if it doesn't exist or there is no data store.
*/