SearchResults Script API Type

Ben Tiedt — Fri, 15 Jan 2021 19:48:37 GMT

Current Revision posted to API Documentation by Ben Tiedt on 01/15/2021 19:48:37

Properties
Add
AsArray
Clear
Clone
Contains
CopyTo
ForEach
GetEnumerator
HasErrors
IndexOf
Insert
Remove
RemoveAt
ThrowErrors

Properties

Name	Access	Type	Description
Categories	Read, Write	`IList of String`	Categories
Count	Read	`Int32`	Count
DateRangeFacets	Read, Write	`IList of [[DateRangeFacetResult Script API Type\|DateRangeFacetResult]]`	Date Range Facets
Errors	Read	`IList of [[Error Script API Type\|Error]]`	Errors
FieldFacets	Read, Write	`IList of [[FieldFacetResult Script API Type\|FieldFacetResult]]`	Field Facets
IsReadOnly	Read	`Boolean`	Is Read Only
Item	Read, Write	`[[SearchResult Script API Type\|SearchResult]]`	Item
PageIndex	Read, Write	`Int32`	Page Index
PageSize	Read, Write	`Int32`	Page Size
TotalCount	Read, Write	`Int32`	Total Count
Warnings	Read	`IList 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

Clone

Velocity

#set($objectResponse = $searchResults.Clone())

JavaScript

var objectResponse = searchResults.Clone();

Returns

Object

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

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	`Int32`	Array Index	Required

Returns

Nothing

ForEach

Velocity

$searchResults.ForEach($action)

JavaScript

searchResults.ForEach(action);

Parameters

Name	Type	Description	Required	Default	Options
action	`Action of [[SearchResult Script API Type\|SearchResult]]`	Action	Required

Returns

Nothing

GetEnumerator

Velocity

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

JavaScript

var iEnumeratorResponse = searchResults.GetEnumerator();

Returns

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

HasErrors

Velocity

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

JavaScript

var booleanResponse = searchResults.HasErrors();

Returns

Boolean

IndexOf

Velocity

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

JavaScript

var int32Response = searchResults.IndexOf(item);

Parameters

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

Returns

Int32

Insert

Velocity

$searchResults.Insert($index, $item)

JavaScript

searchResults.Insert(index, item);

Parameters

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

RemoveAt

Velocity

$searchResults.RemoveAt($index)

JavaScript

searchResults.RemoveAt(index);

Parameters

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

Returns

Nothing

ThrowErrors

Velocity

$searchResults.ThrowErrors()

JavaScript

searchResults.ThrowErrors();

Returns

Nothing