Class WikiSearchSettings

A class containing settings for use when searching with Search(string, WikiSearchSettings?).

Inheritance
object
WikiSearchSettings
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: WikiDotNet
Assembly: Wiki.Net.dll
Syntax
public sealed class WikiSearchSettings

Constructors

| Edit this page View Source

WikiSearchSettings()

Instantiates a new WikiSearchSettings instance

Declaration
public WikiSearchSettings()

Properties

| Edit this page View Source

ExactMatch

Should we only find results that exactly match our search 'Microsoft' results in 'Microsoft' 'Microsof' results in 'no results'

Declaration
public bool ExactMatch { get; set; }
Property Value
TypeDescription
bool
| Edit this page View Source

Language

What wikipedia language to search from.

Default is english (en).

Declaration
public string Language { get; set; }
Property Value
TypeDescription
string
Exceptions
TypeCondition
ArgumentException

Occurs when the given value is null or white space

| Edit this page View Source

Namespaces

What namespaces to search in.

Default is none (null).

Declaration
public List<int>? Namespaces { get; set; }
Property Value
TypeDescription
List<int>
| Edit this page View Source

RequestId

A string that will be returned with the request results.

Useful to distinguish multiple requests.

Declaration
public string? RequestId { get; set; }
Property Value
TypeDescription
string
| Edit this page View Source

ResultLimit

How many results to return.

Default is 10.

Declaration
public int ResultLimit { get; set; }
Property Value
TypeDescription
int
Exceptions
TypeCondition
ArgumentOutOfRangeException

Thrown when the given value is too high or low

| Edit this page View Source

ResultOffset

An amount to offset the search results by.

Useful when scrolling through large groups of pages.

Declaration
public int ResultOffset { get; set; }
Property Value
TypeDescription
int