Added in API level 31

Builder

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

Builder for StringPropertyConfig.

Summary

Public constructors
Builder(propertyName: String)

Creates a new StringPropertyConfig.Builder.

Public methods
AppSearchSchema.StringPropertyConfig

Constructs a new StringPropertyConfig from the contents of this builder.

AppSearchSchema.StringPropertyConfig.Builder
setCardinality(cardinality: Int)

Sets the cardinality of the property (whether it is optional, required or repeated).

AppSearchSchema.StringPropertyConfig.Builder
setIndexingType(indexingType: Int)

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

AppSearchSchema.StringPropertyConfig.Builder
setJoinableValueType(joinableValueType: Int)

Configures how this property should be used as a joining matcher.

AppSearchSchema.StringPropertyConfig.Builder
setTokenizerType(tokenizerType: Int)

Configures how this property should be tokenized (split into words).

Public constructors

Builder

Added in API level 31
Builder(propertyName: String)

Creates a new StringPropertyConfig.Builder.

Parameters
propertyName String: This value cannot be null.

Public methods

build

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

Constructs a new StringPropertyConfig from the contents of this builder.

Return
AppSearchSchema.StringPropertyConfig This value cannot be null.

setCardinality

Added in API level 31
fun setCardinality(cardinality: Int): AppSearchSchema.StringPropertyConfig.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.StringPropertyConfig.Builder This value cannot be null.

setIndexingType

Added in API level 31
fun setIndexingType(indexingType: Int): AppSearchSchema.StringPropertyConfig.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.StringPropertyConfig#INDEXING_TYPE_NONE, so that it cannot be matched by queries.

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

setJoinableValueType

Added in API level 34
fun setJoinableValueType(joinableValueType: Int): AppSearchSchema.StringPropertyConfig.Builder

Configures how this property should be used as a joining matcher.

If this method is not called, the default joinable value type is android.app.appsearch.AppSearchSchema.StringPropertyConfig#JOINABLE_VALUE_TYPE_NONE, so that it is not joinable.

At most, 64 properties can be set as joinable per schema.

Parameters
joinableValueType Int: Value is android.app.appsearch.AppSearchSchema.StringPropertyConfig#JOINABLE_VALUE_TYPE_NONE, or android.app.appsearch.AppSearchSchema.StringPropertyConfig#JOINABLE_VALUE_TYPE_QUALIFIED_ID
Return
AppSearchSchema.StringPropertyConfig.Builder This value cannot be null.