AppSearchSchema.BooleanPropertyConfig.Builder

Builder(propertyName: String)

Creates a new BooleanPropertyConfig.Builder.

fun build(): AppSearchSchema.BooleanPropertyConfig

Constructs a new BooleanPropertyConfig from the contents of this builder.

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.

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

Sets a natural language description of this property.

For more details about the description field, see getDescription.

@RequiresFeature(enforcement = "androidx.appsearch.app.Features#isFeatureSupported", name = Features.SCHEMA_SCORABLE_PROPERTY_CONFIG)
@ExperimentalAppSearchApi
fun setScoringEnabled(scoringEnabled: Boolean): AppSearchSchema.BooleanPropertyConfig.Builder

Sets the property enabled or disabled for scoring.

If this method is not called, the default value is false.

If enabled, it can be used in the advanced ranking expression via the function of 'getScorableProperty'.

For the detailed documentation, see setRankingStrategy.