IAbuseDetector Plugin Type

Ben Tiedt — Fri, 08 Mar 2024 17:10:16 GMT

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

Automates abuse detection to prevent SPAM and other abuse from entering the platform. Individual abuse detectors handle events applicable to their abuse detection logic and notify the abuse service when abuse is detected.

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

Definition

interface IAbuseDetector : [[IPlugin Plugin Type|IPlugin]]
{
	string GetAbuseExplanation(Guid contentId, Guid contentTypeId);
	void Register([[IAbuseController Plugin Supplementary Type|IAbuseController]] controller);
}

Methods

string GetAbuseExplanation(Guid contentId, Guid contentTypeId);

Retrieves a user-renderable explanation of why this abuse detector flagged the identified content as abusive. Be careful not to expose too much information in this explanation.

Parameters

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

Return Type

string

void Register(IAbuseController controller);

Registers the abuse controller which provides access to identify content as abusive.

Parameters

Name	Type	Description	Required	Default	Options
controller	`[[IAbuseController Plugin Supplementary Type\|IAbuseController]]`	Controller	Required