Added in API level 34

Summary: Nested Classes | Inherited Constants | Fields | Methods | Inherited Methods

PackageInstaller.InstallConstraints

---

Kotlin |Java

public static final class PackageInstaller.InstallConstraints
extends Object implements Parcelable

java.lang.Object
↳	android.content.pm.PackageInstaller.InstallConstraints

---

A class to encapsulate constraints for installation. When used with PackageInstaller.checkInstallConstraints(java.util.List, android.content.pm.PackageInstaller.InstallConstraints, java.util.concurrent.Executor, java.util.function.Consumer), it specifies the conditions to check against for the packages in question. This can be used by app stores to deliver auto updates without disrupting the user experience (referred as gentle update) - for example, an app store might hold off updates when it find out the app to update is interacting with the user. Use Builder to create a new instance and call mutator methods to add constraints. If no mutators were called, default constraints will be generated which implies no constraints. It is recommended to use preset constraints which are useful in most cases. For the purpose of gentle update, it is recommended to always use GENTLE_UPDATE for the system knows best how to do it. It will also benefits the installer as the platform evolves and add more constraints to improve the accuracy and efficiency of gentle update. Note the constraints are applied transitively. If app Foo is used by app Bar (via shared library or bounded service), the constraints will also be applied to Bar.

Summary

Nested classes
class	PackageInstaller.InstallConstraints.Builder Builder class for constructing InstallConstraints.

Inherited constants

From interface android.os.Parcelable int CONTENTS_FILE_DESCRIPTOR Descriptor bit used with describeContents(): indicates that the Parcelable object's flattened representation includes a file descriptor. int PARCELABLE_WRITE_RETURN_VALUE Flag for use with writeToParcel(Parcel, int): the object being written is a return value, that is the result of a function such as "Parcelable someFunction()", "void someFunction(out Parcelable)", or "void someFunction(inout Parcelable)".

Fields
public static final Creator<PackageInstaller.InstallConstraints>	CREATOR
public static final PackageInstaller.InstallConstraints	GENTLE_UPDATE Preset constraints suitable for gentle update.

Public methods
int	describeContents() Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
boolean	equals(Object o) Indicates whether some other object is "equal to" this one.
int	hashCode() Returns a hash code value for the object.
boolean	isAppNotForegroundRequired()
boolean	isAppNotInteractingRequired()
boolean	isAppNotTopVisibleRequired()
boolean	isDeviceIdleRequired()
boolean	isNotInCallRequired()
void	writeToParcel(Parcel dest, int flags) Flatten this object in to a Parcel.

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.
From interface android.os.Parcelable abstract int describeContents() Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. abstract void writeToParcel(Parcel dest, int flags) Flatten this object in to a Parcel.

Fields

CREATOR

Added in API level 34

public static final Creator<PackageInstaller.InstallConstraints> CREATOR

GENTLE_UPDATE

Added in API level 34

public static final PackageInstaller.InstallConstraints GENTLE_UPDATE

Preset constraints suitable for gentle update.

Public methods

describeContents

Added in API level 34

public int describeContents ()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of writeToParcel(android.os.Parcel, int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

Returns
int	a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or CONTENTS_FILE_DESCRIPTOR

equals

Added in API level 34

public boolean equals (Object o)

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

• It is reflexive: for any non-null reference value x, x.equals(x) should return true.
• It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
• It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
• It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
• For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
o	Object: This value may be null.

Returns
boolean	true if this object is the same as the obj argument; false otherwise.

hashCode

Added in API level 34

public int hashCode ()

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by HashMap.

The general contract of hashCode is:

• Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
• If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
• It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns
int	a hash code value for this object.

isAppNotForegroundRequired

Added in API level 34

public boolean isAppNotForegroundRequired ()

Returns
boolean

isAppNotInteractingRequired

Added in API level 34

public boolean isAppNotInteractingRequired ()

Returns
boolean

isAppNotTopVisibleRequired

Added in API level 34

public boolean isAppNotTopVisibleRequired ()

Returns
boolean

isDeviceIdleRequired

Added in API level 34

public boolean isDeviceIdleRequired ()

Returns
boolean

isNotInCallRequired

Added in API level 34

public boolean isNotInCallRequired ()

Returns
boolean

writeToParcel

Added in API level 34

public void writeToParcel (Parcel dest, 
                int flags)

Flatten this object in to a Parcel.

Parameters
dest	Parcel: This value cannot be null.
flags	int: Additional flags about how the object should be written. May be 0 or Parcelable.PARCELABLE_WRITE_RETURN_VALUE. Value is either 0 or a combination of Parcelable.PARCELABLE_WRITE_RETURN_VALUE, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES