SearchResults Script API Type

Verint | Telligent Community — Wed, 14 May 2025 17:06:10 GMT

Current Revision posted to API Documentation by Verint | Telligent Community on 05/14/2025 17:06:10

Properties

Name	Access	Type	Description
Categories	Read, Write	`[[List Script API Type\|List]] of [[String Script API Type\|String]]`	Categories
Count	Read	`[[Number Script API Type\|Number]]`	Count
DateRangeFacets	Read, Write	`[[List Script API Type\|List]] of [[DateRangeFacetResult Script API Type\|DateRangeFacetResult]]`	Date Range Facets
Duration	Read, Write	`[[Number Script API Type\|Number]]`	Duration
Errors	Read	`[[List Script API Type\|List]] of [[Error Script API Type\|Error]]`	Errors
FieldFacets	Read, Write	`[[List Script API Type\|List]] of [[FieldFacetResult Script API Type\|FieldFacetResult]]`	Field Facets
IsReadOnly	Read	`[[Boolean Script API Type\|Boolean]]`	Is Read Only
PageIndex	Read, Write	`[[Number Script API Type\|Number]]`	Page Index
PageSize	Read, Write	`[[Number Script API Type\|Number]]`	Page Size
TotalCount	Read, Write	`[[Number Script API Type\|Number]]`	Total Count
Warnings	Read	`[[List Script API Type\|List]] of [[Warning Script API Type\|Warning]]`	Warnings

Methods

Add

Velocity

$searchResults.Add($item)

JavaScript

searchResults.Add(item);

Parameters

Name	Type	Description	Required	Default	Options
item	`[[SearchResult Script API Type\|SearchResult]]`	Item	Required

Returns

Nothing

AsArray

Velocity

#set($searchResultResponse = $searchResults.AsArray())

JavaScript

var searchResultResponse = searchResults.AsArray();

Returns

Array of [[SearchResult Script API Type|SearchResult]]

Clear

Velocity

$searchResults.Clear()

JavaScript

searchResults.Clear();

Returns

Nothing

Contains

Velocity

#set($booleanResponse = $searchResults.Contains($item))

JavaScript

var booleanResponse = searchResults.Contains(item);

Parameters

Name	Type	Description	Required	Default	Options
item	`[[SearchResult Script API Type\|SearchResult]]`	Item	Required

Returns

[[Boolean Script API Type|Boolean]]

CopyTo

Velocity

$searchResults.CopyTo($array, $arrayIndex)

JavaScript

searchResults.CopyTo(array, arrayIndex);

Parameters

Name	Type	Description	Required	Default	Options
array	`Array of [[SearchResult Script API Type\|SearchResult]]`	Array	Required
arrayIndex	`[[Number Script API Type\|Number]]`	Array Index	Required

Returns

Nothing

get_Item

Velocity

#set($searchResultResponse = $searchResults.get_Item($index))

JavaScript

var searchResultResponse = searchResults.get_Item(index);

Parameters

Name	Type	Description	Required	Default	Options
index	`[[Number Script API Type\|Number]]`	Index	Required

Returns

[[SearchResult Script API Type|SearchResult]]

GetEnumerator

Velocity

#set($iEnumeratorResponse = $searchResults.GetEnumerator())

JavaScript

var iEnumeratorResponse = searchResults.GetEnumerator();

Returns

[[IEnumerator Script API Type|IEnumerator]] of [[SearchResult Script API Type|SearchResult]]

HasErrors

Velocity

#set($booleanResponse = $searchResults.HasErrors())

JavaScript

var booleanResponse = searchResults.HasErrors();

Returns

[[Boolean Script API Type|Boolean]]

IndexOf

Velocity

#set($numberResponse = $searchResults.IndexOf($item))

JavaScript

var numberResponse = searchResults.IndexOf(item);

Parameters

Name	Type	Description	Required	Default	Options
item	`[[SearchResult Script API Type\|SearchResult]]`	Item	Required

Returns

[[Number Script API Type|Number]]

Insert

Velocity

$searchResults.Insert($index, $item)

JavaScript

searchResults.Insert(index, item);

Parameters

Name	Type	Description	Required	Default	Options
index	`[[Number Script API Type\|Number]]`	Index	Required
item	`[[SearchResult Script API Type\|SearchResult]]`	Item	Required

Returns

Nothing

Remove

Velocity

#set($booleanResponse = $searchResults.Remove($item))

JavaScript

var booleanResponse = searchResults.Remove(item);

Parameters

Name	Type	Description	Required	Default	Options
item	`[[SearchResult Script API Type\|SearchResult]]`	Item	Required

Returns

[[Boolean Script API Type|Boolean]]

RemoveAt

Velocity

$searchResults.RemoveAt($index)

JavaScript

searchResults.RemoveAt(index);

Parameters

Name	Type	Description	Required	Default	Options
index	`[[Number Script API Type\|Number]]`	Index	Required

Returns

Nothing

set_Item

Velocity

$searchResults.set_Item($index, $value)

JavaScript

searchResults.set_Item(index, value);

Parameters

Name	Type	Description	Required	Default	Options
index	`[[Number Script API Type\|Number]]`	Index	Required
value	`[[SearchResult Script API Type\|SearchResult]]`	Value	Required

Returns

Nothing

ThrowErrors

Velocity

$searchResults.ThrowErrors()

JavaScript

searchResults.ThrowErrors();

Returns

Nothing

ToString

Velocity

#set($stringResponse = $searchResults.ToString())

JavaScript

var stringResponse = searchResults.ToString();

Returns

[[String Script API Type|String]]