IAbuseReports In-Process API Supplementary Type

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

Definition

interface IAbuseReports
{
	Guid DataTypeId { get;  }
	IAbuseReportEvents Events { get;  }
	bool CanBeMarkedAsAbusive(Guid contentTypeId);
	AbuseReport Create(Guid contentId, Guid contentTypeId, AbuseReportCreateOptions options = null);
	AbuseReport Get(Guid id);
	PagedList<AbuseReport> List(AbuseReportListOptions options);
	AbuseReport Update(Guid abuseReportId, AbuseReportUpdateOptions options = null);
}

Properties

Name	Type	Description	Default	Options
DataTypeId	`Guid`	Abuse Reports data type identifier
Events	`IAbuseReportEvents`	AbuseReports events

Methods

bool CanBeMarkedAsAbusive(Guid contentTypeId);

Determine if a ContentTypeId supports marking as abusive

Parameters

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

Return Type

bool

AbuseReport Create(Guid contentId, Guid contentTypeId, AbuseReportCreateOptions options = null);

Create abuse report

Parameters

Name	Type	Description	Required
contentId	`Guid`	Content Id	Required
contentTypeId	`Guid`	Content Type ID	Required
options	`AbuseReportCreateOptions`	Options include: AbuseReasonId	Optional

Return Type

AbuseReport

AbuseReport Get(Guid id);

Get abuse report

Parameters

Name	Type	Description	Required	Default	Options
id	`Guid`	The Id of the AbuseReport to get	Required

Return Type

AbuseReport

PagedList<AbuseReport> List(AbuseReportListOptions options);

List Abuse Reports

Parameters

Name	Type	Description	Required	Default	Options
options	`AbuseReportListOptions`	Options include: AuthorUserId, ReportingUserId, AbusiveContentId, StartDate, EndDate, SortBy (AbuseReportId, AuthorId, CreatedUtcDate), SortOrder (Asc, Desc), AbuseState(NotReported, Reported, AbusiveAppealed, ConfirmedAbusive, NotAbusive, Invalid, AppealRespondedByAuthor), PageSize, and PageIndex	Required

Return Type

PagedList<AbuseReport>

AbuseReport Update(Guid abuseReportId, AbuseReportUpdateOptions options = null);

Update abuse report

Parameters

Name	Type	Description	Required	Default	Options
abuseReportId	`Guid`	Id of the abuse report	Required
options	`AbuseReportUpdateOptions`	Options include: AbuseReasonId	Optional

Return Type

AbuseReport

Recommended