AppSearchSchema.BooleanPropertyConfig.Builder

class AppSearchSchema.BooleanPropertyConfig.Builder

Builder for BooleanPropertyConfig.

Summary

Public constructors
Builder(propertyName: String)

Creates a new BooleanPropertyConfig.Builder.

Public functions
AppSearchSchema.BooleanPropertyConfig

Constructs a new BooleanPropertyConfig from the contents of this builder.
AppSearchSchema.BooleanPropertyConfig.Builder
setCardinality(cardinality: Int)

Sets the cardinality of the property (whether it is optional, required or repeated).
AppSearchSchema.BooleanPropertyConfig.Builder
@RequiresFeature(enforcement = "androidx.appsearch.app.Features#isFeatureSupported", name = Features.SCHEMA_SET_DESCRIPTION)
setDescription(description: String)

Sets a natural language description of this property.

Public constructors

Builder

Added in 1.1.0-alpha04
Builder(propertyName: String)

Creates a new BooleanPropertyConfig.Builder.

Public functions

build

Added in 1.1.0-alpha04
fun build(): AppSearchSchema.BooleanPropertyConfig

Constructs a new BooleanPropertyConfig from the contents of this builder.

setCardinality

Added in 1.1.0-alpha04
fun setCardinality(cardinality: Int): AppSearchSchema.BooleanPropertyConfig.Builder

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

If this method is not called, the default cardinality is CARDINALITY_OPTIONAL.

setDescription

Added in 1.1.0-alpha04
@RequiresFeature(enforcement = "androidx.appsearch.app.Features#isFeatureSupported", name = Features.SCHEMA_SET_DESCRIPTION)
fun setDescription(description: String): AppSearchSchema.BooleanPropertyConfig.Builder

Sets a natural language description of this property.

For more details about the description field, see getDescription.