DocumentPropertyConfig

Kotlin |Java

class DocumentPropertyConfig : AppSearchSchema.PropertyConfig

kotlin.Any
↳	android.app.appsearch.AppSearchSchema.PropertyConfig
	↳	android.app.appsearch.AppSearchSchema.DocumentPropertyConfig

Configuration for a property containing another Document.

Summary

Nested classes
	`Builder` Builder for `DocumentPropertyConfig`.

Inherited constants

From class PropertyConfig

Int

CARDINALITY_OPTIONAL

Zero or one value [0,1].

Int

CARDINALITY_REPEATED

Any number of items (including zero) [0...*].

Int

CARDINALITY_REQUIRED

Exactly one value [1].

Public methods
MutableList<String!>	`getIndexableNestedProperties()` Returns the list of indexable nested properties for the nested document.
String	`getSchemaType()` Returns the logical schema-type of the contents of this document property.
Boolean	`shouldIndexNestedProperties()` Returns whether properties in the nested document should be indexed according to that document's schema.

Inherited functions

From class PropertyConfig

`Boolean`	`equals(other: Any?)` 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.
`Int`	`getCardinality()` Returns the cardinality of the property (whether it is optional, required or repeated).
`String`	`getDescription()` Returns a natural language description of this property. Ex. The description for the "homeAddress" property of a "Person" type could be "the address at which this person lives". This information is purely to help apps consuming this type the semantic meaning of its properties. This field has no effect in AppSearch - it is just stored with the AppSearchSchema. If the description is not set, then this method will return an empty string.
`String`	`getName()` Returns the name of this property.
`Int`	`hashCode()`
`String`	`toString()` Returns a string representation of the object.

Public methods

getIndexableNestedProperties

Added in API level 35
Also in T Extensions 13

fun getIndexableNestedProperties(): MutableList<String!>

Returns the list of indexable nested properties for the nested document.

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

getSchemaType

Added in API level 31

fun getSchemaType(): String

Returns the logical schema-type of the contents of this document property.

Return
`String`	This value cannot be `null`.

shouldIndexNestedProperties

Added in API level 31

fun shouldIndexNestedProperties(): Boolean

Returns whether properties in the nested document should be indexed according to that document's schema.

If false, the nested document's properties are not indexed regardless of its own schema.

See Also

android.app.appsearch.AppSearchSchema.DocumentPropertyConfig.Builder#addIndexableNestedProperties(Collection)