searchAssociatedContent
Searches for content that is associated with a given entity. Current associations supported are "related" and "connected".
If unspecified, the number of results returned is 4.
NOTE: only item based entities are supported for now.
Parameters
| Parameter | Type | Default | Notes |
|---|---|---|---|
| opts Required | ISearchAssociatedContentOptions |
Returns
Search results for the associated content
| Property | Type | Notes |
|---|---|---|
| boolean |
Can more results be fetched? |
|
| function() : Promise<IHubSearchResponse<>> |
Function that fetches the next page of results |
|
| [] |
Array if results |
|
| number |
Total number of matches for the query |
|
| Optional | IHubAggregation[] |
Array of requested aggregations |
| Optional | Kilobyte |
The length of the query string that was just executed in the search, measured in kilobytes |
| Optional | IMessage[] |
Array of messages / warnings |
Function defined in packages/common/src/search/searchAssociatedContent.ts:24