From 57bf044df0092e9bd9306d17264cfe49e16e4495 Mon Sep 17 00:00:00 2001 From: Adam Brown Date: Thu, 31 Mar 2022 17:33:55 +0100 Subject: [PATCH] adding documentation to the new session listener --- .../android/sdk/internal/crypto/NewSessionListener.kt | 9 +++++++++ .../crypto/algorithms/megolm/MXMegolmDecryption.kt | 1 + 2 files changed, 10 insertions(+) diff --git a/matrix-sdk-android/src/main/java/org/matrix/android/sdk/internal/crypto/NewSessionListener.kt b/matrix-sdk-android/src/main/java/org/matrix/android/sdk/internal/crypto/NewSessionListener.kt index 301729680c..9b39a8ab25 100644 --- a/matrix-sdk-android/src/main/java/org/matrix/android/sdk/internal/crypto/NewSessionListener.kt +++ b/matrix-sdk-android/src/main/java/org/matrix/android/sdk/internal/crypto/NewSessionListener.kt @@ -15,6 +15,15 @@ */ package org.matrix.android.sdk.internal.crypto +/** + * This listener notifies on new Megolm sessions being created + */ interface NewSessionListener { + + /** + * @param roomId the room id where the new Megolm session has been created for, may be null when importing from external sessions + * @param senderKey the sender key of the device which the Megolm session is shared with + * @param sessionId the session id of the Megolm session + */ fun onNewSession(roomId: String?, senderKey: String, sessionId: String) } diff --git a/matrix-sdk-android/src/main/java/org/matrix/android/sdk/internal/crypto/algorithms/megolm/MXMegolmDecryption.kt b/matrix-sdk-android/src/main/java/org/matrix/android/sdk/internal/crypto/algorithms/megolm/MXMegolmDecryption.kt index fff0ba3477..72df59023a 100644 --- a/matrix-sdk-android/src/main/java/org/matrix/android/sdk/internal/crypto/algorithms/megolm/MXMegolmDecryption.kt +++ b/matrix-sdk-android/src/main/java/org/matrix/android/sdk/internal/crypto/algorithms/megolm/MXMegolmDecryption.kt @@ -325,6 +325,7 @@ internal class MXMegolmDecryption(private val userId: String, /** * Check if the some messages can be decrypted with a new session * + * @param roomId the room id where the new Megolm session has been created for, may be null when importing from external sessions * @param senderKey the session sender key * @param sessionId the session id */