Added in API level 31

Builder


class Builder
kotlin.Any
   ↳ android.app.appsearch.AppSearchSchema.BooleanPropertyConfig.Builder

Builder for BooleanPropertyConfig.

Summary

Public constructors
Builder(propertyName: String)

Creates a new BooleanPropertyConfig.Builder.

Public methods
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
setScoringEnabled(scoringEnabled: Boolean)

Sets the property enabled or disabled for scoring.

Public constructors

Builder

Added in API level 31
Builder(propertyName: String)

Creates a new BooleanPropertyConfig.Builder.

Parameters
propertyName String: This value cannot be null.

Public methods

build

Added in API level 31
fun build(): AppSearchSchema.BooleanPropertyConfig

Constructs a new BooleanPropertyConfig from the contents of this builder.

Return
AppSearchSchema.BooleanPropertyConfig This value cannot be null.

setCardinality

Added in API level 31
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 android.app.appsearch.AppSearchSchema.PropertyConfig#CARDINALITY_OPTIONAL.

Parameters
cardinality Int: Value is android.app.appsearch.AppSearchSchema.PropertyConfig#CARDINALITY_REPEATED, android.app.appsearch.AppSearchSchema.PropertyConfig#CARDINALITY_OPTIONAL, or android.app.appsearch.AppSearchSchema.PropertyConfig#CARDINALITY_REQUIRED
Return
AppSearchSchema.BooleanPropertyConfig.Builder This value cannot be null.

setScoringEnabled

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 android.app.appsearch.SearchSpec.Builder#setRankingStrategy(java.lang.String).

Return
AppSearchSchema.BooleanPropertyConfig.Builder This value cannot be null.