IAbusiveContent In-Process API Supplementary Type

Ben Tiedt — Fri, 08 Mar 2024 17:34:17 GMT

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

IAbusiveContent is defined in the Telligent.Evolution.Extensibility.Api.Version1 namespace of Telligent.Evolution.Platform.dll

Definition

interface IAbusiveContent
{
	Guid DataTypeId { get;  }
	int DefiniteAbuseThreshold { get;  }
	IAbusiveContentEvents Events { get;  }
	int PossibleAbuseThreshold { get;  }
	void ArchiveExpungedData(Guid abuseId, Guid contentTypeId, Guid applicationId, Guid containerId, int createdByUserId, DateTime createdDate, string title, string body, string url, string xmlData);
	void ArchiveExpungedData(Guid abuseId, Guid contentId, Guid contentTypeId);
	[[AbusiveContent In-Process API Supplementary Type|AbusiveContent]] Get(Guid contentId, Guid contentTypeId);
	void Ignore(Guid contentId, Guid contentTypeId);
	bool IsModerated(Guid contentId, Guid contentTypeId);
	[[PagedList(T) In-Process API Supplementary Type|PagedList]]<[[AbusiveContent In-Process API Supplementary Type|AbusiveContent]]> List([[AbusiveContentListOptions In-Process API Supplementary Type|AbusiveContentListOptions]] options);
}

Properties

Name	Type	Description
DataTypeId Obsolete	`Guid`	Migrate usage to scripted email or scripted plugins.
DefiniteAbuseThreshold	`int`	Number of reports after which a piece of content will definitely be considered abusive..
Events	`IAbusiveContentEvents`	AbusiveContent events
PossibleAbuseThreshold	`int`	Minimum number of reports required before content can be considered abusive.

Methods

void ArchiveExpungedData(Guid abuseId, Guid contentTypeId, Guid applicationId, Guid containerId, int createdByUserId, DateTime createdDate, string title, string body, string url, string xmlData);

Archive Expunged Data - move a copy of data to be expunged to database

Parameters

Name	Type	Description	Required
abuseId	`Guid`	Abuse Id	Required
contentTypeId	`Guid`	Content Type ID	Required
applicationId	`Guid`	Application Id	Required
containerId	`Guid`	Container Id	Required
createdByUserId	`int`	Created by user Id	Required
createdDate	`DateTime`	Created date	Required
title	`string`	title	Required
body	`string`	Body	Required
url	`string`	Url	Required
xmlData	`string`	Option xml data to be included in archive	Required

void ArchiveExpungedData(Guid abuseId, Guid contentId, Guid contentTypeId);

Archive Expunged Data - move a copy of data to be expunged to database

Parameters

Name	Type	Description	Required
abuseId	`Guid`	Abuse Id	Required
contentId	`Guid`	Content Id	Required
contentTypeId	`Guid`	Content Type ID	Required

AbusiveContent Get(Guid contentId, Guid contentTypeId);

Gets a single Abusive Content Record for a piece of content

Parameters

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

Return Type

[[AbusiveContent In-Process API Supplementary Type|AbusiveContent]]

void Ignore(Guid contentId, Guid contentTypeId);

Ignore content in the abuse management list. It will not be shown again until another report is made on it.

Parameters

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

bool IsModerated(Guid contentId, Guid contentTypeId);

Identifies if content is currently moderated due to abuse or other moderation-related workflow.

Parameters

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

Return Type

bool

PagedList<AbusiveContent> List(AbusiveContentListOptions options);

List Abusive Content

Parameters

Name	Type	Description	Required	Default	Options
options	`[[AbusiveContentListOptions In-Process API Supplementary Type\|AbusiveContentListOptions]]`	Options include: AuthorUserId, ContainerId, ApplicationId, ContentTypeId, StartCreateDate, EndCreateDate, StartReportDate, EndReportDate, AbuseState(Reported, AbusiveAppealed, ConfirmedAbusive, NotAbusive, Invalid, AppealRespondedByAuthor), SortBy (AbuseId, AuthorUserId, AuthorUsername), SortOrder (Asc, Desc), PageSize, PageIndex	Required

Return Type

[[PagedList(T) In-Process API Supplementary Type|PagedList]]<[[AbusiveContent In-Process API Supplementary Type|AbusiveContent]]>