AppUpdateOptions
public
abstract
class
AppUpdateOptions
extends Object
| java.lang.Object | |
| ↳ | com.google.android.play.core.appupdate.AppUpdateOptions |
Options defining a specific in-app update flow and its parameters.
Summary
Nested classes | |
|---|---|
class |
AppUpdateOptions.Builder
Builder for |
Public constructors | |
|---|---|
AppUpdateOptions()
|
|
Public methods | |
|---|---|
abstract
boolean
|
allowAssetPackDeletion()
Allows the update flow to delete Asset Packs from the app's storage before attempting to update the app, in case of insufficient storage. |
abstract
int
|
appUpdateType()
Represents the type of the update flow. |
static
AppUpdateOptions
|
defaultOptions(int appUpdateType)
Returns an |
static
AppUpdateOptions.Builder
|
newBuilder(int appUpdateType)
Creates a |
Inherited methods | |
|---|---|
Public constructors
AppUpdateOptions
public AppUpdateOptions ()
Public methods
allowAssetPackDeletion
public abstract boolean allowAssetPackDeletion ()
Allows the update flow to delete Asset Packs from the app's storage before attempting to update the app, in case of insufficient storage.
For more information on Asset Packs, read Dynamic Asset Delivery.
| Returns | |
|---|---|
boolean |
|
appUpdateType
public abstract int appUpdateType ()
Represents the type of the update flow.
| Returns | |
|---|---|
int |
|
defaultOptions
public static AppUpdateOptions defaultOptions (int appUpdateType)
Returns an AppUpdateOptions instance with the default values for the provided update
flow type.
| Parameters | |
|---|---|
appUpdateType |
int |
| Returns | |
|---|---|
AppUpdateOptions |
|
newBuilder
public static AppUpdateOptions.Builder newBuilder (int appUpdateType)
Creates a AppUpdateOptions.Builder for the provided update flow type.
| Parameters | |
|---|---|
appUpdateType |
int |
| Returns | |
|---|---|
AppUpdateOptions.Builder |
|
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,["# AppUpdateOptions\n\nSummary: [Nested Classes](#nestedclasses) \\| [Ctors](#pubctors) \\| [Methods](#pubmethods) \\| [Inherited Methods](#inhmethods) \n\nAppUpdateOptions\n================\n\n\n`\npublic\n\n\nabstract\nclass\nAppUpdateOptions\n`\n\n\n`\n\nextends `[Object](https://developer.android.com/reference/java/lang/Object.html)`\n\n\n`\n\n`\n\n\n`\n\n|---|---------------------------------------------------------|\n| [java.lang.Object](https://developer.android.com/reference/java/lang/Object.html) ||\n| ↳ | com.google.android.play.core.appupdate.AppUpdateOptions |\n\n\u003cbr /\u003e\n\n*** ** * ** ***\n\nOptions defining a specific in-app update flow and its parameters.\n\nSummary\n-------\n\n| ### Nested classes ||\n|----------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ` class` | [AppUpdateOptions.Builder](../../../../../../../reference/com/google/android/play/core/appupdate/AppUpdateOptions.Builder.html) Builder for [AppUpdateOptions](../../../../../../../reference/com/google/android/play/core/appupdate/AppUpdateOptions.html). |\n\n| ### Public constructors ||\n|--------------------------------------------------------------------------------------------------------------------------------------------|---|\n| ` `[AppUpdateOptions](../../../../../../../reference/com/google/android/play/core/appupdate/AppUpdateOptions.html#AppUpdateOptions())`() ` |\n\n| ### Public methods ||\n|-------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ` abstract boolean` | ` `[allowAssetPackDeletion](../../../../../../../reference/com/google/android/play/core/appupdate/AppUpdateOptions.html#allowAssetPackDeletion())`() ` Allows the update flow to delete Asset Packs from the app's storage before attempting to update the app, in case of insufficient storage. |\n| ` abstract int` | ` `[appUpdateType](../../../../../../../reference/com/google/android/play/core/appupdate/AppUpdateOptions.html#appUpdateType())`() ` Represents the type of the update flow. |\n| ` static `[AppUpdateOptions](../../../../../../../reference/com/google/android/play/core/appupdate/AppUpdateOptions.html) | ` `[defaultOptions](../../../../../../../reference/com/google/android/play/core/appupdate/AppUpdateOptions.html#defaultOptions(int))`(int appUpdateType) ` Returns an [AppUpdateOptions](../../../../../../../reference/com/google/android/play/core/appupdate/AppUpdateOptions.html) instance with the default values for the provided update flow type. |\n| ` static `[AppUpdateOptions.Builder](../../../../../../../reference/com/google/android/play/core/appupdate/AppUpdateOptions.Builder.html) | ` `[newBuilder](../../../../../../../reference/com/google/android/play/core/appupdate/AppUpdateOptions.html#newBuilder(int))`(int appUpdateType) ` Creates a [AppUpdateOptions.Builder](../../../../../../../reference/com/google/android/play/core/appupdate/AppUpdateOptions.Builder.html) for the provided update flow type. |\n\n| ### Inherited methods |\n|-----------------------|---|\n| From class ` `[java.lang.Object](https://developer.android.com/reference/java/lang/Object.html)` ` |-------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------| | ` boolean` | ` equals(`[Object](https://developer.android.com/reference/java/lang/Object.html)` arg0) ` | | ` final `[Class](https://developer.android.com/reference/java/lang/Class.html)`\u003c?\u003e` | ` getClass() ` | | ` int` | ` hashCode() ` | | ` final void` | ` notify() ` | | ` final void` | ` notifyAll() ` | | ` `[String](https://developer.android.com/reference/java/lang/String.html) | ` toString() ` | | ` final void` | ` wait(long arg0, int arg1) ` | | ` final void` | ` wait(long arg0) ` | | ` final void` | ` wait() ` | ||\n\nPublic constructors\n-------------------\n\n### AppUpdateOptions\n\n```\npublic AppUpdateOptions ()\n```\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\nPublic methods\n--------------\n\n### allowAssetPackDeletion\n\n```\npublic abstract boolean allowAssetPackDeletion ()\n```\n\nAllows the update flow to delete Asset Packs from the app's storage before attempting to update\nthe app, in case of insufficient storage.\n\nFor more information on Asset Packs, read [Dynamic Asset Delivery](https://d.android.com/guide/app-bundle/asset-delivery).\n\n\u003cbr /\u003e\n\n| Returns ||\n|-----------|--------|\n| `boolean` | \u003cbr /\u003e |\n\n### appUpdateType\n\n```\npublic abstract int appUpdateType ()\n```\n\nRepresents the type of the update flow.\n\n\u003cbr /\u003e\n\n| Returns ||\n|-------|--------|\n| `int` | \u003cbr /\u003e |\n\n### defaultOptions\n\n```\npublic static AppUpdateOptions defaultOptions (int appUpdateType)\n```\n\nReturns an [AppUpdateOptions](../../../../../../../reference/com/google/android/play/core/appupdate/AppUpdateOptions.html) instance with the default values for the provided update\nflow type.\n\n\u003cbr /\u003e\n\n| Parameters ||\n|-----------------|--------------|\n| `appUpdateType` | `int` \u003cbr /\u003e |\n\n| Returns ||\n|-----------------------------------------------------------------------------------------------------------------|--------|\n| [AppUpdateOptions](../../../../../../../reference/com/google/android/play/core/appupdate/AppUpdateOptions.html) | \u003cbr /\u003e |\n\n### newBuilder\n\n```\npublic static AppUpdateOptions.Builder newBuilder (int appUpdateType)\n```\n\nCreates a [AppUpdateOptions.Builder](../../../../../../../reference/com/google/android/play/core/appupdate/AppUpdateOptions.Builder.html) for the provided update flow type.\n\n\u003cbr /\u003e\n\n| Parameters ||\n|-----------------|--------------|\n| `appUpdateType` | `int` \u003cbr /\u003e |\n\n| Returns ||\n|---------------------------------------------------------------------------------------------------------------------------------|--------|\n| [AppUpdateOptions.Builder](../../../../../../../reference/com/google/android/play/core/appupdate/AppUpdateOptions.Builder.html) | \u003cbr /\u003e |"]]