ArchiveCompatibilityParams

Kotlin |Java

open class ArchiveCompatibilityParams

kotlin.Any
↳	android.content.pm.LauncherApps.ArchiveCompatibilityParams

Used to enable Archiving compatibility options with setArchiveCompatibility.

Summary

Public constructors
`ArchiveCompatibilityParams()`

Public methods
open Unit	`setEnableIconOverlay(enableIconOverlay: Boolean)` If true, provides a cloud overlay for archived apps to ensure users are aware that a certain app is archived.
open Unit	`setEnableUnarchivalConfirmation(enableUnarchivalConfirmation: Boolean)` If true, the user is shown a confirmation dialog when they click an archived app, which explains that the app will be downloaded and restored in the background.

Public constructors

ArchiveCompatibilityParams

ArchiveCompatibilityParams()

Public methods

setEnableIconOverlay

Added in API level 35

open fun setEnableIconOverlay(enableIconOverlay: Boolean): Unit

If true, provides a cloud overlay for archived apps to ensure users are aware that a certain app is archived. True by default.

Launchers might want to disable this operation if they want to provide custom user experience to differentiate archived apps.

setEnableUnarchivalConfirmation

Added in API level 35

open fun setEnableUnarchivalConfirmation(enableUnarchivalConfirmation: Boolean): Unit

If true, the user is shown a confirmation dialog when they click an archived app, which explains that the app will be downloaded and restored in the background. True by default.

Launchers might want to disable this operation if they provide sufficient, alternative user guidance to highlight that an unarchival is starting and ongoing once an archived app is tapped. E.g., this could be achieved by showing the unarchival progress around the icon.