- 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 | Date Range Facets |
| Errors | Read | IList of Error | Errors |
| FieldFacets | Read, Write | IList of FieldFacetResult | Field Facets |
| IsReadOnly | Read | Boolean | Is Read Only |
| Item | Read, Write | 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 | Warnings |
Methods
Add
Velocity
$searchResults.Add($item)
JavaScript
searchResults.Add(item);
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| item | SearchResult | Item | Required |
Returns
NothingAsArray
Velocity
#set($searchResultResponse = $searchResults.AsArray())
JavaScript
var searchResultResponse = searchResults.AsArray();
Returns
Array of SearchResultClear
Velocity
$searchResults.Clear()
JavaScript
searchResults.Clear();
Returns
NothingClone
Velocity
#set($objectResponse = $searchResults.Clone())
JavaScript
var objectResponse = searchResults.Clone();
Returns
ObjectContains
Velocity
#set($booleanResponse = $searchResults.Contains($item))
JavaScript
var booleanResponse = searchResults.Contains(item);
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| item | SearchResult | Item | Required |
Returns
BooleanCopyTo
Velocity
$searchResults.CopyTo($array, $arrayIndex)
JavaScript
searchResults.CopyTo(array, arrayIndex);
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| array | Array of SearchResult | Array | Required | ||
| arrayIndex | Int32 | Array Index | Required |
Returns
NothingForEach
Velocity
$searchResults.ForEach($action)
JavaScript
searchResults.ForEach(action);
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| action | Action of SearchResult | Action | Required |
Returns
NothingGetEnumerator
Velocity
#set($iEnumeratorResponse = $searchResults.GetEnumerator())
JavaScript
var iEnumeratorResponse = searchResults.GetEnumerator();
Returns
IEnumerator of SearchResultHasErrors
Velocity
#set($booleanResponse = $searchResults.HasErrors())
JavaScript
var booleanResponse = searchResults.HasErrors();
Returns
BooleanIndexOf
Velocity
#set($int32Response = $searchResults.IndexOf($item))
JavaScript
var int32Response = searchResults.IndexOf(item);
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| item | SearchResult | Item | Required |
Returns
Int32Insert
Velocity
$searchResults.Insert($index, $item)
JavaScript
searchResults.Insert(index, item);
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| index | Int32 | Index | Required | ||
| item | SearchResult | Item | Required |
Returns
NothingRemove
Velocity
#set($booleanResponse = $searchResults.Remove($item))
JavaScript
var booleanResponse = searchResults.Remove(item);
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| item | SearchResult | Item | Required |
Returns
BooleanRemoveAt
Velocity
$searchResults.RemoveAt($index)
JavaScript
searchResults.RemoveAt(index);
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| index | Int32 | Index | Required |
Returns
NothingThrowErrors
Velocity
$searchResults.ThrowErrors()
JavaScript
searchResults.ThrowErrors();