Interface ISearchResult

Namespace

Examine

Assembly

Examine.Core.dll

Represents a search result

public interface ISearchResult

Properties

AllValues

Returns the values in the result

IReadOnlyDictionary<string, IReadOnlyList<string>> AllValues { get; }

Property Value

IReadOnlyDictionary<string, IReadOnlyList<string>>

Remarks

This is used to retrieve multiple values per field if there are any

Id

The id of the search result

string Id { get; }

Property Value

string

this[int]

Returns the key value pair for the index specified

KeyValuePair<string, string> this[int resultIndex] { get; }

Parameters

resultIndex int

Property Value

KeyValuePair<string, string>

this[string]

Returns the value for the key specified

string? this[string key] { get; }

Parameters

key string

Property Value

string

Score

The score of the search result

float Score { get; }

Property Value

float

Values

Returns the values in the result

IReadOnlyDictionary<string, string> Values { get; }

Property Value

IReadOnlyDictionary<string, string>

Methods

GetValues(string)

If a single field was indexed with multiple values this will return those values, otherwise it will just return the single value stored for that field. If the field is not found it returns an empty collection.

IEnumerable<string> GetValues(string key)

Parameters

key string

Returns

IEnumerable<string>