Stay organized with collections
Save and categorize content based on your preferences.
ArchiveCompatibilityParams
open class ArchiveCompatibilityParams
Used to enable Archiving compatibility options with setArchiveCompatibility.
Summary
| Public methods |
| open Unit |
If true, provides a cloud overlay for archived apps to ensure users are aware that a certain app is archived.
|
| open 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.
|
Public constructors
ArchiveCompatibilityParams
ArchiveCompatibilityParams()
Public methods
setEnableIconOverlay
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
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.
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2025-02-10 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-02-10 UTC."],[],[],null,["# LauncherApps.ArchiveCompatibilityParams\n\nAdded in [API level 35](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)\n\nArchiveCompatibilityParams\n==========================\n\n*** ** * ** ***\n\nKotlin \\|[Java](/reference/android/content/pm/LauncherApps.ArchiveCompatibilityParams \"View this page in Java\") \n\n```\nopen class ArchiveCompatibilityParams\n```\n\n|---|-----------------------------------------------------------------|\n| [kotlin.Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) ||\n| ↳ | [android.content.pm.LauncherApps.ArchiveCompatibilityParams](#) |\n\nUsed to enable Archiving compatibility options with [setArchiveCompatibility](/reference/kotlin/android/content/pm/LauncherApps#setArchiveCompatibility(android.content.pm.LauncherApps.ArchiveCompatibilityParams)).\n\nSummary\n-------\n\n| Public constructors ||\n|------------------------------------------------------------------------|---|\n| [ArchiveCompatibilityParams](#ArchiveCompatibilityParams())`()` \u003cbr /\u003e |\n\n| Public methods ||\n|-----------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| open [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | [setEnableIconOverlay](#setEnableIconOverlay(kotlin.Boolean))`(`enableIconOverlay:` `[Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`)` If true, provides a cloud overlay for archived apps to ensure users are aware that a certain app is archived. |\n| open [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | [setEnableUnarchivalConfirmation](#setEnableUnarchivalConfirmation(kotlin.Boolean))`(`enableUnarchivalConfirmation:` `[Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`)` 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. |\n\nPublic constructors\n-------------------\n\n### ArchiveCompatibilityParams\n\n```\nArchiveCompatibilityParams()\n```\n\nPublic methods\n--------------\n\n### setEnableIconOverlay\n\nAdded in [API level 35](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \n\n```\nopen fun setEnableIconOverlay(enableIconOverlay: Boolean): Unit\n```\n\nIf true, provides a cloud overlay for archived apps to ensure users are aware that a certain app is archived. True by default.\n\nLaunchers might want to disable this operation if they want to provide custom user experience to differentiate archived apps. \n\n### setEnableUnarchivalConfirmation\n\nAdded in [API level 35](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \n\n```\nopen fun setEnableUnarchivalConfirmation(enableUnarchivalConfirmation: Boolean): Unit\n```\n\nIf 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.\n\nLaunchers 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."]]
