core_v2_abuseAppeal Script API

Ben Tiedt — Wed, 20 Nov 2019 14:51:49 GMT

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

Enables scripted content fragments to use AbuseAppeals

Properties
AcceptAppeal
CanReviewAppealsInApplication
CanReviewAppealsInContainer
CanReviewAppealsInSite
Create
Get
List
RejectAppeal
RespondToAppeal

Properties

Name	Access	Type	Description
Current	Read	`[[AbuseAppeal Script API Type\|AbuseAppeal]]`	Gets the current contextual Abuse Appeal

Methods

AcceptAppeal

Board accepts an appeal

Velocity

#set($abuseAppealResponse = $core_v2_abuseAppeal.AcceptAppeal($appealId, $boardResponse))

JavaScript

var abuseAppealResponse = core_v2_abuseAppeal.AcceptAppeal(appealId, boardResponse);

Parameters

Name	Type	Description	Required	Default	Options
appealId	`Guid`	Id of the appeal	Required
boardResponse	`String`	Response of the Board	Required

Returns

[[AbuseAppeal Script API Type|AbuseAppeal]]

CanReviewAppealsInApplication

Velocity

#set($booleanResponse = $core_v2_abuseAppeal.CanReviewAppealsInApplication($applicationId, $applicationTypeId))

JavaScript

var booleanResponse = core_v2_abuseAppeal.CanReviewAppealsInApplication(applicationId, applicationTypeId);

Parameters

Name	Type	Description	Required	Default	Options
applicationId	`Guid`	Application Id	Required
applicationTypeId	`Guid`	Application Type Id	Required

Returns

Boolean

CanReviewAppealsInContainer

Velocity

#set($booleanResponse = $core_v2_abuseAppeal.CanReviewAppealsInContainer($containerId, $containerTypeId))

JavaScript

var booleanResponse = core_v2_abuseAppeal.CanReviewAppealsInContainer(containerId, containerTypeId);

Parameters

Name	Type	Description	Required	Default	Options
containerId	`Guid`	Container Id	Required
containerTypeId	`Guid`	Container Type Id	Required

Returns

Boolean

CanReviewAppealsInSite

Velocity

#set($booleanResponse = $core_v2_abuseAppeal.CanReviewAppealsInSite())

JavaScript

var booleanResponse = core_v2_abuseAppeal.CanReviewAppealsInSite();

Returns

Boolean

Create

Hides the content and initiates an appeal

Velocity

#set($abuseAppealResponse = $core_v2_abuseAppeal.Create($contentId, $contentTypeId))

JavaScript

var abuseAppealResponse = core_v2_abuseAppeal.Create(contentId, contentTypeId);

Parameters

Name	Type	Description	Required	Default	Options
contentId	`Guid`	Content Id of the content for which to initiate the appeal	Required
contentTypeId	`Guid`	Content Type Id of the content for which to initiate the appeal	Required

Returns

[[AbuseAppeal Script API Type|AbuseAppeal]]

Get

Get a single appeal

Velocity

#set($abuseAppealResponse = $core_v2_abuseAppeal.Get($appealId))

JavaScript

var abuseAppealResponse = core_v2_abuseAppeal.Get(appealId);

Parameters

Name	Type	Description	Required	Default	Options
appealId	`Guid`	Id of the appeal	Required

Returns

[[AbuseAppeal Script API Type|AbuseAppeal]]

List

Lists abuse appeals

Velocity

#set($pagedListResponse = $core_v2_abuseAppeal.List("%{ AbuseId = $abuseIdArg, AppealId = $appealIdArg, AppealState = $appealStateArg, ApplicationId = $applicationIdArg, ContainerId = $containerIdArg, ContentAuthorId = $contentAuthorIdArg, ContentId = $contentIdArg, ContentTypeId = $contentTypeIdArg, PageIndex = $pageIndexArg, PageSize = $pageSizeArg, SortBy = $sortByArg, SortOrder = $sortOrderArg }"))

JavaScript

var pagedListResponse = core_v2_abuseAppeal.List({ AbuseId: abuseIdArg, AppealId: appealIdArg, AppealState: appealStateArg, ApplicationId: applicationIdArg, ContainerId: containerIdArg, ContentAuthorId: contentAuthorIdArg, ContentId: contentIdArg, ContentTypeId: contentTypeIdArg, PageIndex: pageIndexArg, PageSize: pageSizeArg, SortBy: sortByArg, SortOrder: sortOrderArg });

Parameters

Name	Type	Description	Required	Default	Options
AbuseId	`Guid`	Abuse Id	Optional
AppealId	`Guid`	Appeal Id	Optional
AppealState	`String`	Appeal State	Optional	Default	Accepted, AuthorResponded, Default, Expired, Initiated, ModerationRequired, Rejected
ApplicationId	`Guid`	Application Id	Optional
ContainerId	`Guid`	Container Id	Optional
ContentAuthorId	`Guid`	Content Author Id	Optional
ContentId	`Guid`	Content Id	Optional
ContentTypeId	`Guid`	Content Type Id	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
SortBy	`String`	Sort By	Optional	AppealDate	AppealDate, AppealId, AuthorUserId, AuthorUserName, ContentDate
SortOrder	`String`	Sort Order	Optional	Ascending	Ascending, Descending

Returns

[[PagedList Script API Type|PagedList]] of [[AbuseAppeal Script API Type|AbuseAppeal]]

RejectAppeal

Board rejects an appeal

Velocity

#set($abuseAppealResponse = $core_v2_abuseAppeal.RejectAppeal($appealId, $boardResponse))

JavaScript

var abuseAppealResponse = core_v2_abuseAppeal.RejectAppeal(appealId, boardResponse);

Parameters

Name	Type	Description	Required	Default	Options
appealId	`Guid`	Id of the appeal	Required
boardResponse	`String`	Response of the Board	Required

Returns

[[AbuseAppeal Script API Type|AbuseAppeal]]

RespondToAppeal

Author responds to an appeal

Velocity

#set($abuseAppealResponse = $core_v2_abuseAppeal.RespondToAppeal($appealId, $authorResponse))

JavaScript

var abuseAppealResponse = core_v2_abuseAppeal.RespondToAppeal(appealId, authorResponse);

Parameters

Name	Type	Description	Required	Default	Options
appealId	`Guid`	Id of the appeal	Required
authorResponse	`String`	Response of the Author	Required

Returns

[[AbuseAppeal Script API Type|AbuseAppeal]]