IMentionableContentType Plugin Type

Ben Tiedt — Tue, 19 Nov 2019 19:35:30 GMT

Current Revision posted to API Documentation by Ben Tiedt on 11/19/2019 19:35:30

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.Version1 namespace of Telligent.Evolution.Platform.dll

Definition

interface IMentionableContentType : [[IContentType Plugin Type|IContentType]], [[IPlugin Plugin Type|IPlugin]]
{
	IEnumerable<[[IContent Plugin Supplementary Type|IContent]]> GetMentionables(int userId, string queryText, [[IMentionableFilter Plugin Supplementary Type|IMentionableFilter]] filter);
	string GetMentionPreviewHtml(int userId, Guid contentId);
	string GetMentionViewHtml(int userId, Guid contentId);
}

Methods

IEnumerable<IContent> GetMentionables(int userId, string queryText, IMentionableFilter 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
userId	`int`	User Id	Required
queryText	`string`	Query Text	Required
filter	`[[IMentionableFilter Plugin Supplementary Type\|IMentionableFilter]]`	Filter	Required

Return Type

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

string GetMentionPreviewHtml(int userId, Guid contentId);

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

Parameters

Name	Type	Description	Required	Default	Options
userId	`int`	User Id	Required
contentId	`Guid`	Content Id	Required

Return Type

string

string GetMentionViewHtml(int userId, Guid contentId);

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
userId	`int`	User Id	Required
contentId	`Guid`	Content Id	Required

Return Type

string