SearchResult.RankingSignal Property

Definition

Returns the ranking signal of the GenericDocument, according to the ranking strategy set in SearchSpec.Builder#setRankingStrategy(int).

public double RankingSignal { [Android.Runtime.Register("getRankingSignal", "()D", "", ApiSince=31)] get; }
[<get: Android.Runtime.Register("getRankingSignal", "()D", "", ApiSince=31)>]
member this.RankingSignal : double

Property Value

Ranking signal of the document

Attributes

Remarks

Returns the ranking signal of the GenericDocument, according to the ranking strategy set in SearchSpec.Builder#setRankingStrategy(int).

The meaning of the ranking signal and its value is determined by the selected ranking strategy:

<ul> <li>SearchSpec#RANKING_STRATEGY_NONE - this value will be 0 <li>SearchSpec#RANKING_STRATEGY_DOCUMENT_SCORE - the value returned by calling GenericDocument#getScore() on the document returned by #getGenericDocument()<li>SearchSpec#RANKING_STRATEGY_CREATION_TIMESTAMP - the value returned by calling GenericDocument#getCreationTimestampMillis() on the document returned by #getGenericDocument()<li>SearchSpec#RANKING_STRATEGY_RELEVANCE_SCORE - an arbitrary double value where a higher value means more relevant <li>SearchSpec#RANKING_STRATEGY_USAGE_COUNT - the number of times usage has been reported for the document returned by #getGenericDocument()<li>SearchSpec#RANKING_STRATEGY_USAGE_LAST_USED_TIMESTAMP - the timestamp of the most recent usage that has been reported for the document returned by #getGenericDocument()</ul>

Java documentation for android.app.appsearch.SearchResult.getRankingSignal().

Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.

Applies to