Class SearchOptions

Namespace

PnP.Core.Model.SharePoint

Assembly

PnP.Core.dll

Defines the search query to make

public class SearchOptions

Inheritance

object

SearchOptions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

SearchOptions(string)

Default constructor

public SearchOptions(string query)

Parameters

query string

Provide the query to issue

Properties

ClientType

Client type used for the search query (defaults to ContentSearchRegular)

public string ClientType { get; set; }

Property Value

string

Query

Search query to issue

public string Query { get; }

Property Value

string

RefineProperties

Properties used to refine the search results

public List<string> RefineProperties { get; set; }

Property Value

List<string>

RefinementFilters

The set of refinement filters used when issuing a refinement query

public List<string> RefinementFilters { get; set; }

Property Value

List<string>

ResultSourceId

Result source id to use for the search query

public string ResultSourceId { get; set; }

Property Value

string

RowLimit

Max number of rows to return

public int? RowLimit { get; set; }

Property Value

int?

RowsPerPage

Rows to return per page. Defaults to 500

public int? RowsPerPage { get; set; }

Property Value

int?

SelectProperties

Properties to select

public List<string> SelectProperties { get; set; }

Property Value

List<string>

SortProperties

Properties to sort the query on

public List<SortOption> SortProperties { get; set; }

Property Value

List<SortOption>

StartRow

Start row of the search result set

public int? StartRow { get; set; }

Property Value

int?

TrimDuplicates

Trim duplicate search results

public bool TrimDuplicates { get; set; }

Property Value

bool