Added in API level 31

StringPropertyConfig

class StringPropertyConfig : AppSearchSchema.PropertyConfig
kotlin.Any
   ↳ android.app.appsearch.AppSearchSchema.PropertyConfig
   ↳ android.app.appsearch.AppSearchSchema.StringPropertyConfig

Configuration for a property of type String in a Document.

Summary

Nested classes

Builder for StringPropertyConfig.

Constants
static Int

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

static Int

Content in this property will not be tokenized or indexed.

static 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.

static Int

Content in this property is not joinable.

static Int

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

static Int

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

static Int

Tokenization for plain text.

static Int

Tokenization for emails.

static Int

This value indicates that no normalization or segmentation should be applied to string values that are tokenized using this type.

Inherited constants
Public methods
Int

Returns how the property is indexed.

Int

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

Int

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

Inherited functions

Constants

INDEXING_TYPE_EXACT_TERMS

Added in API level 31
static val INDEXING_TYPE_EXACT_TERMS: 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".

Value: 1

INDEXING_TYPE_NONE

Added in API level 31
static val INDEXING_TYPE_NONE: Int

Content in this property will not be tokenized or indexed.

Value: 0

INDEXING_TYPE_PREFIXES

Added in API level 31
static val INDEXING_TYPE_PREFIXES: 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".

Value: 2

JOINABLE_VALUE_TYPE_NONE

Added in API level 34
static val JOINABLE_VALUE_TYPE_NONE: Int

Content in this property is not joinable.

Value: 0

JOINABLE_VALUE_TYPE_QUALIFIED_ID

Added in API level 34
static val JOINABLE_VALUE_TYPE_QUALIFIED_ID: Int

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

Value: 1

TOKENIZER_TYPE_NONE

Added in API level 31
static val TOKENIZER_TYPE_NONE: 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.

Value: 0

TOKENIZER_TYPE_PLAIN

Added in API level 31
static val TOKENIZER_TYPE_PLAIN: 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.

Value: 1

TOKENIZER_TYPE_RFC822

Added in API level 34
static val TOKENIZER_TYPE_RFC822: 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.

Value: 3

TOKENIZER_TYPE_VERBATIM

Added in API level 34
static val TOKENIZER_TYPE_VERBATIM: 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.

Value: 2

Public methods

getJoinableValueType

Added in API level 34
fun getJoinableValueType(): Int

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

Return
Int Value is android.app.appsearch.AppSearchSchema.StringPropertyConfig#JOINABLE_VALUE_TYPE_NONE, or android.app.appsearch.AppSearchSchema.StringPropertyConfig#JOINABLE_VALUE_TYPE_QUALIFIED_ID