lun_admin/NeoLaunch_From_Kvaesitso
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

Update StorageStrategy KDoc comments

Browse Source
This commit is contained in:
MM20 2024-07-28 16:04:07 +02:00
parent 7ac7c224fe
commit 9d7731e717
No known key found for this signature in database
GPG Key ID: 0B61A8F2DEAFA389
1 changed files with 12 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
core/shared/src/main/java/de/mm20/launcher2/plugin/config/StorageStrategy.kt
View File

@ -10,21 +10,23 @@ import kotlinx.serialization.Serializable
@Serializable @Serializable
enum class StorageStrategy { enum class StorageStrategy {
/** /**
* The launcher only stores the ID and the plugin provider for the search result. To restore the * The launcher only stores the ID of the search result, and the plugin that created it. To
* search result, the launcher will query the plugin provider again. This strategy allows the * restore a result, the plugin is queried again. This allows the plugin to update key fields
* plugin provider to update a search result at a later point in time. However, plugins that use * (i.e. the label) immediately. However, plugins that use this strategy must guarantee, that
* this strategy must guarantee that a search result can be restored in a timely manner. In * they can restore a search result at any time, in a timely manner. In particular, the plugin
* particular, the plugin provider must be able to restore a search result without any network * must be able to restore a search result without any network requests. This strategy is best
* requests. * suited for on-device search plugins.
*/ */
@SerialName("ref") @SerialName("ref")
StoreReference, StoreReference,
/** /**
* The launcher stores all relevant information in its own internal database. This strategy * The launcher stores all relevant information about this search result in its own internal
* is easier to implement, but search results cannot be updated at a later point in time. * database. The result can be restored without querying the plugin again. The launcher will try
* Use this strategy if your plugin needs to perform network requests to retrieve search * refresh the search result at its own discretion (e.g. when a user long-presses a restored
* results and if you don't want to implement a cache for search results. * search result to view its details). This strategy is the default and should be used whenever
* the plugin can't restore a search result immediately. It is best suited for online search
* plugins.
*/ */
@SerialName("copy") @SerialName("copy")
StoreCopy, StoreCopy,