# LauncherApps.ArchiveCompatibilityParams

Added in[API level 35](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  
Summary:[Ctors](https://developer.android.com/reference/android/content/pm/LauncherApps.ArchiveCompatibilityParams#pubctors)\|[Methods](https://developer.android.com/reference/android/content/pm/LauncherApps.ArchiveCompatibilityParams#pubmethods)\|[Inherited Methods](https://developer.android.com/reference/android/content/pm/LauncherApps.ArchiveCompatibilityParams#inhmethods)  

# LauncherApps.ArchiveCompatibilityParams

*** ** * ** ***

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

`
public
static


class
LauncherApps.ArchiveCompatibilityParams
`  
`

extends `[Object](https://developer.android.com/reference/java/lang/Object)`


``


`

|---|------------------------------------------------------------|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object) ||
| ↳ | android.content.pm.LauncherApps.ArchiveCompatibilityParams |

<br />

*** ** * ** ***

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

## Summary

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

|                                                                                                                                                                                          ### Public methods                                                                                                                                                                                          ||
|---------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| ` void` | ` `[setEnableIconOverlay](https://developer.android.com/reference/android/content/pm/LauncherApps.ArchiveCompatibilityParams#setEnableIconOverlay(boolean))`(boolean enableIconOverlay) ` If true, provides a cloud overlay for archived apps to ensure users are aware that a certain app is archived.                                                                                     |
| ` void` | ` `[setEnableUnarchivalConfirmation](https://developer.android.com/reference/android/content/pm/LauncherApps.ArchiveCompatibilityParams#setEnableUnarchivalConfirmation(boolean))`(boolean enableUnarchivalConfirmation) ` 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. |

| ### Inherited methods |
|-----------------------|---|
| From class` `[java.lang.Object](https://developer.android.com/reference/java/lang/Object)` ` |--------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ` `[Object](https://developer.android.com/reference/java/lang/Object)          | ` `[clone](https://developer.android.com/reference/java/lang/Object#clone())`() ` Creates and returns a copy of this object.                                                                                                                                                      | | ` boolean`                                                                     | ` `[equals](https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object))`(`[Object](https://developer.android.com/reference/java/lang/Object)` obj) ` Indicates whether some other object is "equal to" this one.                                           | | ` void`                                                                        | ` `[finalize](https://developer.android.com/reference/java/lang/Object#finalize())`() ` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.                                                          | | ` final `[Class](https://developer.android.com/reference/java/lang/Class)`<?>` | ` `[getClass](https://developer.android.com/reference/java/lang/Object#getClass())`() ` Returns the runtime class of this`Object`.                                                                                                                                                | | ` int`                                                                         | ` `[hashCode](https://developer.android.com/reference/java/lang/Object#hashCode())`() ` Returns a hash code value for the object.                                                                                                                                                 | | ` final void`                                                                  | ` `[notify](https://developer.android.com/reference/java/lang/Object#notify())`() ` Wakes up a single thread that is waiting on this object's monitor.                                                                                                                            | | ` final void`                                                                  | ` `[notifyAll](https://developer.android.com/reference/java/lang/Object#notifyAll())`() ` Wakes up all threads that are waiting on this object's monitor.                                                                                                                         | | ` `[String](https://developer.android.com/reference/java/lang/String)          | ` `[toString](https://developer.android.com/reference/java/lang/Object#toString())`() ` Returns a string representation of the object.                                                                                                                                            | | ` final void`                                                                  | ` `[wait](https://developer.android.com/reference/java/lang/Object#wait(long,%20int))`(long timeoutMillis, int nanos) ` Causes the current thread to wait until it is awakened, typically by being*notified* or*interrupted*, or until a certain amount of real time has elapsed. | | ` final void`                                                                  | ` `[wait](https://developer.android.com/reference/java/lang/Object#wait(long))`(long timeoutMillis) ` Causes the current thread to wait until it is awakened, typically by being*notified* or*interrupted*, or until a certain amount of real time has elapsed.                   | | ` final void`                                                                  | ` `[wait](https://developer.android.com/reference/java/lang/Object#wait())`() ` Causes the current thread to wait until it is awakened, typically by being*notified* or*interrupted*.                                                                                             | ||

## Public constructors

### ArchiveCompatibilityParams

```
public ArchiveCompatibilityParams ()
```

<br />

<br />

## Public methods

### setEnableIconOverlay

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

```
public void setEnableIconOverlay (boolean enableIconOverlay)
```

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.

<br />

|              Parameters               ||
|---------------------|------------------|
| `enableIconOverlay` | `boolean` <br /> |

### setEnableUnarchivalConfirmation

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

```
public void setEnableUnarchivalConfirmation (boolean enableUnarchivalConfirmation)
```

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.

<br />

|                    Parameters                    ||
|--------------------------------|------------------|
| `enableUnarchivalConfirmation` | `boolean` <br /> |