Class ValueSet

Namespace

Examine

Assembly

Examine.Core.dll

Represents an item to be indexed

public class ValueSet

Inheritance

object

ValueSet

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

ValueSet(string)

Constructor that only specifies an ID

public ValueSet(string id)

Parameters

id string

Remarks

normally used for deletions

ValueSet(string, string, IDictionary<string, IEnumerable<object>>)

Constructor

public ValueSet(string id, string category, IDictionary<string, IEnumerable<object>> values)

Parameters

id string

category string

Used to categorize the item in the index (in umbraco terms this would be content vs media)

values IDictionary<string, IEnumerable<object>>

ValueSet(string, string, IDictionary<string, object>)

Constructor

public ValueSet(string id, string category, IDictionary<string, object> values)

Parameters

id string

category string

Used to categorize the item in the index (in umbraco terms this would be content vs media)

values IDictionary<string, object>

ValueSet(string, string?, string?, IDictionary<string, IEnumerable<object>>)

Primary constructor

public ValueSet(string id, string? category, string? itemType, IDictionary<string, IEnumerable<object>> values)

Parameters

id string

category string

Used to categorize the item in the index (in umbraco terms this would be content vs media)

itemType string

The item's node type (in umbraco terms this would be the doc type alias)

values IDictionary<string, IEnumerable<object>>

ValueSet(string, string, string, IDictionary<string, object>)

Constructor

public ValueSet(string id, string category, string itemType, IDictionary<string, object> values)

Parameters

id string

category string

Used to categorize the item in the index (in umbraco terms this would be content vs media)

itemType string

values IDictionary<string, object>

Properties

Category

The index category

public string? Category { get; }

Property Value

string

Remarks

Used to categorize the item in the index (in umbraco terms this would be content vs media)

Id

The id of the object to be indexed

public string Id { get; }

Property Value

string

ItemType

The item's node type (in umbraco terms this would be the doc type alias)

public string? ItemType { get; }

Property Value

string

Values

The values to be indexed

public IReadOnlyDictionary<string, IReadOnlyList<object>>? Values { get; }

Property Value

IReadOnlyDictionary<string, IReadOnlyList<object>>

Methods

Clone()

Clones the value set

public ValueSet Clone()

Returns

ValueSet

FromObject(string, string, object)

Creates a value set from an object

public static ValueSet FromObject(string id, string category, object values)

Parameters

id string

category string

values object

Returns

ValueSet

FromObject(string, string, string, object)

Creates a value set from an object

public static ValueSet FromObject(string id, string category, string itemType, object values)

Parameters

id string

category string

itemType string

values object

Returns

ValueSet

GetValue(string)

Gets a single value for the key

public object? GetValue(string key)

Parameters

key string

Returns

object

If there are multiple values, this will return the first

GetValues(string)

Gets the values for the key

public IEnumerable<object> GetValues(string key)

Parameters

key string

Returns

IEnumerable<object>