PackagePolicy

Kotlin |Java

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	`PACKAGE_POLICY_ALLOWLIST` PackagePolicy type indicator for `PackagePolicy`
static Int	`PACKAGE_POLICY_ALLOWLIST_AND_SYSTEM` PackagePolicy type indicator for `PackagePolicy`
static Int	`PACKAGE_POLICY_BLOCKLIST` PackagePolicy type indicator for `PackagePolicy`

Inherited constants

From class 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: 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)". Some implementations may want to release resources at this point.

Public constructors
`PackagePolicy(policyType: Int)` Create the package policy
`PackagePolicy(policyType: Int, packageNames: MutableSet<String!>)` Create the package policy

Public methods
Int	`describeContents()`
Boolean	`equals(other: Any?)`
MutableSet<String!>	`getPackageNames()` Returns the list of packages to use as an allow/deny list based on policy type
Int	`getPolicyType()` Returns the current policy type
Int	`hashCode()`
Unit	`writeToParcel(dest: Parcel, flags: Int)` Flatten this object in to a Parcel.

Properties
static Parcelable.Creator<PackagePolicy!>	`CREATOR`

Constants

PACKAGE_POLICY_ALLOWLIST

Added in API level 34

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: 3

See Also

#PACKAGE_POLICY_BLOCKLIST
#PACKAGE_POLICY_ALLOWLIST_AND_SYSTEM

PACKAGE_POLICY_ALLOWLIST_AND_SYSTEM

Added in API level 34

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: 2

See Also

#PACKAGE_POLICY_BLOCKLIST
#PACKAGE_POLICY_ALLOWLIST

PACKAGE_POLICY_BLOCKLIST

Added in API level 34

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: 1

See Also

#PACKAGE_POLICY_ALLOWLIST_AND_SYSTEM
#PACKAGE_POLICY_ALLOWLIST

Public constructors

PackagePolicy

Added in API level 34

PackagePolicy(policyType: Int)

Create the package policy

Parameters
`policyType`	Int: indicates how to interpret this policy Value is `android.app.admin.PackagePolicy#PACKAGE_POLICY_BLOCKLIST`, `android.app.admin.PackagePolicy#PACKAGE_POLICY_ALLOWLIST_AND_SYSTEM`, or `android.app.admin.PackagePolicy#PACKAGE_POLICY_ALLOWLIST`

See Also

android.app.admin.PackagePolicy#PackagePolicy(int, Set)

PackagePolicy

Added in API level 34

PackagePolicy(
    policyType: Int, 
    packageNames: MutableSet<String!>)

Create the package policy

Parameters
`policyType`	Int: indicates how to interpret this policy Value is `android.app.admin.PackagePolicy#PACKAGE_POLICY_BLOCKLIST`, `android.app.admin.PackagePolicy#PACKAGE_POLICY_ALLOWLIST_AND_SYSTEM`, or `android.app.admin.PackagePolicy#PACKAGE_POLICY_ALLOWLIST`
`packageNames`	MutableSet<String!>: allowlist or a denylist, based on policyType This value cannot be `null`.

Public methods

describeContents

Added in API level 34

fun describeContents(): Int

Return
`Int`	a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either `0` or `android.os.Parcelable#CONTENTS_FILE_DESCRIPTOR`

equals

Added in API level 34

fun equals(other: Any?): Boolean

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

Added in API level 34

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

Added in API level 34

fun getPolicyType(): Int

Returns the current policy type

Return
`Int`	Value is `android.app.admin.PackagePolicy#PACKAGE_POLICY_BLOCKLIST`, `android.app.admin.PackagePolicy#PACKAGE_POLICY_ALLOWLIST_AND_SYSTEM`, or `android.app.admin.PackagePolicy#PACKAGE_POLICY_ALLOWLIST`

hashCode

Added in API level 34

fun hashCode(): Int

Return
`Int`	a hash code value for this object.

writeToParcel

Added in API level 34

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 `android.os.Parcelable#PARCELABLE_WRITE_RETURN_VALUE`, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES

Properties

CREATOR

Added in API level 34

static val CREATOR: Parcelable.Creator<PackagePolicy!>

See Also

android.os.Parcelable.Creator