Interface ISearchList
A search list represents a collection of search results that is filled
Namespace: Unity.QuickSearch
Syntax
public interface ISearchList : ICollection<SearchItem>, IEnumerable<SearchItem>, IEnumerable, IDisposableProperties
context
Any valid search context that is used to track async search request. It can be null.
Declaration
SearchContext context { get; }Property Value
| Type | Description |
|---|---|
| SearchContext |
pending
Indicates if the search request is still running and might return more results asynchronously.
Declaration
bool pending { get; }Property Value
| Type | Description |
|---|---|
| Boolean |
Methods
AddItems(IEnumerable<SearchItem>)
Add new items to the search list.
Declaration
void AddItems(IEnumerable<SearchItem> items)Parameters
| Type | Name | Description |
|---|---|---|
| IEnumerable<SearchItem> | items | List of items to be added |
Fetch()
Yields search item until the search query is finished. Nullified items can be returned while the search request is pending.
Declaration
IEnumerable<SearchItem> Fetch()Returns
| Type | Description |
|---|---|
| IEnumerable<SearchItem> | List of search items. Items can be null and must be discarded |
GetRange(Int32, Int32)
Return a subset of items.
Declaration
IEnumerable<SearchItem> GetRange(int skipCount, int count)Parameters
| Type | Name | Description |
|---|---|---|
| Int32 | skipCount | |
| Int32 | count |
Returns
| Type | Description |
|---|---|
| IEnumerable<SearchItem> |
InsertRange(Int32, IEnumerable<SearchItem>)
Insert new search items in the current list.
Declaration
void InsertRange(int index, IEnumerable<SearchItem> items)Parameters
| Type | Name | Description |
|---|---|---|
| Int32 | index | Index where the items should be inserted. |
| IEnumerable<SearchItem> | items | Items to be inserted. |
Select<TResult>(Func<SearchItem, TResult>)
Declaration
IEnumerable<TResult> Select<TResult>(Func<SearchItem, TResult> selector)Parameters
| Type | Name | Description |
|---|---|---|
| Func<SearchItem, TResult> | selector |
Returns
| Type | Description |
|---|---|
| IEnumerable<TResult> |
Type Parameters
| Name | Description |
|---|---|
| TResult |