SearchResultsAsync Method
Overloads
| SearchResultsAsync(SearchCombinationOptions, IEnumerable<String>, SearchPage) |
Returns the search matches for one or more search terms. Search results are organized in search groups. The type of search group indicates where the search matches come from (from data for example). Each search group contains search results that correspond to a combination of search terms. For example, if the search terms are * organic * pasta * America * organic, pasta, America * organic, pasta * organic, America * pasta, America For every search group, there are one or more search group items. Each subgroup item contains results that correspond to an item type (for example a field). For every search group item, there are one or several search matches. The position of the match in each search result is given. |
|
| SearchResultsAsync(AsyncHandle, SearchCombinationOptions, IEnumerable<String>, SearchPage) |
Returns the search matches for one or more search terms. Search results are organized in search groups. The type of search group indicates where the search matches come from (from data for example). Each search group contains search results that correspond to a combination of search terms. For example, if the search terms are * organic * pasta * America * organic, pasta, America * organic, pasta * organic, America * pasta, America For every search group, there are one or more search group items. Each subgroup item contains results that correspond to an item type (for example a field). For every search group item, there are one or several search matches. The position of the match in each search result is given. |
|
| SearchResultsAsync<T>(AsyncHandle, Func<Response, T>, SearchCombinationOptions, IEnumerable<String>, SearchPage) |
Returns the search matches for one or more search terms. Search results are organized in search groups. The type of search group indicates where the search matches come from (from data for example). Each search group contains search results that correspond to a combination of search terms. For example, if the search terms are * organic * pasta * America * organic, pasta, America * organic, pasta * organic, America * pasta, America For every search group, there are one or more search group items. Each subgroup item contains results that correspond to an item type (for example a field). For every search group item, there are one or several search matches. The position of the match in each search result is given. |
SearchResultsAsync(SearchCombinationOptions, IEnumerable<String>, SearchPage)
Returns the search matches for one or more search terms.
Search results are organized in search groups. The type of search group indicates where the search matches come from (from data for example).
Each search group contains search results that correspond to a combination of search terms.
For example, if the search terms are organic , pasta , and America , the possible combination of search groups are:
- organic
- pasta
- America
- organic, pasta, America
- organic, pasta
- organic, America
- pasta, America
For every search group, there are one or more search group items. Each subgroup item contains results that correspond to an item type (for example a field).
For every search group item, there are one or several search matches. The position of the match in each search result is given.
Declaration
Task<SearchResult> SearchResultsAsync([QixName("qOptions")] SearchCombinationOptions options, [QixName("qTerms")] IEnumerable<string> terms, [QixName("qPage")] SearchPage page)
Parameters
| Type | Name | Description |
|---|---|---|
| SearchCombinationOptions | options |
Information about the search combinations. |
| System.Collections.Generic.IEnumerable<System.String> | terms |
Terms to search for. |
| SearchPage | page |
Array of pages to retrieve. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<SearchResult> |
SearchResultsAsync(AsyncHandle, SearchCombinationOptions, IEnumerable<String>, SearchPage)
Returns the search matches for one or more search terms.
Search results are organized in search groups. The type of search group indicates where the search matches come from (from data for example).
Each search group contains search results that correspond to a combination of search terms.
For example, if the search terms are organic , pasta , and America , the possible combination of search groups are:
- organic
- pasta
- America
- organic, pasta, America
- organic, pasta
- organic, America
- pasta, America
For every search group, there are one or more search group items. Each subgroup item contains results that correspond to an item type (for example a field).
For every search group item, there are one or several search matches. The position of the match in each search result is given.
Declaration
Task<SearchResult> SearchResultsAsync(AsyncHandle asyncHandle, [QixName("qOptions")] SearchCombinationOptions options, [QixName("qTerms")] IEnumerable<string> terms, [QixName("qPage")] SearchPage page)
Parameters
| Type | Name | Description |
|---|---|---|
| AsyncHandle | asyncHandle |
Handle to asynchronous method request |
| SearchCombinationOptions | options |
Information about the search combinations. |
| System.Collections.Generic.IEnumerable<System.String> | terms |
Terms to search for. |
| SearchPage | page |
Array of pages to retrieve. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<SearchResult> |
SearchResultsAsync<T>(AsyncHandle, Func<Response, T>, SearchCombinationOptions, IEnumerable<String>, SearchPage)
Returns the search matches for one or more search terms.
Search results are organized in search groups. The type of search group indicates where the search matches come from (from data for example).
Each search group contains search results that correspond to a combination of search terms.
For example, if the search terms are organic , pasta , and America , the possible combination of search groups are:
- organic
- pasta
- America
- organic, pasta, America
- organic, pasta
- organic, America
- pasta, America
For every search group, there are one or more search group items. Each subgroup item contains results that correspond to an item type (for example a field).
For every search group item, there are one or several search matches. The position of the match in each search result is given.
Declaration
Task<T> SearchResultsAsync<T>(AsyncHandle asyncHandle, Func<Response, T> onResult, [QixName("qOptions")] SearchCombinationOptions options, [QixName("qTerms")] IEnumerable<string> terms, [QixName("qPage")] SearchPage page)
Parameters
| Type | Name | Description |
|---|---|---|
| AsyncHandle | asyncHandle |
Handle to asynchronous method request |
| System.Func<Response, T> | onResult |
Continuation function |
| SearchCombinationOptions | options |
Information about the search combinations. |
| System.Collections.Generic.IEnumerable<System.String> | terms |
Terms to search for. |
| SearchPage | page |
Array of pages to retrieve. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<T> |
Type Parameters
| Name | Description |
|---|---|
| T |
Did this page help you?
If you find any issues with this page or its content – a typo, a missing step, or a technical error – let us know how we can improve!