IAbuseCheckingContentType Plugin Type

Ben Tiedt — Tue, 19 Nov 2019 19:34:45 GMT

Current Revision posted to API Documentation by Ben Tiedt on 11/19/2019 19:34:45

This interface defines the methods necessary to support the abuse service. Content types implementing this service can be marked as abuse, hidden if enough marks are added, and moderated using the abuse UI.

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

Definition

interface IAbuseCheckingContentType : [[IContentType Plugin Type|IContentType]], [[IPlugin Plugin Type|IPlugin]]
{
	bool CanUserReviewAppeals(Guid contentId, int userId);
	void ContentConfirmedAbusive(Guid abuseId, Guid contentId);
	void ContentFoundNotAbusive(Guid abuseId, Guid contentId);
	void ContentSuspectedAbusive(Guid abuseId, Guid contentId);
	[[IContent Plugin Supplementary Type|IContent]] GetHiddenContent(Guid contentId);
	List<int> GetReviewBoardUsers(Guid contentId);
}

Methods

bool CanUserReviewAppeals(Guid contentId, int userId);

Deprecated: The service now uses the group or site Manage Abuse permission to detect the review board users.

Parameters

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

Return Type

bool

void ContentConfirmedAbusive(Guid abuseId, Guid contentId);

This method is called when a moderator reviews an abuse report and determines the content is indeed abusive. Generally, the content can be deleted when this method is called. For audit or legal reasons, the content could also be archived.

Parameters

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

void ContentFoundNotAbusive(Guid abuseId, Guid contentId);

This method is called when a moderator reviews an abuse report and determines the content is not abusive. This method is expected to return the content to being shown on the site again.

Parameters

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

void ContentSuspectedAbusive(Guid abuseId, Guid contentId);

This method is called when a piece of content has reached the marked as abuse threshold and is now considered abusive. In most cases this method should hide the content on the site but not delete it so that either an appeal can be made or a moderate can take further action.

Parameters

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

IContent GetHiddenContent(Guid contentId);

This method is used to retrieve the content after it has been hidden. Any checks that normally cause hidden item to not be retrieved should be ignored.

Parameters

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

Return Type

[[IContent Plugin Supplementary Type|IContent]]

List<int> GetReviewBoardUsers(Guid contentId);

Deprecated: The service now uses the group or site Manage Abuse permission to detect the review board users.

Parameters

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

Return Type

List<int>

Extensions

[[IRequireCleanupAbuseCheckingContentType Plugin Type|IRequireCleanupAbuseCheckingContentType]]
[[IPreviewableAbuseCheckingContentType Plugin Type|IPreviewableAbuseCheckingContentType]]