SearchResults Script API Type

Properties

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

Methods

Add

Velocity

$searchResults.Add($item)

JavaScript

searchResults.Add(item);

Parameters

Name	Type	Description	Required	Default	Options
item	`SearchResult`	Item	Required

Returns

Nothing

AsArray

Velocity

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

JavaScript

var searchResultResponse = searchResults.AsArray();

Returns

Array of 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`	Item	Required

Returns

Boolean

CopyTo

Velocity

$searchResults.CopyTo($array, $arrayIndex)

JavaScript

searchResults.CopyTo(array, arrayIndex);

Parameters

Name	Type	Description	Required	Default	Options
array	`Array of SearchResult`	Array	Required
arrayIndex	`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`	Index	Required

Returns

SearchResult

GetEnumerator

Velocity

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

JavaScript

var iEnumeratorResponse = searchResults.GetEnumerator();

Returns

IEnumerator of SearchResult

HasErrors

Velocity

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

JavaScript

var booleanResponse = searchResults.HasErrors();

Returns

Boolean

IndexOf

Velocity

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

JavaScript

var numberResponse = searchResults.IndexOf(item);

Parameters

Name	Type	Description	Required	Default	Options
item	`SearchResult`	Item	Required

Returns

Number

Insert

Velocity

$searchResults.Insert($index, $item)

JavaScript

searchResults.Insert(index, item);

Parameters

Name	Type	Description	Required	Default	Options
index	`Number`	Index	Required
item	`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`	Item	Required

Returns

Boolean

RemoveAt

Velocity

$searchResults.RemoveAt($index)

JavaScript

searchResults.RemoveAt(index);

Parameters

Name	Type	Description	Required	Default	Options
index	`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`	Index	Required
value	`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

Recommended