Interface ISearchResults

Contains general search results returned by the search provider.

Namespace: Mediachase.Search
Assembly: Mediachase.Search.dll
Version: 10.8.0
Syntax
public interface ISearchResults

Properties

Documents

Gets the documents that are contained within current results.

Declaration
ISearchDocuments Documents { get; }
Property Value
Type Description
ISearchDocuments

The documents.

FacetGroups

Gets or sets the facet groups.

Declaration
ISearchFacetGroup[] FacetGroups { get; set; }
Property Value
Type Description
ISearchFacetGroup[]

The facet groups.

SearchCriteria

Gets the search criteria that was used to generate search results.

Declaration
ISearchCriteria SearchCriteria { get; }
Property Value
Type Description
ISearchCriteria

The search criteria.

Suggestions

Gets or sets the suggestions.

Declaration
string[] Suggestions { get; set; }
Property Value
Type Description
System.String[]

The suggestions.

TotalCount

Gets the total count of all results that we can potentially return.

Declaration
int TotalCount { get; }
Property Value
Type Description
System.Int32

The total count.

Methods

GetFieldValue<T>(Int32, String)

Gets the field value converted to the type specified.

Declaration
T[] GetFieldValue<T>(int index, string fieldName)
Parameters
Type Name Description
System.Int32 index

The index.

System.String fieldName

Name of the field.

Returns
Type Description
T[]
Type Parameters
Name Description
T

GetKeyFieldValues<T>()

Gets the array of values from the key field defined in the ISearchCriteria.

Declaration
T[] GetKeyFieldValues<T>()
Returns
Type Description
T[]
Type Parameters
Name Description
T