ISearchableContentType Plugin Type

Ben Tiedt — Fri, 15 Jan 2021 19:28:02 GMT

Current Revision posted to API Documentation by Ben Tiedt on 01/15/2021 19:28:02

ISearchableContentType is defined in the Telligent.Evolution.Extensibility.Content.Version1 namespace of Telligent.Evolution.Platform.dll

Definition

interface ISearchableContentType : [[IContentType Plugin Type|IContentType]], [[IPlugin Plugin Type|IPlugin]]
{
	bool IsCacheable { get;  }
	bool VaryCacheByUser { get;  }
	IList<[[SearchIndexDocument Plugin Supplementary Type|SearchIndexDocument]]> GetContentToIndex();
	string GetViewHtml([[IContent Plugin Supplementary Type|IContent]] content, [[Target Plugin Supplementary Type|Target]] target);
	int[] GetViewSecurityRoles(Guid contentId);
	void SetIndexStatus(Guid[] contentIds, bool isIndexed);
}

Properties

Name	Type	Description	Default	Options
IsCacheable	`bool`
VaryCacheByUser	`bool`

Methods

IList<SearchIndexDocument> GetContentToIndex();

Return Type

IList<[[SearchIndexDocument Plugin Supplementary Type|SearchIndexDocument]]>

string GetViewHtml(IContent content, Target target);

Parameters

Name	Type	Description	Required	Default	Options
content	`[[IContent Plugin Supplementary Type\|IContent]]`	Content	Required
target	`[[Target Plugin Supplementary Type\|Target]]`	Target	Required

Return Type

string

int[] GetViewSecurityRoles(Guid contentId);

Parameters

Name	Type	Description	Required	Default	Options
contentId	`Guid`	Content Id	Required

Return Type

int[]

void SetIndexStatus(Guid[] contentIds, bool isIndexed);

Parameters

Name	Type	Description	Required	Default	Options
contentIds	`Guid[]`	Content Ids	Required
isIndexed	`bool`	Is Indexed	Required

Extensions

[[IIndexedMentionableContentType (v2) Plugin Type|IIndexedMentionableContentType]]
[[IReindexableSearchableContentType Plugin Type|IReindexableSearchableContentType]]