SearchResults In-Process API Event Argument

Verint | Telligent Community — Wed, 14 May 2025 16:49:44 GMT

Current Revision posted to API Documentation by Verint | Telligent Community on 05/14/2025 16:49:44

SearchResults is defined in the Telligent.Evolution.Extensibility.Api.Entities.Version1 namespace.

Definition

class SearchResults : [[PagedList(T) In-Process API Supplementary Type|PagedList]]<[[SearchResult In-Process API Event Argument|SearchResult]]>, ICloneable, IPagedList<[[SearchResult In-Process API Event Argument|SearchResult]]>
{
	SearchResults();
	SearchResults([[AdditionalInfo In-Process API Supplementary Type|AdditionalInfo]] additionalInfo);
	SearchResults([[Error In-Process API Event Argument|Error]] error);
	SearchResults([[Warning In-Process API Event Argument|Warning]] warning);
	SearchResults(IList<[[Warning In-Process API Event Argument|Warning]]> warnings, IList<[[Error In-Process API Event Argument|Error]]> errors);
	SearchResults(IEnumerable<[[SearchResult In-Process API Event Argument|SearchResult]]> items, int pageSize, int pageIndex, int totalCount);
	SearchResults(IEnumerable<[[SearchResult In-Process API Event Argument|SearchResult]]> items, int pageSize, int pageIndex, int totalCount, IEnumerable<[[FieldFacetResult In-Process API Event Argument|FieldFacetResult]]> fieldFacets);
	IList<string> Categories { get; set;  }
	int Count { get;  }
	IList<[[DateRangeFacetResult In-Process API Event Argument|DateRangeFacetResult]]> DateRangeFacets { get; set;  }
	double Duration { get; set;  }
	IList<[[Error In-Process API Event Argument|Error]]> Errors { get;  }
	IList<[[FieldFacetResult In-Process API Event Argument|FieldFacetResult]]> FieldFacets { get; set;  }
	bool IsReadOnly { get;  }
	[[SearchResult In-Process API Event Argument|SearchResult]] Item[int] { get; set;  }
	int PageIndex { get; set;  }
	int PageSize { get; set;  }
	int TotalCount { get; set;  }
	IList<[[Warning In-Process API Event Argument|Warning]]> Warnings { get;  }
	void Add([[SearchResult In-Process API Event Argument|SearchResult]] item);
	[[SearchResult In-Process API Event Argument|SearchResult]][] AsArray();
	void Clear();
	Object Clone();
	bool Contains([[SearchResult In-Process API Event Argument|SearchResult]] item);
	void CopyTo([[SearchResult In-Process API Event Argument|SearchResult]][] array, int arrayIndex);
	void ForEach(Action<[[SearchResult In-Process API Event Argument|SearchResult]]> action);
	IEnumerator<[[SearchResult In-Process API Event Argument|SearchResult]]> GetEnumerator();
	bool HasErrors();
	int IndexOf([[SearchResult In-Process API Event Argument|SearchResult]] item);
	void Insert(int index, [[SearchResult In-Process API Event Argument|SearchResult]] item);
	bool Remove([[SearchResult In-Process API Event Argument|SearchResult]] item);
	void RemoveAt(int index);
	void ThrowErrors();
}

Constructors

SearchResults();

SearchResults(AdditionalInfo additionalInfo);

Parameters

Name	Type	Description	Required	Default	Options
additionalInfo	`[[AdditionalInfo In-Process API Supplementary Type\|AdditionalInfo]]`	Additional Info	Required

SearchResults(Error error);

Parameters

Name	Type	Description	Required	Default	Options
error	`[[Error In-Process API Event Argument\|Error]]`	Error	Required

SearchResults(Warning warning);

Parameters

Name	Type	Description	Required	Default	Options
warning	`[[Warning In-Process API Event Argument\|Warning]]`	Warning	Required

SearchResults(IList<Warning> warnings, IList<Error> errors);

Parameters

Name	Type	Description	Required	Default	Options
warnings	`IList<[[Warning In-Process API Event Argument\|Warning]]>`	Warnings	Required
errors	`IList<[[Error In-Process API Event Argument\|Error]]>`	Errors	Required

SearchResults(IEnumerable<SearchResult> items, int pageSize, int pageIndex, int totalCount);

Parameters

Name	Type	Description	Required
items	`IEnumerable<[[SearchResult In-Process API Event Argument\|SearchResult]]>`	Items	Required
pageSize	`int`	Page Size	Required
pageIndex	`int`	Page Index	Required
totalCount	`int`	Total Count	Required

SearchResults(IEnumerable<SearchResult> items, int pageSize, int pageIndex, int totalCount, IEnumerable<FieldFacetResult> fieldFacets);

Parameters

Name	Type	Description	Required
items	`IEnumerable<[[SearchResult In-Process API Event Argument\|SearchResult]]>`	Items	Required
pageSize	`int`	Page Size	Required
pageIndex	`int`	Page Index	Required
totalCount	`int`	Total Count	Required
fieldFacets	`IEnumerable<[[FieldFacetResult In-Process API Event Argument\|FieldFacetResult]]>`	Field Facets	Required

Properties

Name	Type	Description	Default	Options
Categories	`IList<string>`
Count	`int`
DateRangeFacets	`IList<[[DateRangeFacetResult In-Process API Event Argument\|DateRangeFacetResult]]>`
Duration	`double`
Errors	`IList<[[Error In-Process API Event Argument\|Error]]>`
FieldFacets	`IList<[[FieldFacetResult In-Process API Event Argument\|FieldFacetResult]]>`
IsReadOnly	`bool`
Item[int]	`[[SearchResult In-Process API Event Argument\|SearchResult]]`
PageIndex	`int`
PageSize	`int`
TotalCount	`int`
Warnings	`IList<[[Warning In-Process API Event Argument\|Warning]]>`

Methods

void Add(SearchResult item);

Parameters

Name	Type	Description	Required	Default	Options
item	`[[SearchResult In-Process API Event Argument\|SearchResult]]`	Item	Required

SearchResult[] AsArray();

Return Type

[[SearchResult In-Process API Event Argument|SearchResult]][]

void Clear();

Object Clone();

Return Type

Object

bool Contains(SearchResult item);

Parameters

Name	Type	Description	Required	Default	Options
item	`[[SearchResult In-Process API Event Argument\|SearchResult]]`	Item	Required

Return Type

bool

void CopyTo(SearchResult[] array, int arrayIndex);

Parameters

Name	Type	Description	Required	Default	Options
array	`[[SearchResult In-Process API Event Argument\|SearchResult]][]`	Array	Required
arrayIndex	`int`	Array Index	Required

void ForEach(Action<SearchResult> action);

Parameters

Name	Type	Description	Required	Default	Options
action	`Action<[[SearchResult In-Process API Event Argument\|SearchResult]]>`	Action	Required

IEnumerator<SearchResult> GetEnumerator();

Return Type

IEnumerator<[[SearchResult In-Process API Event Argument|SearchResult]]>

bool HasErrors();

Return Type

bool

int IndexOf(SearchResult item);

Parameters

Name	Type	Description	Required	Default	Options
item	`[[SearchResult In-Process API Event Argument\|SearchResult]]`	Item	Required

Return Type

int

void Insert(int index, SearchResult item);

Parameters

Name	Type	Description	Required	Default	Options
index	`int`	Index	Required
item	`[[SearchResult In-Process API Event Argument\|SearchResult]]`	Item	Required

bool Remove(SearchResult item);

Parameters

Name	Type	Description	Required	Default	Options
item	`[[SearchResult In-Process API Event Argument\|SearchResult]]`	Item	Required

Return Type

bool

void RemoveAt(int index);

Parameters

Name	Type	Description	Required	Default	Options
index	`int`	Index	Required