Draft : add some doc on ComposerDraftStores

This commit is contained in:
ganfra
2024-07-03 15:04:05 +02:00
parent 9a15a1ae71
commit f3bacc3c85
2 changed files with 9 additions and 0 deletions

View File

@@ -22,6 +22,10 @@ import io.element.android.libraries.matrix.api.room.draft.ComposerDraft
import timber.log.Timber
import javax.inject.Inject
/**
* A draft store that persists drafts in the room state.
* It can be used to store drafts that should be persisted across app restarts.
*/
class MatrixComposerDraftStore @Inject constructor(
private val client: MatrixClient,
) : ComposerDraftStore {

View File

@@ -20,6 +20,11 @@ import io.element.android.libraries.matrix.api.core.RoomId
import io.element.android.libraries.matrix.api.room.draft.ComposerDraft
import javax.inject.Inject
/**
* A volatile draft store that keeps drafts in memory only.
* It can be used to store drafts that should not be persisted across app restarts.
* Currently it's used to store draft message when moving to edit mode.
*/
class VolatileComposerDraftStore @Inject constructor() : ComposerDraftStore {
private val drafts: MutableMap<RoomId, ComposerDraft> = mutableMapOf()