Stay organized with collections
Save and categorize content based on your preferences.
LauncherApps.ArchiveCompatibilityParams
public
static
class
LauncherApps.ArchiveCompatibilityParams
extends Object
Used to enable Archiving compatibility options with LauncherApps.setArchiveCompatibility(ArchiveCompatibilityParams).
Summary
Public methods |
|---|
void
|
setEnableIconOverlay(boolean enableIconOverlay)
If true, provides a cloud overlay for archived apps to ensure users are aware that a
certain app is archived.
|
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.
|
Inherited methods |
|---|
From class
java.lang.Object
Object
|
clone()
Creates and returns a copy of this object.
|
boolean
|
equals(Object obj)
Indicates whether some other object is "equal to" this one.
|
void
|
finalize()
Called by the garbage collector on an object when garbage collection
determines that there are no more references to the object.
|
final
Class<?>
|
getClass()
Returns the runtime class of this Object.
|
int
|
hashCode()
Returns a hash code value for the object.
|
final
void
|
notify()
Wakes up a single thread that is waiting on this object's
monitor.
|
final
void
|
notifyAll()
Wakes up all threads that are waiting on this object's monitor.
|
String
|
toString()
Returns a string representation of the object.
|
final
void
|
wait(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(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()
Causes the current thread to wait until it is awakened, typically
by being notified or interrupted.
|
|
Public constructors
ArchiveCompatibilityParams
public ArchiveCompatibilityParams ()
Public methods
setEnableIconOverlay
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.
| Parameters |
|---|
enableIconOverlay |
boolean |
setEnableUnarchivalConfirmation
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.
| Parameters |
|---|
enableUnarchivalConfirmation |
boolean |
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](/guide/topics/manifest/uses-sdk-element#ApiLevels) \nSummary: [Ctors](#pubctors) \\| [Methods](#pubmethods) \\| [Inherited Methods](#inhmethods) \n\nLauncherApps.ArchiveCompatibilityParams\n=======================================\n\n*** ** * ** ***\n\n[Kotlin](/reference/kotlin/android/content/pm/LauncherApps.ArchiveCompatibilityParams \"View this page in Kotlin\") \\|Java\n\n\n`\npublic\nstatic\n\n\nclass\nLauncherApps.ArchiveCompatibilityParams\n`\n\n\n`\n\nextends `[Object](/reference/java/lang/Object)`\n\n\n`\n\n`\n\n\n`\n\n|---|------------------------------------------------------------|\n| [java.lang.Object](/reference/java/lang/Object) ||\n| ↳ | android.content.pm.LauncherApps.ArchiveCompatibilityParams |\n\n\u003cbr /\u003e\n\n*** ** * ** ***\n\nUsed to enable Archiving compatibility options with [LauncherApps.setArchiveCompatibility(ArchiveCompatibilityParams)](/reference/android/content/pm/LauncherApps#setArchiveCompatibility(android.content.pm.LauncherApps.ArchiveCompatibilityParams)).\n\nSummary\n-------\n\n| ### Public constructors ||\n|------------------------------------------------------------------------------------------------------------------------------------------|---|\n| ` `[ArchiveCompatibilityParams](/reference/android/content/pm/LauncherApps.ArchiveCompatibilityParams#ArchiveCompatibilityParams())`() ` |\n\n| ### Public methods ||\n|---------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ` void` | ` `[setEnableIconOverlay](/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. |\n| ` void` | ` `[setEnableUnarchivalConfirmation](/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. |\n\n| ### Inherited methods |\n|-----------------------|---|\n| From class ` `[java.lang.Object](/reference/java/lang/Object)` ` |---------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ` `[Object](/reference/java/lang/Object) | ` `[clone](/reference/java/lang/Object#clone())`() ` Creates and returns a copy of this object. | | ` boolean` | ` `[equals](/reference/java/lang/Object#equals(java.lang.Object))`(`[Object](/reference/java/lang/Object)` obj) ` Indicates whether some other object is \"equal to\" this one. | | ` void` | ` `[finalize](/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](/reference/java/lang/Class)`\u003c?\u003e` | ` `[getClass](/reference/java/lang/Object#getClass())`() ` Returns the runtime class of this `Object`. | | ` int` | ` `[hashCode](/reference/java/lang/Object#hashCode())`() ` Returns a hash code value for the object. | | ` final void` | ` `[notify](/reference/java/lang/Object#notify())`() ` Wakes up a single thread that is waiting on this object's monitor. | | ` final void` | ` `[notifyAll](/reference/java/lang/Object#notifyAll())`() ` Wakes up all threads that are waiting on this object's monitor. | | ` `[String](/reference/java/lang/String) | ` `[toString](/reference/java/lang/Object#toString())`() ` Returns a string representation of the object. | | ` final void` | ` `[wait](/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](/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](/reference/java/lang/Object#wait())`() ` Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*. | ||\n\nPublic constructors\n-------------------\n\n### ArchiveCompatibilityParams\n\n```\npublic ArchiveCompatibilityParams ()\n```\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\nPublic methods\n--------------\n\n### setEnableIconOverlay\n\nAdded in [API level 35](/guide/topics/manifest/uses-sdk-element#ApiLevels) \n\n```\npublic void setEnableIconOverlay (boolean enableIconOverlay)\n```\n\nIf true, provides a cloud overlay for archived apps to ensure users are aware that a\ncertain app is archived. True by default.\n\nLaunchers might want to disable this operation if they want to provide custom user\nexperience to differentiate archived apps.\n\n\u003cbr /\u003e\n\n| Parameters ||\n|---------------------|------------------|\n| `enableIconOverlay` | `boolean` \u003cbr /\u003e |\n\n### setEnableUnarchivalConfirmation\n\nAdded in [API level 35](/guide/topics/manifest/uses-sdk-element#ApiLevels) \n\n```\npublic void setEnableUnarchivalConfirmation (boolean enableUnarchivalConfirmation)\n```\n\nIf true, the user is shown a confirmation dialog when they click an archived app, which\nexplains 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,\nalternative user guidance to highlight that an unarchival is starting and ongoing once an\narchived app is tapped. E.g., this could be achieved by showing the unarchival progress\naround the icon.\n\n\u003cbr /\u003e\n\n| Parameters ||\n|--------------------------------|------------------|\n| `enableUnarchivalConfirmation` | `boolean` \u003cbr /\u003e |"]]
