AppSearchSchema.DocumentPropertyConfig

class AppSearchSchema.DocumentPropertyConfig : AppSearchSchema.PropertyConfig


Configuration for a property containing another Document.

Summary

Public functions

(Mutable)List<String!>

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

String

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

Boolean

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

Inherited Constants

From androidx.appsearch.app.AppSearchSchema.PropertyConfig
const Int

Zero or one value [0,1].

const Int

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

const Int

Exactly one value [1].

Inherited functions

From androidx.appsearch.app.AppSearchSchema.PropertyConfig
Boolean
equals(other: Any?)
Int

Returns the cardinality of the property (whether it is optional, required or repeated).

String

Returns the name of this property.

Int
String

Public functions

getIndexableNestedProperties

Added in 1.1.0-alpha04
fun getIndexableNestedProperties(): (Mutable)List<String!>

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

TODO(b/291122592): Unhide in Mainline when API updates via Mainline are possible. -->

getSchemaType

Added in 1.1.0-alpha04
fun getSchemaType(): String

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

shouldIndexNestedProperties

Added in 1.1.0-alpha04
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
addIndexableNestedProperties

for indexing a subset of properties from the nested document.