commonMain.net.folivo.trixnity.client.room.RoomEventEncryptionService.kt Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of trixnity-client-jvm Show documentation

Multiplatform Kotlin SDK for matrix-protocol

There is a newer version: 4.7.1

package net.folivo.trixnity.client.room

import net.folivo.trixnity.core.model.RoomId
import net.folivo.trixnity.core.model.events.ClientEvent.RoomEvent
import net.folivo.trixnity.core.model.events.MessageEventContent

interface RoomEventEncryptionService {
    /**
     * Encrypts given event. Returns null, when encryption algorithm is not supported by this service.
     *
     * Be aware, that this function can suspend a long time (for example, when the implementation needs to load all members).
     */
    suspend fun encrypt(content: MessageEventContent, roomId: RoomId): Result?

    /**
     * Decrypts given event. Returns null, when encryption algorithm is not supported by this service.
     *
     * Be aware, that this function can suspend a possible infinite time (for example, when the implementation waits for decryption keys).
     */
    suspend fun decrypt(event: RoomEvent.MessageEvent<*>): Result?
}

/**
 * Decrypts given event. Returns null, when encryption algorithm is not supported by any [RoomEventEncryptionService].
 *
 * Be aware, that this function can suspend a possible infinite time (for example, when an implementation waits for decryption keys).
 */
suspend fun List.encrypt(
    content: MessageEventContent,
    roomId: RoomId
): Result? =
    firstNotNullOfOrNull {
        it.encrypt(content, roomId)
    }

/**
 * Decrypts given event. Returns null, when encryption algorithm is not supported by any [RoomEventEncryptionService].
 *
 * Be aware, that this function can suspend a possible infinite time (for example, when an implementation waits for decryption keys).
 */
suspend fun List.decrypt(event: RoomEvent.MessageEvent<*>): Result? =
    firstNotNullOfOrNull {
        it.decrypt(event)
    }