AppSearchSchema.StringPropertyConfig

@ExperimentalAppSearchApi
const val DELETE_PROPAGATION_TYPE_NONE = 0: Int

Does not propagate deletion.

@RequiresFeature(enforcement = "androidx.appsearch.app.Features#isFeatureSupported", name = Features
                        .SCHEMA_STRING_PROPERTY_CONFIG_DELETE_PROPAGATION_TYPE_PROPAGATE_FROM)
@ExperimentalAppSearchApi
const val DELETE_PROPAGATION_TYPE_PROPAGATE_FROM = 1: Int

Content in this string property will be used as a qualified id referring to another (parent) document, and the deletion of the referenced document will propagate to this (child) document.

Please note that this propagates further. If the child document has any children that also set delete propagation type PROPAGATE_FROM for their joinable properties, then those (grandchild) documents will be deleted.

Since delete propagation works between the document and the referenced document, if setting this type for delete propagation, the string property should also be qualified id joinable (i.e. having JOINABLE_VALUE_TYPE_QUALIFIED_ID for the joinable value type). Otherwise, throw IllegalStateException when building (see build).

const val INDEXING_TYPE_EXACT_TERMS = 1: Int

Content in this property should only be returned for queries matching the exact tokens appearing in this property.

For example, a property with "fool" should NOT match a query for "foo".

const val INDEXING_TYPE_NONE = 0: Int

Content in this property will not be tokenized or indexed.

const val INDEXING_TYPE_PREFIXES = 2: Int

Content in this property should be returned for queries that are either exact matches or query matches of the tokens appearing in this property.

For example, a property with "fool" should match a query for "foo".

const val JOINABLE_VALUE_TYPE_NONE = 0: Int

Content in this property is not joinable.

@RequiresFeature(enforcement = "androidx.appsearch.app.Features#isFeatureSupported", name = Features.JOIN_SPEC_AND_QUALIFIED_ID)
const val JOINABLE_VALUE_TYPE_QUALIFIED_ID = 1: Int

Content in this string property will be used as a qualified id to join documents.

• Qualified id: a unique identifier for a document, and this joinable value type is similar to primary and foreign key in relational database. See androidx.appsearch.util.DocumentIdUtil for more details.
• Currently we only support single string joining, so it should only be used with CARDINALITY_OPTIONAL and CARDINALITY_REQUIRED.

const val TOKENIZER_TYPE_NONE = 0: Int

This value indicates that no tokens should be extracted from this property.

It is only valid for tokenizer_type to be 'NONE' if getIndexingType is INDEXING_TYPE_NONE.

const val TOKENIZER_TYPE_PLAIN = 1: Int

Tokenization for plain text. This value indicates that tokens should be extracted from this property based on word breaks. Segments of whitespace and punctuation are not considered tokens.

For example, a property with "foo bar. baz." will produce tokens for "foo", "bar" and "baz". The segments " " and "." will not be considered tokens.

It is only valid for tokenizer_type to be 'PLAIN' if getIndexingType is INDEXING_TYPE_EXACT_TERMS or INDEXING_TYPE_PREFIXES.

@RequiresFeature(enforcement = "androidx.appsearch.app.Features#isFeatureSupported", name = Features.TOKENIZER_TYPE_RFC822)
const val TOKENIZER_TYPE_RFC822 = 3: Int

Tokenization for emails. This value indicates that tokens should be extracted from this property based on email structure.

For example, a property with "alex.sav@google.com" will produce tokens for "alex", "sav", "alex.sav", "google", "com", and "alexsav@google.com"

It is only valid for tokenizer_type to be 'RFC822' if getIndexingType is INDEXING_TYPE_EXACT_TERMS or INDEXING_TYPE_PREFIXES.

@RequiresFeature(enforcement = "androidx.appsearch.app.Features#isFeatureSupported", name = Features.VERBATIM_SEARCH)
const val TOKENIZER_TYPE_VERBATIM = 2: Int

This value indicates that no normalization or segmentation should be applied to string values that are tokenized using this type. Therefore, the output token is equivalent to the raw string value.

For example, a property with "Hello, world!" will produce the token "Hello, world!", preserving punctuation and capitalization, and not creating separate tokens between the space.

It is only valid for tokenizer_type to be 'VERBATIM' if getIndexingType is INDEXING_TYPE_EXACT_TERMS or INDEXING_TYPE_PREFIXES.

@ExperimentalAppSearchApi
fun getDeletePropagationType(): Int

Returns how the deletion will be propagated between this document and the referenced document whose qualified id is held by this property.

fun getIndexingType(): Int

Returns how the property is indexed.

fun getJoinableValueType(): Int

Returns how this property is going to be used to join documents from other schema types.

fun getTokenizerType(): Int

Returns how this property is tokenized (split into words).