Added in API level 31

DomainVerificationUserState

class DomainVerificationUserState : Parcelable
kotlin.Any
   ↳ android.content.pm.verify.domain.DomainVerificationUserState

Contains the user selection state for a package. This means all web HTTP(S) domains declared by a package in its manifest, whether or not they were marked for auto verification.

Applications should use getHostToStateMap() if necessary to check if/how they are verified for a domain, which is required starting from platform android.os.Build.VERSION_CODES#S in order to open Intents which declare Intent.CATEGORY_BROWSABLE or no category and also match against Intent.CATEGORY_DEFAULT android.content.IntentFilters, either through an explicit declaration of Intent.CATEGORY_DEFAULT or through the use of android.content.pm.PackageManager#MATCH_DEFAULT_ONLY, which is usually added for the caller when using Context.startActivity(Intent) and similar.

By default, all apps are allowed to automatically open links for the above case for domains that they've successfully verified against. This is reflected by isLinkHandlingAllowed(). The user can decide to disable this, disallowing the application from opening all links. Note that the toggle affects all links and is not based on the verification state of the domains.

Assuming the toggle is enabled, the user can also select additional unverified domains to grant to the application to open, which is reflected in getHostToStateMap(). But only a single application can be approved for a domain unless the applications are both approved. If another application is approved, the user will not be allowed to enable the domain.

Summary

Constants
static Int

The domain is unverified and unselected, and the application is unable to open web links that resolve to the domain.
static Int

The domain has been selected by the user.
static Int

The domain has been previously verified by the domain verification agent.
Inherited constants
Public methods
Int

Boolean
equals(other: Any?)

Indicates whether some other object is "equal to" this one.
MutableMap<String!, Int!>

Mapping of domain host to state, as defined by the DOMAIN_STATE_* constants
String

The package name that this data corresponds to.
UserHandle

The user that this data corresponds to.
Int

Boolean

Whether or not this package is allowed to open links.
String

Unit
writeToParcel(dest: Parcel, flags: Int)

Flatten this object in to a Parcel.
Properties
static Parcelable.Creator<DomainVerificationUserState!>

Constants

DOMAIN_STATE_NONE

Added in API level 31
static val DOMAIN_STATE_NONE: Int

The domain is unverified and unselected, and the application is unable to open web links that resolve to the domain.

Value: 0

DOMAIN_STATE_SELECTED

Added in API level 31
static val DOMAIN_STATE_SELECTED: Int

The domain has been selected by the user. This may be reset to DOMAIN_STATE_NONE if another application is selected or verified for the same domain.

Value: 1

DOMAIN_STATE_VERIFIED

Added in API level 31
static val DOMAIN_STATE_VERIFIED: Int

The domain has been previously verified by the domain verification agent.

Value: 2

Public methods

describeContents

Added in API level 31
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 31
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 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
obj the reference object with which to compare.
o This value may be null.
Return
Boolean true if this object is the same as the obj argument; false otherwise.

getHostToStateMap

Added in API level 31
fun getHostToStateMap(): MutableMap<String!, Int!>

Mapping of domain host to state, as defined by the DOMAIN_STATE_* constants

Return
MutableMap<String!, Int!> This value cannot be null.

getPackageName

Added in API level 31
fun getPackageName(): String

The package name that this data corresponds to.

Return
String This value cannot be null.

getUser

Added in API level 31
fun getUser(): UserHandle

The user that this data corresponds to.

Return
UserHandle This value cannot be null.

hashCode

Added in API level 31
fun hashCode(): Int
Return
Int a hash code value for this object.

isLinkHandlingAllowed

Added in API level 31
fun isLinkHandlingAllowed(): Boolean

Whether or not this package is allowed to open links.

Return
Boolean This value cannot be null.

toString

Added in API level 31
fun toString(): String
Return
String a string representation of the object.

writeToParcel

Added in API level 31
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 31
static val CREATOR: Parcelable.Creator<DomainVerificationUserState!>