Improve documentation

This commit is contained in:
ariskotsomitopoulos 2022-05-20 15:33:29 +03:00
parent 2081e2c45b
commit 7bc880e6bf

View file

@ -756,6 +756,7 @@ internal class MXOlmDevice @Inject constructor(
* @param body the base64-encoded body of the encrypted message. * @param body the base64-encoded body of the encrypted message.
* @param roomId the room in which the message was received. * @param roomId the room in which the message was received.
* @param timeline the id of the timeline where the event is decrypted. It is used to prevent replay attack. * @param timeline the id of the timeline where the event is decrypted. It is used to prevent replay attack.
* @param eventId the eventId of the message that will be decrypted
* @param sessionId the session identifier. * @param sessionId the session identifier.
* @param senderKey the base64-encoded curve25519 key of the sender. * @param senderKey the base64-encoded curve25519 key of the sender.
* @return the decrypting result. Nil if the sessionId is unknown. * @return the decrypting result. Nil if the sessionId is unknown.