# AppSearchSchema.BooleanPropertyConfig.Builder

Artifact: [androidx.appsearch:appsearch](https://developer.android.com/jetpack/androidx/releases/appsearch) [View Source](https://cs.android.com/search?q=file:androidx/appsearch/app/AppSearchSchema.java+class:androidx.appsearch.app.AppSearchSchema.BooleanPropertyConfig.Builder) Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/appsearch#1.1.0)

*** ** * ** ***


```
class AppSearchSchema.BooleanPropertyConfig.Builder
```

<br />

*** ** * ** ***

Builder for `https://developer.android.com/reference/kotlin/androidx/appsearch/app/AppSearchSchema.BooleanPropertyConfig`.

## Summary

| ### Public constructors |
|---|
| `https://developer.android.com/reference/kotlin/androidx/appsearch/app/AppSearchSchema.BooleanPropertyConfig.Builder#Builder(java.lang.String)(propertyName: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html)` Creates a new `https://developer.android.com/reference/kotlin/androidx/appsearch/app/AppSearchSchema.BooleanPropertyConfig.Builder`. |

| ### Public functions |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/appsearch/app/AppSearchSchema.BooleanPropertyConfig` | `https://developer.android.com/reference/kotlin/androidx/appsearch/app/AppSearchSchema.BooleanPropertyConfig.Builder#build()()` Constructs a new `https://developer.android.com/reference/kotlin/androidx/appsearch/app/AppSearchSchema.BooleanPropertyConfig` from the contents of this builder. |
| `https://developer.android.com/reference/kotlin/androidx/appsearch/app/AppSearchSchema.BooleanPropertyConfig.Builder` | `https://developer.android.com/reference/kotlin/androidx/appsearch/app/AppSearchSchema.BooleanPropertyConfig.Builder#setCardinality(int)(cardinality: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html)` Sets the cardinality of the property (whether it is optional, required or repeated). |
| `https://developer.android.com/reference/kotlin/androidx/appsearch/app/AppSearchSchema.BooleanPropertyConfig.Builder` | `@https://developer.android.com/reference/kotlin/androidx/annotation/RequiresFeature(enforcement = "androidx.appsearch.app.Features#isFeatureSupported", name = https://developer.android.com/reference/kotlin/androidx/appsearch/app/Features.SCHEMA_SET_DESCRIPTION) @https://developer.android.com/reference/kotlin/androidx/appsearch/app/ExperimentalAppSearchApi https://developer.android.com/reference/kotlin/androidx/appsearch/app/AppSearchSchema.BooleanPropertyConfig.Builder#setDescription(java.lang.String)(description: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html)` Sets a natural language description of this property. |
| `https://developer.android.com/reference/kotlin/androidx/appsearch/app/AppSearchSchema.BooleanPropertyConfig.Builder` | `@https://developer.android.com/reference/kotlin/androidx/annotation/RequiresFeature(enforcement = "androidx.appsearch.app.Features#isFeatureSupported", name = https://developer.android.com/reference/kotlin/androidx/appsearch/app/Features.SCHEMA_SCORABLE_PROPERTY_CONFIG) @https://developer.android.com/reference/kotlin/androidx/appsearch/app/ExperimentalAppSearchApi https://developer.android.com/reference/kotlin/androidx/appsearch/app/AppSearchSchema.BooleanPropertyConfig.Builder#setScoringEnabled(boolean)(scoringEnabled: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html)` Sets the property enabled or disabled for scoring. |

## Public constructors

### Builder

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/appsearch#1.1.0)

```
Builder(propertyName: String)
```

Creates a new `https://developer.android.com/reference/kotlin/androidx/appsearch/app/AppSearchSchema.BooleanPropertyConfig.Builder`.

## Public functions

### build

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/appsearch#1.1.0)

```
fun build(): AppSearchSchema.BooleanPropertyConfig
```

Constructs a new `https://developer.android.com/reference/kotlin/androidx/appsearch/app/AppSearchSchema.BooleanPropertyConfig` from the contents of this builder.

### setCardinality

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/appsearch#1.1.0)

```
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 `https://developer.android.com/reference/kotlin/androidx/appsearch/app/AppSearchSchema.PropertyConfig#CARDINALITY_OPTIONAL()`.

### setDescription

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/appsearch#1.1.0)

```
@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 `https://developer.android.com/reference/kotlin/androidx/appsearch/app/AppSearchSchema.PropertyConfig#getDescription()`.

### setScoringEnabled

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/appsearch#1.1.0)

```
@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 `https://developer.android.com/reference/kotlin/androidx/appsearch/app/SearchSpec.Builder#setRankingStrategy(java.lang.String)`.