Add KDoc.
This commit is contained in:
parent
46544b1b45
commit
8d0aa68f9a
1 changed files with 11 additions and 1 deletions
|
|
@ -19,6 +19,16 @@ package io.element.android.features.migration.impl
|
||||||
import kotlinx.coroutines.flow.Flow
|
import kotlinx.coroutines.flow.Flow
|
||||||
|
|
||||||
interface MigrationStore {
|
interface MigrationStore {
|
||||||
suspend fun setApplicationMigrationVersion(version: Int)
|
/**
|
||||||
|
* Return of flow of the current value for application migration version.
|
||||||
|
* If the value is not set, it will emit 0.
|
||||||
|
* If the emitted value is lower than the current application migration version, it means
|
||||||
|
* that a migration should occur, and at the end [setApplicationMigrationVersion] should be called.
|
||||||
|
*/
|
||||||
fun applicationMigrationVersion(): Flow<Int>
|
fun applicationMigrationVersion(): Flow<Int>
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Set the application migration version, typically after a migration has been done.
|
||||||
|
*/
|
||||||
|
suspend fun setApplicationMigrationVersion(version: Int)
|
||||||
}
|
}
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue