SearchResults In-Process API Service

Ben Tiedt — Tue, 19 Nov 2019 20:02:41 GMT

Current Revision posted to API Documentation by Ben Tiedt on 11/19/2019 20:02:41

This service is available via Telligent.Evolution.Extensibility.Apis.Get<Telligent.Evolution.Extensibility.Api.Version1.ISearchResults>() and is defined in Telligent.Evolution.Platform.dll

Events

SearchEvents.AfterSearch

Handler

void AfterSearchEventHandler([[AfterSearchEventArgs In-Process API Event Argument|AfterSearchEventArgs]] e);

SearchEvents.BeforeSearch

Handler

void BeforeSearchEventHandler([[BeforeSearchEventArgs In-Process API Event Argument|BeforeSearchEventArgs]] e);

Properties

Name	Type	Description	Default	Options
SearchFlags	`[[ISearchFlags In-Process API Supplementary Type\|ISearchFlags]]`	Search flags
SolrEvents	`ISolrSearchEvents`	Solr events

Methods

SearchResult Create(string content, string contentId, string contentType, string contentUrl, DateTime date, string roles, string title);

Create SearchResult

Parameters

Name	Type	Description	Required
content	`string`	Content	Required
contentId	`string`	Content Id	Required
contentType	`string`	Content Type	Required
contentUrl	`string`	Content Url	Required
date	`DateTime`	Date	Required
roles	`string`	Roles	Required
title	`string`	Title	Required

Return Type

[[SearchResult In-Process API Supplementary Type|SearchResult]]

SearchResult Create(string content, string contentId, string contentType, string contentUrl, DateTime date, string roles, string title, SearchResultsCreateOptions options);

Create Search Result

Parameters

Name	Type	Description	Required
content	`string`	Content	Required
contentId	`string`	Content Id	Required
contentType	`string`	Content Type	Required
contentUrl	`string`	Content Url	Required
date	`DateTime`	Date	Required
roles	`string`	Roles	Required
title	`string`	Title	Required
options	`[[SearchResultsCreateOptions In-Process API Supplementary Type\|SearchResultsCreateOptions]]`	Create index entry options	Required

Return Type

[[SearchResult In-Process API Supplementary Type|SearchResult]]

AdditionalInfo Delete(string id);

Delete SearchResult with a specific ID

Parameters

Name	Type	Description	Required	Default	Options
id	`string`	Id	Required

Return Type

[[AdditionalInfo In-Process API Supplementary Type|AdditionalInfo]]

SearchResult Get(string id);

Get Search Result with a specific ID

Parameters

Name	Type	Description	Required	Default	Options
id	`string`	Id	Required

Return Type

[[SearchResult In-Process API Supplementary Type|SearchResult]]

SearchResults GetRelatedContent(string searchUniqueId, RelatedContentListOptions options = null);

Get Related Content to a specific piece of content

Parameters

Name	Type	Description	Required	Default	Options
searchUniqueId	`string`	An entity's unique search id, available as a property of entities	Required
options	`[[RelatedContentListOptions In-Process API Supplementary Type\|RelatedContentListOptions]]`	Related content list options	Optional

Return Type

[[SearchResults In-Process API Supplementary Type|SearchResults]]

SearchResults List(SearchResultsListOptions options = null);

Perform a search with query parameters.

Parameters

Name	Type	Description	Required	Default	Options
options	`[[SearchResultsListOptions In-Process API Supplementary Type\|SearchResultsListOptions]]`	Search list options	Optional

Return Type

[[SearchResults In-Process API Supplementary Type|SearchResults]]

SearchResult Update(string id, SearchResultsUpdateOptions options);

Update Search Result

Parameters

Name	Type	Description	Required	Default	Options
id	`string`	Id	Required
options	`[[SearchResultsUpdateOptions In-Process API Supplementary Type\|SearchResultsUpdateOptions]]`	Update index entry options	Required

Return Type

[[SearchResult In-Process API Supplementary Type|SearchResult]]