SearchResults is defined in the Telligent.Evolution.Extensibility.Api.Entities.Version1 namespace.
Definition
class SearchResults : PagedList<SearchResult>, ICloneable, IPagedList<SearchResult> { SearchResults(); SearchResults(AdditionalInfo additionalInfo); SearchResults(Error error); SearchResults(Warning warning); SearchResults(IList<Warning> warnings, IList<Error> errors); SearchResults(IEnumerable<SearchResult> items, int pageSize, int pageIndex, int totalCount); SearchResults(IEnumerable<SearchResult> items, int pageSize, int pageIndex, int totalCount, IEnumerable<FieldFacetResult> fieldFacets); IList<string> Categories { get; set; } int Count { get; } IList<DateRangeFacetResult> DateRangeFacets { get; set; } double Duration { get; set; } IList<Error> Errors { get; } IList<FieldFacetResult> FieldFacets { get; set; } bool IsReadOnly { get; } SearchResult Item[int] { get; set; } int PageIndex { get; set; } int PageSize { get; set; } int TotalCount { get; set; } IList<Warning> Warnings { get; } void Add(SearchResult item); SearchResult[] AsArray(); void Clear(); Object Clone(); bool Contains(SearchResult item); void CopyTo(SearchResult[] array, int arrayIndex); void ForEach(Action<SearchResult> action); IEnumerator<SearchResult> GetEnumerator(); bool HasErrors(); int IndexOf(SearchResult item); void Insert(int index, SearchResult item); bool Remove(SearchResult item); void RemoveAt(int index); void ThrowErrors(); }
Constructors
SearchResults();
SearchResults(AdditionalInfo additionalInfo);
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| additionalInfo | AdditionalInfo | Additional Info | Required |
SearchResults(Error error);
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| error | Error | Error | Required |
SearchResults(Warning warning);
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| warning | Warning | Warning | Required |
SearchResults(IList<Warning> warnings, IList<Error> errors);
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| warnings | IList<Warning> | Warnings | Required | ||
| errors | IList<Error> | Errors | Required |
SearchResults(IEnumerable<SearchResult> items, int pageSize, int pageIndex, int totalCount);
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| items | IEnumerable<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 | Default | Options |
|---|---|---|---|---|---|
| items | IEnumerable<SearchResult> | Items | Required | ||
| pageSize | int | Page Size | Required | ||
| pageIndex | int | Page Index | Required | ||
| totalCount | int | Total Count | Required | ||
| fieldFacets | IEnumerable<FieldFacetResult> | Field Facets | Required |
Properties
| Name | Type | Description | Default | Options |
|---|---|---|---|---|
| Categories | IList<string> | |||
| Count | int | |||
| DateRangeFacets | IList<DateRangeFacetResult> | |||
| Duration | double | |||
| Errors | IList<Error> | |||
| FieldFacets | IList<FieldFacetResult> | |||
| IsReadOnly | bool | |||
| Item[int] | SearchResult | |||
| PageIndex | int | |||
| PageSize | int | |||
| TotalCount | int | |||
| Warnings | IList<Warning> |
Methods
void Add(SearchResult item);
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| item | SearchResult | Item | Required |
SearchResult[] AsArray();
Return Type
void Clear();
Object Clone();
Return Type
bool Contains(SearchResult item);
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| item | SearchResult | Item | Required |
Return Type
void CopyTo(SearchResult[] array, int arrayIndex);
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| array | SearchResult[] | Array | Required | ||
| arrayIndex | int | Array Index | Required |
void ForEach(Action<SearchResult> action);
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| action | Action<SearchResult> | Action | Required |
IEnumerator<SearchResult> GetEnumerator();
Return Type
bool HasErrors();
Return Type
int IndexOf(SearchResult item);
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| item | SearchResult | Item | Required |
Return Type
void Insert(int index, SearchResult item);
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| index | int | Index | Required | ||
| item | SearchResult | Item | Required |
bool Remove(SearchResult item);
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| item | SearchResult | Item | Required |
Return Type
void RemoveAt(int index);
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| index | int | Index | Required |