Enables scripted content fragments to use AbuseReports
Methods
CanBeMarkedAsAbusive
Returns a whether the content type id can be marked as abusive or not.
Usage
#set($booleanResponse = $core_v2_abuseReport.CanBeMarkedAsAbusive($contentTypeId))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
contentTypeId | Guid | Content Type Id | Required |
Return Type
bool
Create
Creates an abuse report against the supplied ContentId item
Usage
#set($abuseReportResponse = $core_v2_abuseReport.Create($contentId, $contentTypeId))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
contentId | Guid | ContentID of the Item to create the abuse report for | Required | ||
contentTypeId | Guid | Content Type ID | Required |
Return Type
Create
Creates an abuse report against the supplied ContentId item
Usage
#set($abuseReportResponse = $core_v2_abuseReport.Create($contentId, $contentTypeId, "%{AbuseReasonId = $abuseReasonIdArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
contentId | Guid | ContentID of the Item to create the abuse report for | Required | ||
contentTypeId | Guid | Content Type ID | Required | ||
AbuseReasonId | int | Abuse Reason Id | Optional | 0 |
Return Type
Get
Retrieves an AbuseReport
Usage
#set($abuseReportResponse = $core_v2_abuseReport.Get($id))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
id | Guid | The Id of the AbuseReport to get | Required |
Return Type
List
Returns a list of abuse reports
Usage
#set($pagedListResponse = $core_v2_abuseReport.List("%{AbusiveContentId = $abusiveContentIdArg, AppealId = $appealIdArg, AppealState = $appealStateArg, AssignedToAppeal = $assignedToAppealArg, AuthorUserId = $authorUserIdArg, EndDate = $endDateArg, PageIndex = $pageIndexArg, PageSize = $pageSizeArg, ReportingUserId = $reportingUserIdArg, SortBy = $sortByArg, SortOrder = $sortOrderArg, StartDate = $startDateArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
AbusiveContentId | Guid | Abusive Content Id | Optional | ||
AppealId | Guid | Appeal Id | Optional | ||
AppealState | string | Appeal State | Optional | Default | Accepted, AuthorResponded, Default, Expired, Initiated, ModerationRequired, Rejected |
AssignedToAppeal | bool | Assigned To Appeal | Optional | ||
AuthorUserId | Guid | Author User Id | Optional | ||
EndDate | DateTime | End Date | Optional | ||
PageIndex | int | Specify the page number of paged results to return. Zero-based index. | Optional | 0 | |
PageSize | int | Specify the number of results to return per page. | Optional | 20 | |
ReportingUserId | int | Reporting User Id | Optional | ||
SortBy | string | Sort By | Optional | AchievementCount, DisplayName, FirstAwardDate | |
SortOrder | string | Sort Order | Optional | Ascending, Descending | |
StartDate | DateTime | Start Date | Optional |
Return Type
Update
Allows an abuse report to be updated
Usage
#set($abuseReportResponse = $core_v2_abuseReport.Update($id, "%{AbuseReasonId = $abuseReasonIdArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
id | Guid | Id of the abuse report | Required | ||
AbuseReasonId | int | Abuse Reason Id | Optional | 0 |