AppSearchSchema.LongPropertyConfig.Builder

Artifact: androidx.appsearch:appsearch

View Source

Added in 1.1.0-alpha07

---

Kotlin |Java

class AppSearchSchema.LongPropertyConfig.Builder

---

Builder for LongPropertyConfig.

Summary

Public constructors
Builder(propertyName: String) Creates a new LongPropertyConfig.Builder.

Public functions
AppSearchSchema.LongPropertyConfig	build() Constructs a new LongPropertyConfig from the contents of this builder.
AppSearchSchema.LongPropertyConfig.Builder	setCardinality(cardinality: Int) Sets the cardinality of the property (whether it is optional, required or repeated).
AppSearchSchema.LongPropertyConfig.Builder	@RequiresFeature(enforcement = "androidx.appsearch.app.Features#isFeatureSupported", name = Features.SCHEMA_SET_DESCRIPTION) @ExperimentalAppSearchApi setDescription(description: String) Sets a natural language description of this property.
AppSearchSchema.LongPropertyConfig.Builder	setIndexingType(indexingType: Int) Configures how a property should be indexed so that it can be retrieved by queries.
AppSearchSchema.LongPropertyConfig.Builder	@RequiresFeature(enforcement = "androidx.appsearch.app.Features#isFeatureSupported", name = Features.SCHEMA_SCORABLE_PROPERTY_CONFIG) @ExperimentalAppSearchApi setScoringEnabled(scoringEnabled: Boolean) Sets the property enabled or disabled for scoring.

Public constructors

Builder

Added in 1.1.0-alpha07

Builder(propertyName: String)

Creates a new LongPropertyConfig.Builder.

Public functions

build

Added in 1.1.0-alpha07

fun build(): AppSearchSchema.LongPropertyConfig

Constructs a new LongPropertyConfig from the contents of this builder.

setCardinality

Added in 1.1.0-alpha07

fun setCardinality(cardinality: Int): AppSearchSchema.LongPropertyConfig.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-alpha07

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

Sets a natural language description of this property.

For more details about the description field, see getDescription.

setIndexingType

Added in 1.1.0-alpha07

fun setIndexingType(indexingType: Int): AppSearchSchema.LongPropertyConfig.Builder

Configures how a property should be indexed so that it can be retrieved by queries.

If this method is not called, the default indexing type is INDEXING_TYPE_NONE, so that it will not be indexed and cannot be matched by queries.

setScoringEnabled

Added in 1.1.0-alpha07

@RequiresFeature(enforcement = "androidx.appsearch.app.Features#isFeatureSupported", name = Features.SCHEMA_SCORABLE_PROPERTY_CONFIG)
@ExperimentalAppSearchApi
fun setScoringEnabled(scoringEnabled: Boolean): AppSearchSchema.LongPropertyConfig.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.