SearchIndexing In-Process API Service

Ben Tiedt — Fri, 08 Mar 2024 17:30:52 GMT

Current Revision posted to API Documentation by Ben Tiedt on 03/08/2024 17:30:52

Work with Search indexing

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

Events

Events.AfterBulkIndex

Handler

void AfterSearchBulkIndexingEventHandler([[AfterBulkIndexingEventArgs In-Process API Event Argument|AfterBulkIndexingEventArgs]] e);

Events.BeforeBulkIndex

Handler

void BeforeSearchBulkIndexingEventHandler([[BeforeBulkIndexingEventArgs In-Process API Event Argument|BeforeBulkIndexingEventArgs]] e);

Events.Render

Handler

void SearchResultRenderEventHandler([[SearchResultRenderEventArgs In-Process API Event Argument|SearchResultRenderEventArgs]] e);

Properties

Name	Type	Description	Default	Options
Constants	`[[SearchIndexingConstants In-Process API Supplementary Type\|SearchIndexingConstants]]`	Constants

Methods

AdditionalInfo Delete(SearchIndexDeleteOptions options);

Delete Index entry that match the query

Parameters

Name	Type	Description	Required	Default	Options
options	`[[SearchIndexDeleteOptions In-Process API Supplementary Type\|SearchIndexDeleteOptions]]`	Index delete options	Required

Return Type

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

string FormatDate(DateTime d);

Format Date

Parameters

Name	Type	Description	Required	Default	Options
d	`DateTime`	Formatted date	Required

Return Type

string

ApiList<SearchableFile> GetEmbeddedFileNamesAndText(string text);

Return the names and searchable text of any files embedded in the input text

Parameters

Name	Type	Description	Required	Default	Options
text	`string`	Text	Required

Return Type

[[ApiList(T) In-Process API Supplementary Type|ApiList]]<[[SearchableFile In-Process API Supplementary Type|SearchableFile]]>

SearchIndexDocument NewDocument(Guid contentId, Guid contentTypeId, string typeName, string url, string title, string content);

Create new document

Parameters

Name	Type	Description	Required
contentId	`Guid`	Content Id	Required
contentTypeId	`Guid`	Content type Id	Required
typeName	`string`	Type name	Required
url	`string`	Url	Required
title	`string`	Title	Required
content	`string`	Content	Required

Return Type

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