MatchInfo

Kotlin |Java

class MatchInfo : Parcelable

kotlin.Any
↳	android.app.appsearch.SearchResult.MatchInfo

This class represents match objects for any snippets that might be present in SearchResults from a query.

A MatchInfo contains either a android.app.appsearch.SearchResult.TextMatchInfo representing a text match snippet, or an android.app.appsearch.SearchResult.EmbeddingMatchInfo representing an embedding match snippet.

Summary

Nested classes
	`Builder` Builder for `MatchInfo` objects.

Inherited constants

From class Parcelable

Int

CONTENTS_FILE_DESCRIPTOR

Descriptor bit used with describeContents(): indicates that the Parcelable object's flattened representation includes a file descriptor.

Int

PARCELABLE_WRITE_RETURN_VALUE

Flag for use with writeToParcel: the object being written is a return value, that is the result of a function such as "Parcelable someFunction()", "void someFunction(out Parcelable)", or "void someFunction(inout Parcelable)". Some implementations may want to release resources at this point.

Public methods
CharSequence	`getExactMatch()` Gets the exact term of the given entry that matched the query.
SearchResult.MatchRange	`getExactMatchRange()` Gets the `MatchRange` of the exact term of the given entry that matched the query.
String	`getFullText()` Gets the full text corresponding to the given entry.
String	`getPropertyPath()` Gets the property path corresponding to the given entry.
PropertyPath	`getPropertyPathObject()` Gets a `PropertyPath` object representing the property path corresponding to the given entry.
CharSequence	`getSnippet()` Gets the snippet corresponding to the given entry.
SearchResult.MatchRange	`getSnippetRange()` Gets the snippet `MatchRange` corresponding to the given entry.
CharSequence	`getSubmatch()` Gets the exact term subsequence of the given entry that matched the query.
SearchResult.MatchRange	`getSubmatchRange()` Gets the `MatchRange` of the submatch term subsequence of the given entry that matched the query.
Unit	`writeToParcel(dest: Parcel, flags: Int)` Flatten this object in to a Parcel.

Properties
static Parcelable.Creator<SearchResult.MatchInfo!>	`CREATOR`

Public methods

getExactMatch

Added in API level 31

fun getExactMatch(): CharSequence

Gets the exact term of the given entry that matched the query. Returns an empty CharSequence if the match is not text-based.

Return
`CharSequence`	This value cannot be `null`.

getExactMatchRange

Added in API level 31

fun getExactMatchRange(): SearchResult.MatchRange

Gets the MatchRange of the exact term of the given entry that matched the query. Returns [0, 0] if the match is not text-based.

Return
`SearchResult.MatchRange`	This value cannot be `null`.

getFullText

Added in API level 31

fun getFullText(): String

Gets the full text corresponding to the given entry. Returns an empty string if the match is not text-based.

Return
`String`	This value cannot be `null`.

getPropertyPath

Added in API level 31

fun getPropertyPath(): String

Gets the property path corresponding to the given entry.

A property path is a '.' - delimited sequence of property names indicating which property in the document these snippets correspond to.

Example properties: 'body', 'sender.name', 'sender.emailaddress', etc. For class example 1 this returns "subject"

Return
`String`	This value cannot be `null`.

getPropertyPathObject

Added in API level 34
Also in T Extensions 7

fun getPropertyPathObject(): PropertyPath

Gets a PropertyPath object representing the property path corresponding to the given entry.

Methods such as GenericDocument.getPropertyDocument accept a path as a string rather than a PropertyPath object. However, you may want to manipulate the path before getting a property document. This method returns a PropertyPath rather than a String for easier path manipulation, which can then be converted to a String.

Return
`PropertyPath`	This value cannot be `null`.

See Also

getSnippet

Added in API level 31

fun getSnippet(): CharSequence

Gets the snippet corresponding to the given entry. Returns an empty CharSequence if the match is not text-based.

Snippet - Provides a subset of the content to display. Only populated when requested maxSnippetSize > 0. The size of this content can be changed by android.app.appsearch.SearchSpec.Builder#setMaxSnippetSize. Windowing is centered around the middle of the matched token with content on either side clipped to token boundaries.

Return
`CharSequence`	This value cannot be `null`.

getSnippetRange

Added in API level 31

fun getSnippetRange(): SearchResult.MatchRange

Gets the snippet MatchRange corresponding to the given entry. Returns [0,0] if the match is not text-based.

Only populated when set maxSnippetSize > 0 in android.app.appsearch.SearchSpec.Builder#setMaxSnippetSize.

Return
`SearchResult.MatchRange`	This value cannot be `null`.

getSubmatch

Added in API level 33
Also in T Extensions 3

fun getSubmatch(): CharSequence

Gets the exact term subsequence of the given entry that matched the query. Returns an empty CharSequence if the match is not text-based.

Return
`CharSequence`	This value cannot be `null`.

getSubmatchRange

Added in API level 33
Also in T Extensions 3

fun getSubmatchRange(): SearchResult.MatchRange

Gets the MatchRange of the submatch term subsequence of the given entry that matched the query. Returns [0, 0] if the match is not text-based.

Return
`SearchResult.MatchRange`	This value cannot be `null`.

writeToParcel

Added in API level 35

fun writeToParcel(
    dest: Parcel, 
    flags: Int
): Unit

Flatten this object in to a Parcel.

Parameters
`dest`	Parcel: This value cannot be `null`.
`flags`	Int: Additional flags about how the object should be written. May be 0 or `PARCELABLE_WRITE_RETURN_VALUE`. Value is either `0` or a combination of `android.os.Parcelable#PARCELABLE_WRITE_RETURN_VALUE`, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES

Properties

CREATOR

Added in API level 35
Also in T Extensions 13

static val CREATOR: Parcelable.Creator<SearchResult.MatchInfo!>