Enables scripted content fragments to use AbuseReports
Methods
CanBeMarkedAsAbusive
Returns a whether the content type id can be marked as abusive or not.
Velocity
#set($booleanResponse = $core_v2_abuseReport.CanBeMarkedAsAbusive($contentTypeId))
JavaScript
var booleanResponse = core_v2_abuseReport.CanBeMarkedAsAbusive(contentTypeId);
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
contentTypeId | Guid | Content Type Id | Required |
Returns
Boolean
Create
Create Overload 1
Creates an abuse report against the supplied ContentId item
Velocity
#set($abuseReportResponse = $core_v2_abuseReport.Create($contentId, $contentTypeId))
JavaScript
var 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 |
Create Overload 2
Creates an abuse report against the supplied ContentId item
Velocity
#set($abuseReportResponse = $core_v2_abuseReport.Create($contentId, $contentTypeId, "%{ AbuseReasonId = $abuseReasonIdArg }"))
JavaScript
var 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 | ||
options | Options | Set of optional parameters including: | Required | ||
AbuseReasonId | Int32 | Abuse Reason Id | Optional | 0 |
Returns
Get
Retrieves an AbuseReport
Velocity
#set($abuseReportResponse = $core_v2_abuseReport.Get($id))
JavaScript
var abuseReportResponse = core_v2_abuseReport.Get(id);
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
id | Guid | The Id of the AbuseReport to get | Required |
Returns
List
Returns a list of abuse reports
Velocity
#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 }"))
JavaScript
var 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 |
---|---|---|---|---|---|
options | Options | Set of optional parameters including: | Required | ||
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 | Boolean | Assigned To Appeal | Optional | ||
AuthorUserId | Guid | Author User Id | Optional | ||
EndDate | DateTime | End Date | Optional | ||
PageIndex | Int32 | Specify the page number of paged results to return. Zero-based index. | Optional | 0 | |
PageSize | Int32 | Specify the number of results to return per page. | Optional | 20 | |
ReportingUserId | Int32 | Reporting User Id | Optional | ||
SortBy | String | Sort By | Optional | AchievementCount, DisplayName, FirstAwardDate | |
SortOrder | String | Sort Order | Optional | Ascending, Descending | |
StartDate | DateTime | Start Date | Optional |
Returns
Update
Allows an abuse report to be updated
Velocity
#set($abuseReportResponse = $core_v2_abuseReport.Update($id, "%{ AbuseReasonId = $abuseReasonIdArg }"))
JavaScript
var abuseReportResponse = core_v2_abuseReport.Update(id, { AbuseReasonId: abuseReasonIdArg });
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
id | Guid | Id of the abuse report | Required | ||
options | Options | Set of optional parameters including: | Required | ||
AbuseReasonId | Int32 | Abuse Reason Id | Optional | 0 |