# LauncherApps.ArchiveCompatibilityParams

Added in[API level 35](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)

# ArchiveCompatibilityParams

*** ** * ** ***

Kotlin\|[Java](https://developer.android.com/reference/android/content/pm/LauncherApps.ArchiveCompatibilityParams "View this page in Java")  

```
open class ArchiveCompatibilityParams
```

|---|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [kotlin.Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)                                                                                           ||
| ↳ | [android.content.pm.LauncherApps.ArchiveCompatibilityParams](https://developer.android.com/reference/kotlin/android/content/pm/LauncherApps.ArchiveCompatibilityParams#) |

Used to enable Archiving compatibility options with[setArchiveCompatibility](https://developer.android.com/reference/kotlin/android/content/pm/LauncherApps#setArchiveCompatibility(android.content.pm.LauncherApps.ArchiveCompatibilityParams)).

## Summary

|                                                                                Public constructors                                                                                 ||
|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|
| [ArchiveCompatibilityParams](https://developer.android.com/reference/kotlin/android/content/pm/LauncherApps.ArchiveCompatibilityParams#ArchiveCompatibilityParams())`()` <br /> |

|                                                                                                                                                                                                                                                                             Public methods                                                                                                                                                                                                                                                                              ||
|----------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| open[Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | [setEnableIconOverlay](https://developer.android.com/reference/kotlin/android/content/pm/LauncherApps.ArchiveCompatibilityParams#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.                                                                                     |
| open[Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | [setEnableUnarchivalConfirmation](https://developer.android.com/reference/kotlin/android/content/pm/LauncherApps.ArchiveCompatibilityParams#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. |

## Public constructors

### ArchiveCompatibilityParams

```
ArchiveCompatibilityParams()
```

## Public methods

### setEnableIconOverlay

Added in[API level 35](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)  

```
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](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)  

```
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.