DomainVerificationUserState

public final class DomainVerificationUserState
extends Object implements Parcelable

java.lang.Object
   ↳ 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 Build.VERSION_CODES.S in order to open Intents which declare Intent#CATEGORY_BROWSABLE or no category and also match against Intent#CATEGORY_DEFAULT IntentFilters, either through an explicit declaration of Intent#CATEGORY_DEFAULT or through the use of 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

int DOMAIN_STATE_NONE

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

int DOMAIN_STATE_SELECTED

The domain has been selected by the user.

int DOMAIN_STATE_VERIFIED

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

Inherited constants

Fields

public static final Creator<DomainVerificationUserState> CREATOR

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.

Map<StringInteger> getHostToStateMap()

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

String getPackageName()

The package name that this data corresponds to.

UserHandle getUser()

The user that this data corresponds to.

int hashCode()

Returns a hash code value for the object.

boolean isLinkHandlingAllowed()

Whether or not this package is allowed to open links.

String toString()

Returns a string representation of the object.

void writeToParcel(Parcel dest, int flags)

Flatten this object in to a Parcel.

Inherited methods

Constants

DOMAIN_STATE_NONE

Added in API level 31
public static final int DOMAIN_STATE_NONE

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

Constant Value: 0 (0x00000000)

DOMAIN_STATE_SELECTED

Added in API level 31
public static final int DOMAIN_STATE_SELECTED

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.

Constant Value: 1 (0x00000001)

DOMAIN_STATE_VERIFIED

Added in API level 31
public static final int DOMAIN_STATE_VERIFIED

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

Constant Value: 2 (0x00000002)

Fields

CREATOR

Added in API level 31
public static final Creator<DomainVerificationUserState> CREATOR

Public methods

describeContents

Added in API level 31
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 31
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.

getHostToStateMap

Added in API level 31
public Map<StringInteger> getHostToStateMap ()

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

Returns
Map<StringInteger> This value cannot be null.

getPackageName

Added in API level 31
public String getPackageName ()

The package name that this data corresponds to.

Returns
String This value cannot be null.

getUser

Added in API level 31
public UserHandle getUser ()

The user that this data corresponds to.

Returns
UserHandle This value cannot be null.

hashCode

Added in API level 31
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.

isLinkHandlingAllowed

Added in API level 31
public boolean isLinkHandlingAllowed ()

Whether or not this package is allowed to open links.

Returns
boolean This value cannot be null.

toString

Added in API level 31
public String toString ()

Returns a string representation of the object.

Returns
String a string representation of the object.

writeToParcel

Added in API level 31
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