IAbuseAppeals In-Process API Supplementary Type

Ben Tiedt — Fri, 15 Jan 2021 20:05:34 GMT

Current Revision posted to API Documentation by Ben Tiedt on 01/15/2021 20:05:34

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

Definition

interface IAbuseAppeals
{
	Guid DataTypeId { get;  }
	IAbuseAppealEvents Events { get;  }
	[[AbuseAppeal In-Process API Supplementary Type|AbuseAppeal]] AcceptAppeal(Guid appealId, string boardResponse);
	[[AbuseAppeal In-Process API Supplementary Type|AbuseAppeal]] Create(Guid contentId, Guid contentTypeId);
	[[AbuseAppeal In-Process API Supplementary Type|AbuseAppeal]] Get(Guid id);
	[[PagedList(T) In-Process API Supplementary Type|PagedList]]<[[AbuseAppeal In-Process API Supplementary Type|AbuseAppeal]]> List([[AbuseAppealListOptions In-Process API Supplementary Type|AbuseAppealListOptions]] options);
	[[AbuseAppeal In-Process API Supplementary Type|AbuseAppeal]] RejectAppeal(Guid appealId, string boardResponse);
	[[AbuseAppeal In-Process API Supplementary Type|AbuseAppeal]] RespondToAppeal(Guid appealId, string authorResponse);
}

Properties

Name	Type	Description	Default	Options
DataTypeId	`Guid`	Abuse Appeals data type identifier
Events	`IAbuseAppealEvents`	AbuseAppeals events

Methods

AbuseAppeal AcceptAppeal(Guid appealId, string boardResponse);

Board accepts an appeal

Parameters

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

Return Type

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

AbuseAppeal Create(Guid contentId, Guid contentTypeId);

Parameters

Name	Type	Description	Required	Default	Options
contentId	`Guid`	Content Id	Required
contentTypeId	`Guid`	Content Type Id	Required

Return Type

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

AbuseAppeal Get(Guid id);

Get abuse appeal

Parameters

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

Return Type

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

PagedList<AbuseAppeal> List(AbuseAppealListOptions options);

Lists abuse appeals

Parameters

Name	Type	Description	Required	Default	Options
options	`[[AbuseAppealListOptions In-Process API Supplementary Type\|AbuseAppealListOptions]]`	Options include: AppealId, AbuseId, ContentId, ContentTypeId, ContainerId, ApplicationId, ContentAuthorId, AppealState(Default, Initiated, Accepted, Rejected, Expired, AuthorResponded), SortBy(AppealId, AuthorUserId, AuthorUsername), SortOrder (Asc, Desc), PageSize and PageIndex	Required

Return Type

[[PagedList(T) In-Process API Supplementary Type|PagedList]]<[[AbuseAppeal In-Process API Supplementary Type|AbuseAppeal]]>

AbuseAppeal RejectAppeal(Guid appealId, string boardResponse);

Board rejects an appeal

Parameters

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

Return Type

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

AbuseAppeal RespondToAppeal(Guid appealId, string authorResponse);

Author responds to an appeal

Parameters

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

Return Type

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