IAbuseController Plugin Supplementary Type

Ben Tiedt — Fri, 08 Mar 2024 17:12:59 GMT

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

Provides direct access to the abuse core service to enable abuse detection plugins.

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

Definition

interface IAbuseController
{
	void IdentifyAsAbusive(Guid contentId, Guid contentTypeId);
	void IdentifyAsAbusive(Guid contentId, Guid contentTypeId, bool isCurrentlyBeingEdited);
	bool IsExempt(Guid contentId, Guid contentTypeId, int? userId);
	bool IsExempt(Guid contentId, Guid contentTypeId, int? userId, bool isCurrentlyBeingEdited);
	bool IsReviewBoardUser(Guid contentId, Guid contentTypeId, int userId);
	void Moderate(Guid contentId, Guid contentTypeId);
	void Moderate(Guid contentId, Guid contentTypeId, bool isCurrentlyBeingEdited);
	bool SupportsAbuse(Guid contentTypeId);
}

Methods

void IdentifyAsAbusive(Guid contentId, Guid contentTypeId);

Flags the identified content as abusive immediately. Content types will then generally hide the content from the UI and the content will begin the abuse workflow.

Parameters

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

void IdentifyAsAbusive(Guid contentId, Guid contentTypeId, bool isCurrentlyBeingEdited);

Flags the identified content as abusive immediately. Content types will then generally hide the content from the UI and the content will begin the abuse workflow. For secondary actions based on abuse detection, isCurentlyBeingEdited should be set to false to avoid exemptions based on administrative editing.

Parameters

Name	Type	Description	Required
contentId	`Guid`	Content Id	Required
contentTypeId	`Guid`	Content Type Id	Required
isCurrentlyBeingEdited	`bool`	Is Currently Being Edited	Required

bool IsExempt(Guid contentId, Guid contentTypeId, int? userId);

Identifies whether the specified user is exempt from abuse automation. Attempting to flag content as abusive for exempt users will have no result.

Parameters

Name	Type	Description	Required
contentId	`Guid`	Content Id	Required
contentTypeId	`Guid`	Content Type Id	Required
userId	`int?`	User Id	Required

Return Type

bool

bool IsExempt(Guid contentId, Guid contentTypeId, int? userId, bool isCurrentlyBeingEdited);

Identifies whether the specified user is exempt from abuse automation. For secondary actions based on abuse detection, isCurentlyBeingEdited should be set to false to avoid exemptions based on administrative editing.

Parameters

Name	Type	Description	Required
contentId	`Guid`	Content Id	Required
contentTypeId	`Guid`	Content Type Id	Required
userId	`int?`	User Id	Required
isCurrentlyBeingEdited	`bool`	Is Currently Being Edited	Required

Return Type

bool

bool IsReviewBoardUser(Guid contentId, Guid contentTypeId, int userId);

Identifies whether the specified user is on the review board.

Parameters

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

Return Type

bool

void Moderate(Guid contentId, Guid contentTypeId);

Flags the identified content for moderation. Content types will then generally hide the content form the UI and the content will begin the moderation workflow.

Parameters

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

void Moderate(Guid contentId, Guid contentTypeId, bool isCurrentlyBeingEdited);

Flags the identified content for moderation. Content types will then generally hide the content form the UI and the content will begin the moderation workflow. For secondary actions based on abuse detection, isCurentlyBeingEdited should be set to false to avoid exemptions based on administrative editing.

Parameters

Name	Type	Description	Required
contentId	`Guid`	Content Id	Required
contentTypeId	`Guid`	Content Type Id	Required
isCurrentlyBeingEdited	`bool`	Is Currently Being Edited	Required

bool SupportsAbuse(Guid contentTypeId);

Identifies whether the specified content type supports abuse tracking.

Parameters

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

Return Type

bool