PackagePolicy
class PackagePolicy : Parcelable
| kotlin.Any | |
| ↳ | android.app.admin.PackagePolicy |
A generic class that defines which APK packages are in scope for some device policy.
The packages can be defined using either an allowlist or a blocklist. In allowlist mode, it could optionally include all system packages that meet the specific criteria of the device policy in question.
Summary
| Constants | |
|---|---|
| static Int |
PackagePolicy type indicator for |
| static Int |
PackagePolicy type indicator for |
| static Int |
PackagePolicy type indicator for |
| Inherited constants | |
|---|---|
| Public constructors | |
|---|---|
PackagePolicy(policyType: Int)Create the package policy |
|
PackagePolicy(policyType: Int, packageNames: MutableSet<String!>)Create the package policy |
|
| Public methods | |
|---|---|
| Int |
Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. |
| Boolean |
Indicates whether some other object is "equal to" this one. |
| MutableSet<String!> |
Returns the list of packages to use as an allow/deny list based on policy type |
| Int |
Returns the current policy type |
| Int |
hashCode()Returns a hash code value for the object. |
| Unit |
writeToParcel(dest: Parcel, flags: Int)Flatten this object in to a Parcel. |
| Properties | |
|---|---|
| static Parcelable.Creator<PackagePolicy!> | |
Constants
PACKAGE_POLICY_ALLOWLIST
static val PACKAGE_POLICY_ALLOWLIST: Int
PackagePolicy type indicator for PackagePolicy
This constant indicates that all packages are denied except for the packages returned by PackagePolicy.getPackageNames(), which acts as an allowlist.
Value: 3PACKAGE_POLICY_ALLOWLIST_AND_SYSTEM
static val PACKAGE_POLICY_ALLOWLIST_AND_SYSTEM: Int
PackagePolicy type indicator for PackagePolicy
This constant indicates system packages are allowed in addition to the packages returned by PackagePolicy.getPackageNames(), which acts as an allowlist.
Functions that accept PackagePolicy will further clarify how this policy is interpreted.
Value: 2PACKAGE_POLICY_BLOCKLIST
static val PACKAGE_POLICY_BLOCKLIST: Int
PackagePolicy type indicator for PackagePolicy
This constant indicates that all packages are allowed except for the packages returned by PackagePolicy.getPackageNames(), which acts as a denylist.
Value: 1Public constructors
PackagePolicy
PackagePolicy(policyType: Int)
Create the package policy
| Parameters | |
|---|---|
policyType |
Int: indicates how to interpret this policy. Value is one of the following: |
PackagePolicy
PackagePolicy(
policyType: Int,
packageNames: MutableSet<String!>)
Create the package policy
| Parameters | |
|---|---|
policyType |
Int: indicates how to interpret this policy. Value is one of the following: |
packageNames |
MutableSet<String!>: allowlist or a denylist, based on policyType. This value cannot be null. |
Public methods
describeContents
fun describeContents(): Int
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.
| Return | |
|---|---|
Int |
a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or
|
equals
fun equals(other: Any?): Boolean
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 returntrue. - It is symmetric: for any non-null reference values
xandy,x.equals(y)should returntrueif and only ify.equals(x)returnstrue. - It is transitive: for any non-null reference values
x,y, andz, ifx.equals(y)returnstrueandy.equals(z)returnstrue, thenx.equals(z)should returntrue. - It is consistent: for any non-null reference values
xandy, multiple invocations ofx.equals(y)consistently returntrueor consistently returnfalse, provided no information used inequalscomparisons on the objects is modified. - For any non-null reference value
x,x.equals(null)should returnfalse.
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 | |
|---|---|
obj |
the reference object with which to compare. |
| Return | |
|---|---|
Boolean |
true if this object is the same as the obj argument; false otherwise. |
getPackageNames
fun getPackageNames(): MutableSet<String!>
Returns the list of packages to use as an allow/deny list based on policy type
| Return | |
|---|---|
MutableSet<String!> |
This value cannot be null. |
getPolicyType
fun getPolicyType(): Int
Returns the current policy type
| Return | |
|---|---|
Int |
Value is one of the following: |
hashCode
fun hashCode(): Int
Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.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
hashCodemethod must consistently return the same integer, provided no information used inequalscomparisons 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
equalsmethod, then calling thehashCodemethod 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
equalsmethod, then calling thehashCodemethod 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.
| Return | |
|---|---|
Int |
a hash code value for this object. |
writeToParcel
fun writeToParcel(
dest: Parcel,
flags: Int
): Unit
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_WRITE_RETURN_VALUE. Value is either 0 or a combination of the following:
|