You've already forked matrix-js-sdk
mirror of
https://github.com/matrix-org/matrix-js-sdk.git
synced 2025-11-26 17:03:12 +03:00
Fix jsdocs
This commit is contained in:
@@ -89,6 +89,7 @@ export {EncryptionAlgorithm}; // https://github.com/jsdoc3/jsdoc/issues/1272
|
||||
/**
|
||||
* base type for decryption implementations
|
||||
*
|
||||
* @alias module:crypto/algorithms/base.DecryptionAlgorithm
|
||||
* @param {object} params parameters
|
||||
* @param {string} params.userId The UserID for the local user
|
||||
* @param {module:crypto} params.crypto crypto core
|
||||
@@ -144,7 +145,7 @@ class DecryptionAlgorithm {
|
||||
/**
|
||||
* Determine if we have the keys necessary to respond to a room key request
|
||||
*
|
||||
* @param {module:crypto#RoomKeyRequest} keyRequest
|
||||
* @param {module:crypto~IncomingRoomKeyRequest} keyRequest
|
||||
* @return {boolean} true if we have the keys and could (theoretically) share
|
||||
* them; else false.
|
||||
*/
|
||||
@@ -155,7 +156,7 @@ class DecryptionAlgorithm {
|
||||
/**
|
||||
* Send the response to a room key request
|
||||
*
|
||||
* @param {module:crypto#RoomKeyRequest} keyRequest
|
||||
* @param {module:crypto~IncomingRoomKeyRequest} keyRequest
|
||||
*/
|
||||
shareKeysWithDevice(keyRequest) {
|
||||
throw new Error("shareKeysWithDevice not supported for this DecryptionAlgorithm");
|
||||
|
||||
@@ -662,7 +662,9 @@ MegolmDecryption.prototype.onRoomKeyEvent = function(event) {
|
||||
this._retryDecryption(senderKey, sessionId);
|
||||
};
|
||||
|
||||
|
||||
/**
|
||||
* @inheritdoc
|
||||
*/
|
||||
MegolmDecryption.prototype.hasKeysForKeyRequest = function(keyRequest) {
|
||||
const body = keyRequest.requestBody;
|
||||
|
||||
@@ -674,7 +676,9 @@ MegolmDecryption.prototype.hasKeysForKeyRequest = function(keyRequest) {
|
||||
);
|
||||
};
|
||||
|
||||
|
||||
/**
|
||||
* @inheritdoc
|
||||
*/
|
||||
MegolmDecryption.prototype.shareKeysWithDevice = function(keyRequest) {
|
||||
const userId = keyRequest.userId;
|
||||
const deviceId = keyRequest.deviceId;
|
||||
|
||||
@@ -1277,8 +1277,8 @@ Crypto.prototype._signObject = function(obj) {
|
||||
* @property {string} userId user requesting the key
|
||||
* @property {string} deviceId device requesting the key
|
||||
* @property {string} requestId unique id for the request
|
||||
* @property {RoomKeyRequestBody} requestBody
|
||||
* @property {Function} share callback which, when called, will ask
|
||||
* @property {module:crypto~RoomKeyRequestBody} requestBody
|
||||
* @property {function()} share callback which, when called, will ask
|
||||
* the relevant crypto algorithm implementation to share the keys for
|
||||
* this request.
|
||||
*/
|
||||
|
||||
Reference in New Issue
Block a user