Add documentation from PR description
This commit is contained in:
parent
c2be97741e
commit
e997610ef2
|
@ -16,9 +16,26 @@
|
||||||
|
|
||||||
package im.vector.app.features.settings
|
package im.vector.app.features.settings
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Different strategies for Background sync, only applicable to F-Droid version of the app
|
||||||
|
*/
|
||||||
enum class BackgroundSyncMode {
|
enum class BackgroundSyncMode {
|
||||||
|
/**
|
||||||
|
* In this mode background syncs are scheduled via Workers, meaning that the system will have control on the periodicity
|
||||||
|
* of syncs when battery is low or when the phone is idle (sync will occur in allowed maintenance windows). After completion
|
||||||
|
* the sync work will schedule another one.
|
||||||
|
*/
|
||||||
FDROID_BACKGROUND_SYNC_MODE_FOR_BATTERY,
|
FDROID_BACKGROUND_SYNC_MODE_FOR_BATTERY,
|
||||||
|
|
||||||
|
/**
|
||||||
|
* This mode requires the app to be exempted from battery optimization. Alarms will be launched and will wake up the app
|
||||||
|
* in order to perform the background sync as a foreground service. After completion the service will schedule another alarm
|
||||||
|
*/
|
||||||
FDROID_BACKGROUND_SYNC_MODE_FOR_REALTIME,
|
FDROID_BACKGROUND_SYNC_MODE_FOR_REALTIME,
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The app won't sync in background
|
||||||
|
*/
|
||||||
FDROID_BACKGROUND_SYNC_MODE_DISABLED;
|
FDROID_BACKGROUND_SYNC_MODE_DISABLED;
|
||||||
|
|
||||||
companion object {
|
companion object {
|
||||||
|
|
Loading…
Reference in New Issue