SchemaVisibilityConfig

Kotlin |Java

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
	`Builder` The builder class of `SchemaVisibilityConfig`.

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 methods
Boolean	`equals(other: Any?)`
MutableList<PackageIdentifier!>	`getAllowedPackages()` Returns a list of `PackageIdentifier`s of packages that can access this schema.
PackageIdentifier?	`getPubliclyVisibleTargetPackage()` Returns the `PackageIdentifier` of the package that will be used as the target package in a call to android.
MutableSet<MutableSet<Int!>!>	`getRequiredPermissions()` Returns an array of Integers representing Android Permissions as defined in android.
Int	`hashCode()`
Unit	`writeToParcel(dest: Parcel, flags: Int)` Flatten this object in to a Parcel.

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

Public methods

equals

Added in API level VanillaIceCream

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.

getAllowedPackages

Added in API level VanillaIceCream

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 VanillaIceCream

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 VanillaIceCream

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 VanillaIceCream

fun hashCode(): Int

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

writeToParcel

Added in API level VanillaIceCream

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 VanillaIceCream

static val CREATOR: Parcelable.Creator<SchemaVisibilityConfig!>