Description

Result of an index query. Represents a single returned object. This object is a CotcSdk.PropertiesObject, meaning that additional properties can be queried. If you want to check what is returned as a JSON object, simply log this.ToString().

Properties
string	IndexName `[get]`
	The name of the index. More...

string	ObjectId `[get]`
	The ID of the returned object, as passed when indexing the object. More...

Bundle	Payload `[get]`
	Document payload; passed upon indexing the object. More...

Bundle	Properties `[get]`
	Indexed properties. Passed upon indexing the object. More...

int	ResultScore `[get]`
	Score (elastic search term) of the document. More...

Properties inherited from CotcSdk.PropertiesObject
Bundle	this[string key] `[get]`
	Allows to query additional properties via an indexer (can be enriched via hooks). More...

Additional Inherited Members
Public Member Functions inherited from CotcSdk.PropertiesObject
Bundle	AsBundle ()
	Gets the underlying Bundle. Dangerous, only use internally, when you want to put the contents of a properties object into an existing bundle. More...

Dictionary< string, Bundle >.KeyCollection	Keys ()
	Allows to browse all keys (might include some that are already exposed as typed properties in the object). More...

Dictionary< string, Bundle >.Enumerator	GetEnumerator ()
	Allows to browse all keys (might include some that are already exposed as typed properties in the object). More...

override string	ToString ()
	You may use this to debug what is inside this property object. More...

string	ToJson ()
	Builds a JSON representation of this object, same as ToString actually. More...

Protected Member Functions inherited from CotcSdk.PropertiesObject
	PropertiesObject (Bundle baseData)

Protected Attributes inherited from CotcSdk.PropertiesObject
Bundle	Props

Inheritance diagram for CotcSdk.IndexResult:

Property Documentation

◆ IndexName

string CotcSdk.IndexResult.IndexName

get

The name of the index.

◆ ObjectId

string CotcSdk.IndexResult.ObjectId

get

The ID of the returned object, as passed when indexing the object.

◆ Payload

Bundle CotcSdk.IndexResult.Payload

get

Document payload; passed upon indexing the object.

◆ Properties

Bundle CotcSdk.IndexResult.Properties

get

Indexed properties. Passed upon indexing the object.

◆ ResultScore

int CotcSdk.IndexResult.ResultScore

get

Score (elastic search term) of the document.