From d6688d8f1237e2d4ae2ba7621061b4567319a12b Mon Sep 17 00:00:00 2001 From: David Baker Date: Wed, 6 Dec 2017 19:11:50 +0000 Subject: [PATCH] Add jsdoc --- src/cryptodevices.js | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/src/cryptodevices.js b/src/cryptodevices.js index 9fbfc060ec..bfa7328561 100644 --- a/src/cryptodevices.js +++ b/src/cryptodevices.js @@ -19,6 +19,15 @@ import sdk from './index'; import Modal from './Modal'; import { _t } from './languageHandler'; +/** + * Gets all crypto devices in a room that are marked neither known + * nor verified. + * + * @param {MatrixClient} matrixClient A MatrixClient + * @param {Room} room js-sdk room object representing the room + * @return {Promise} A promise which resolves to a map userId->deviceId->{@link + * module:crypto~DeviceInfo|DeviceInfo}. + */ export function getUnknownDevicesForRoom(matrixClient, room) { const roomMembers = room.getJoinedMembers().map((m) => { return m.userId;