IMentionableContentType (v2) Plugin Type

Ben Tiedt — Fri, 08 Mar 2024 17:11:24 GMT

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

Adds support for @mentions. Implementing this will add the content type to the list of content found using @mentions.

IMentionableContentType is defined in the Telligent.Evolution.Extensibility.Content.Version2 namespace of Telligent.Evolution.Platform.dll

Definition

interface IMentionableContentType : [[IContentType Plugin Type|IContentType]], [[IPlugin Plugin Type|IPlugin]]
{
	IEnumerable<[[IContent Plugin Supplementary Type|IContent]]> GetMentionables(string queryText, [[MentionableContext (v2) Plugin Supplementary Type|MentionableContext]] filter);
	string GetMentionPreviewHtml(Guid contentId, [[MentionPreviewOptions (v2) Plugin Supplementary Type|MentionPreviewOptions]] options);
	string GetMentionViewHtml(Guid contentId, [[MentionViewOptions (v2) Plugin Supplementary Type|MentionViewOptions]] options);
}

Methods

IEnumerable<IContent> GetMentionables(string queryText, MentionableContext filter);

This method is called to find matches when a user starts an @mention. The content returned should match the queryText in the title of the content. Content returned should only be that which the specified user can view.

Parameters

Name	Type	Description	Required	Default	Options
queryText	`string`	Query Text	Required
filter	`[[MentionableContext (v2) Plugin Supplementary Type\|MentionableContext]]`	Filter	Required

Return Type

IEnumerable<[[IContent Plugin Supplementary Type|IContent]]>

string GetMentionPreviewHtml(Guid contentId, MentionPreviewOptions options);

Specifies the html for generating a preview of the @mention of the specified content.

Parameters

Name	Type	Description	Required	Default	Options
contentId	`Guid`	Content Id	Required
options	`[[MentionPreviewOptions (v2) Plugin Supplementary Type\|MentionPreviewOptions]]`	Options	Required

Return Type

string

string GetMentionViewHtml(Guid contentId, MentionViewOptions options);

Specifies the html used to render the @mention of the content in the parent content. This is commonly the title of the content linked to itself on the site.

Parameters

Name	Type	Description	Required	Default	Options
contentId	`Guid`	Content Id	Required
options	`[[MentionViewOptions (v2) Plugin Supplementary Type\|MentionViewOptions]]`	Options	Required

Return Type

string