Added in API level 31

AppSearchSchema


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

The AppSearch Schema for a particular type of document.

For example, an e-mail message or a music recording could be a schema type.

The schema consists of type information, properties, and config (like tokenization type).

Summary

Nested classes

Configuration for a property containing a boolean.

Builder for objects.

Configuration for a property containing a byte array.

Configuration for a property containing another Document.

Configuration for a property containing a double-precision decimal number.

Configuration for a property containing a 64-bit integer.

abstract

Common configuration for a single property (field) in a Document.

Configuration for a property of type String in a Document.

Inherited constants
Public methods
Boolean
equals(other: Any?)

Indicates whether some other object is "equal to" this one.

MutableList<String!>

Returns the list of parent types of this schema for polymorphism.

MutableList<AppSearchSchema.PropertyConfig!>

Returns the list of PropertyConfigs that are part of this schema.

String

Returns the name of this schema type, such as Email.

Int

String

Returns a string representation of the object.

Unit
writeToParcel(dest: Parcel, flags: Int)

Flatten this object in to a Parcel.

Properties
static Parcelable.Creator<AppSearchSchema!>

Public methods

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.
other Any?: This value may be null.
Return
Boolean true if this object is the same as the obj argument; false otherwise.

getParentTypes

Added in API level 35
fun getParentTypes(): MutableList<String!>

Returns the list of parent types of this schema for polymorphism.

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

getProperties

Added in API level 31
fun getProperties(): MutableList<AppSearchSchema.PropertyConfig!>

Returns the list of PropertyConfigs that are part of this schema.

This method creates a new list when called.

Return
MutableList<AppSearchSchema.PropertyConfig!> This value cannot be null.

getSchemaType

Added in API level 31
fun getSchemaType(): String

Returns the name of this schema type, such as Email.

Return
String This value cannot be null.

hashCode

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

toString

Added in API level 31
fun toString(): String

Returns a string representation of the object.

Return
String This value cannot be null.

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<AppSearchSchema!>