Added in API level 31

Builder

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

Builder for LongPropertyConfig.

Summary

Public constructors
Builder(propertyName: String)

Creates a new LongPropertyConfig.Builder.
Public methods
AppSearchSchema.LongPropertyConfig

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
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
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 LongPropertyConfig.Builder.

Parameters
propertyName String: This value cannot be null.

Public methods

build

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

Constructs a new LongPropertyConfig from the contents of this builder.

Return
AppSearchSchema.LongPropertyConfig This value cannot be null.

setCardinality

Added in API level 31
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 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.LongPropertyConfig.Builder This value cannot be null.

setDescription

Added in T Extensions 18
fun setDescription(description: String): AppSearchSchema.LongPropertyConfig.Builder

Sets a natural language description of this property.

For more details about the description field, see android.app.appsearch.AppSearchSchema.PropertyConfig#getDescription.

Parameters
description String: This value cannot be null.
Return
AppSearchSchema.LongPropertyConfig.Builder This value cannot be null.

setIndexingType

Added in API level 34
Also in T Extensions 7
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 android.app.appsearch.AppSearchSchema.LongPropertyConfig#INDEXING_TYPE_NONE, so that it will not be indexed and cannot be matched by queries.

Parameters
indexingType Int: Value is android.app.appsearch.AppSearchSchema.LongPropertyConfig#INDEXING_TYPE_NONE, or android.app.appsearch.AppSearchSchema.LongPropertyConfig#INDEXING_TYPE_RANGE
Return
AppSearchSchema.LongPropertyConfig.Builder This value cannot be null.

setScoringEnabled

Added in API level 36
Also in T Extensions 17
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 android.app.appsearch.SearchSpec.Builder#setRankingStrategy(java.lang.String).

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