Added in API level 35

SchemaVisibilityConfig

class SchemaVisibilityConfig : Parcelable
kotlin.Any
   ↳ android.app.appsearch.SchemaVisibilityConfig

A class to hold a all necessary Visibility information corresponding to the same schema. This pattern allows for easier association of these documents.

This does not correspond to any schema, the properties held in this class are kept in two separate schemas, VisibilityConfig and PublicAclOverlay.

Summary

Nested classes

The builder class of SchemaVisibilityConfig.
Inherited constants
Public methods
Boolean
equals(other: Any?)

Indicates whether some other object is "equal to" this one.
MutableList<PackageIdentifier!>

Returns a list of PackageIdentifiers of packages that can access this schema.
PackageIdentifier?

Returns the PackageIdentifier of the package that will be used as the target package in a call to android.
MutableSet<MutableSet<Int!>!>

Returns an array of Integers representing Android Permissions as defined in android.
Int

Unit
writeToParcel(dest: Parcel, flags: Int)

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

Public methods

equals

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

getAllowedPackages

Added in API level 35
fun getAllowedPackages(): MutableList<PackageIdentifier!>

Returns a list of PackageIdentifiers of packages that can access this schema.

Return
MutableList<PackageIdentifier!> This value cannot be null.

getPubliclyVisibleTargetPackage

Added in API level 35
fun getPubliclyVisibleTargetPackage(): PackageIdentifier?

Returns the PackageIdentifier of the package that will be used as the target package in a call to android.content.pm.PackageManager#canPackageQuery to determine which packages can access this publicly visible schema. Returns null if the schema is not publicly visible.

getRequiredPermissions

Added in API level 35
fun getRequiredPermissions(): MutableSet<MutableSet<Int!>!>

Returns an array of Integers representing Android Permissions as defined in android.app.appsearch.SetSchemaRequest.AppSearchSupportedPermission that the caller must hold to access the schema this SchemaVisibilityConfig represents.

Return
MutableSet<MutableSet<Int!>!> This value cannot be null.

hashCode

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

writeToParcel

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