AbuseReports In-Process API Service

Ben Tiedt — Tue, 19 Nov 2019 20:04:51 GMT

Current Revision posted to API Documentation by Ben Tiedt on 11/19/2019 20:04:51

This service is available via Telligent.Evolution.Extensibility.Apis.Get<Telligent.Evolution.Extensibility.Api.Version1.IAbuseReports>() and is defined in Telligent.Evolution.Platform.dll

Events

Events.AfterCreate

Handler

void AbuseReportAfterCreateEventHandler([[AbuseReportAfterCreateEventArgs In-Process API Event Argument|AbuseReportAfterCreateEventArgs]] e);

Events.AfterDelete

Handler

void AbuseReportAfterDeleteEventHandler([[AbuseReportAfterDeleteEventArgs In-Process API Event Argument|AbuseReportAfterDeleteEventArgs]] e);

Events.AfterUpdate

Handler

void AbuseReportAfterUpdateEventHandler([[AbuseReportAfterUpdateEventArgs In-Process API Event Argument|AbuseReportAfterUpdateEventArgs]] e);

Events.BeforeCreate

Handler

void AbuseReportBeforeCreateEventHandler([[AbuseReportBeforeCreateEventArgs In-Process API Event Argument|AbuseReportBeforeCreateEventArgs]] e);

Events.BeforeDelete

Handler

void AbuseReportBeforeDeleteEventHandler([[AbuseReportBeforeDeleteEventArgs In-Process API Event Argument|AbuseReportBeforeDeleteEventArgs]] e);

Events.BeforeUpdate

Handler

void AbuseReportBeforeUpdateEventHandler([[AbuseReportBeforeUpdateEventArgs In-Process API Event Argument|AbuseReportBeforeUpdateEventArgs]] e);

Properties

Name	Type	Description	Default	Options
DataTypeId	`Guid`	Abuse Reports data type identifier

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 In-Process API Supplementary Type\|AbuseReportCreateOptions]]`	Options include: AbuseReasonId	Optional

Return Type

[[AbuseReport In-Process API Supplementary 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 In-Process API Supplementary Type|AbuseReport]]

PagedList<AbuseReport> List(AbuseReportListOptions options);

List Abuse Reports

Parameters

Name	Type	Description	Required	Default	Options
options	`[[AbuseReportListOptions In-Process API Supplementary Type\|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(T) In-Process API Supplementary Type|PagedList]]<[[AbuseReport In-Process API Supplementary Type|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 In-Process API Supplementary Type\|AbuseReportUpdateOptions]]`	Options include: AbuseReasonId	Optional

Return Type

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