kdoc

Author: BillCarsonFr

matrix-sdk-android/src/main/java/org/matrix/android/sdk/api/session/crypto/CryptoService.kt

@@ -193,7 +193,7 @@ interface CryptoService {
     fun prepareToEncrypt(roomId: String, callback: MatrixCallback<Unit>)
 
     /**
-     * Share all inbound sessions of the last chunk messages to the provided userId devices
+     * Share all inbound sessions of the last chunk messages to the provided userId devices.
      */
     suspend fun sendSharedHistoryKeys(roomId: String, userId: String, sessionInfoSet: Set<SessionInfo>?)
 }

matrix-sdk-android/src/main/java/org/matrix/android/sdk/api/session/crypto/model/ForwardedRoomKeyContent.kt

@@ -72,8 +72,7 @@ data class ForwardedRoomKeyContent(
         val senderClaimedEd25519Key: String? = null,
 
         /**
-         * MSC3061
-         * Identifies keys that were sent when the room's visibility setting was set to world_readable or shared
+         * MSC3061 Identifies keys that were sent when the room's visibility setting was set to world_readable or shared.
          */
         @Json(name = "org.matrix.msc3061.shared_history")
         val sharedHistory: Boolean? = false,

matrix-sdk-android/src/main/java/org/matrix/android/sdk/api/session/events/model/content/RoomKeyContent.kt

@@ -41,8 +41,7 @@ data class RoomKeyContent(
         val chainIndex: Any? = null,
 
         /**
-         * MSC3061
-         * Identifies keys that were sent when the room's visibility setting was set to world_readable or shared
+         * MSC3061 Identifies keys that were sent when the room's visibility setting was set to world_readable or shared.
          */
         @Json(name = "org.matrix.msc3061.shared_history")
         val sharedHistory: Boolean? = false

matrix-sdk-android/src/main/java/org/matrix/android/sdk/api/session/room/model/RoomHistoryVisibility.kt

@@ -50,7 +50,7 @@ enum class RoomHistoryVisibility {
 }
 
 /**
- * Room history should be shared only if room visibility is world_readable or shared
+ * Room history should be shared only if room visibility is world_readable or shared.
  */
 internal fun RoomHistoryVisibility.shouldShareHistory() =
         this == RoomHistoryVisibility.WORLD_READABLE || this == RoomHistoryVisibility.SHARED

matrix-sdk-android/src/main/java/org/matrix/android/sdk/internal/crypto/MXOlmDevice.kt

@@ -601,6 +601,7 @@ internal class MXOlmDevice @Inject constructor(
      * @param forwardingCurve25519KeyChain Devices involved in forwarding this session to us.
      * @param keysClaimed Other keys the sender claims.
      * @param exportFormat true if the megolm keys are in export format
+     * @param sharedHistory MSC3061, this key is sharable on invite
      * @return true if the operation succeeds.
      */
     fun addInboundGroupSession(sessionId: String,

matrix-sdk-android/src/main/java/org/matrix/android/sdk/internal/crypto/MegolmSessionData.kt

@@ -73,7 +73,7 @@ internal data class MegolmSessionData(
 
         /**
          * Flag that indicates whether or not the current inboundSession will be shared to
-         * invited users to decrypt past messages
+         * invited users to decrypt past messages.
          */
         // When this feature lands in spec name = shared_history should be used
         @Json(name = "org.matrix.msc3061.shared_history")

matrix-sdk-android/src/main/java/org/matrix/android/sdk/internal/crypto/algorithms/megolm/MXMegolmDecryption.kt

@@ -300,15 +300,15 @@ internal class MXMegolmDecryption(
     }
 
     /**
-     * Returns boolean shared key flag, if enabled with respect to matrix configuration
+     * Returns boolean shared key flag, if enabled with respect to matrix configuration.
      */
     private fun RoomKeyContent.getSharedKey(): Boolean {
         if (!cryptoStore.isShareKeysOnInviteEnabled()) return false
         return sharedHistory ?: false
     }
 
     /**
-     * Check if the some messages can be decrypted with a new session
+     * 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

matrix-sdk-android/src/main/java/org/matrix/android/sdk/internal/crypto/keysbackup/DefaultKeysBackupService.kt

@@ -1469,7 +1469,7 @@ internal class DefaultKeysBackupService @Inject constructor(
     }
 
     /**
-     * Returns boolean shared key flag, if enabled with respect to matrix configuration
+     * Returns boolean shared key flag, if enabled with respect to matrix configuration.
      */
     private fun MXInboundMegolmSessionWrapper.getSharedKey(): Boolean {
         if (!cryptoStore.isShareKeysOnInviteEnabled()) return false

matrix-sdk-android/src/main/java/org/matrix/android/sdk/internal/crypto/keysbackup/model/rest/KeyBackupData.kt

@@ -54,7 +54,7 @@ internal data class KeyBackupData(
 
         /**
          * Flag that indicates whether or not the current inboundSession will be shared to
-         * invited users to decrypt past messages
+         * invited users to decrypt past messages.
          */
         @Json(name = "org.matrix.msc3061.shared_history")
         val sharedHistory: Boolean = false

matrix-sdk-android/src/main/java/org/matrix/android/sdk/internal/crypto/model/InboundGroupSessionData.kt

@@ -43,9 +43,9 @@ data class InboundGroupSessionData(
 
         /**
          * Flag that indicates whether or not the current inboundSession will be shared to
-         *invited users to decrypt past messages
+         * invited users to decrypt past messages.
          */
         @Json(name = "shared_history")
         val sharedHistory: Boolean = false,
 
-)
+        )