Class UGCModerationApi

Represents a collection of functions to interact with the API endpoints

Inheritance

object

UGCModerationApi

Implements

IUGCModerationApi

IApiAccessor

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Namespace: Unity.Services.Apis.UGC

Assembly: solution.dll

Syntax

public class UGCModerationApi : IUGCModerationApi, IApiAccessor

Constructors

UGCModerationApi(IApiClient)

Initializes a new instance of the UGCModerationApi class using a Configuration object and client instance.

Declaration

public UGCModerationApi(IApiClient apiClient)

Parameters

Type	Name	Description
IApiClient	apiClient	The client interface for synchronous API access.

UGCModerationApi(IApiClient, IApiConfiguration)

Initializes a new instance of the UGCModerationApi class using a Configuration object and client instance.

Declaration

public UGCModerationApi(IApiClient apiClient, IApiConfiguration apiConfiguration)

Parameters

Type	Name	Description
IApiClient	apiClient	The client interface for synchronous API access.
IApiConfiguration	apiConfiguration	The configuration object.

Properties

Client

The client for accessing this underlying API asynchronously.

Declaration

public IApiClient Client { get; }

Property Value

Type	Description
IApiClient

Configuration

Gets the configuration object

Declaration

public IApiConfiguration Configuration { get; }

Property Value

Type	Description
IApiConfiguration	An instance of the Configuration

Methods

ApproveContent(string, string, string, CancellationToken)

Approve content that needed moderation

Declaration

public ApiOperation<ContentDTO> ApproveContent(string projectId, string environmentId, string contentId, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	projectId	The content's projectId
string	environmentId	The content's environmentId
string	contentId	The content's id
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation<ContentDTO>	The operation

GetBasePath()

Gets the base path of the API client.

Declaration

public string GetBasePath()

Returns

Type	Description
string	The base path

GetContentModeration(string, string, string, CancellationToken)

Get one content that needs moderation. Includes tags and stats

Declaration

public ApiOperation<ContentDTO> GetContentModeration(string projectId, string environmentId, string contentId, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	projectId	Content's project id
string	environmentId	Content's environment id
string	contentId	Content's id
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation<ContentDTO>	The operation

RejectContent(string, string, string, RejectContentRequest, CancellationToken)

Reject content that needed moderation

Declaration

public ApiOperation<ContentDTO> RejectContent(string projectId, string environmentId, string contentId, RejectContentRequest rejectContentRequest = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	projectId	The content's projectId
string	environmentId	The content's environmentId
string	contentId	The content's id
RejectContentRequest	rejectContentRequest	Reason for the rejection (optional)
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation<ContentDTO>	The operation

ReportContent(string, string, string, ReportContentRequest, CancellationToken)

Report content V2

Declaration

public ApiOperation<ContentDTO> ReportContent(string projectId, string environmentId, string contentId, ReportContentRequest reportContentRequest = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	projectId	The project that the content belongs to
string	environmentId	The environment that the content belongs to
string	contentId	The content id
ReportContentRequest	reportContentRequest	The reason for the report (optional)
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation<ContentDTO>	The operation

SearchContentModeration(string, string, int?, int?, List<string>, string, List<string>, bool?, CancellationToken)

Search for content that needs moderation

Declaration

public ApiOperation<ContentDTOPagedResult> SearchContentModeration(string projectId, string environmentId, int? offset = null, int? limit = null, List<string> sortBys = null, string search = null, List<string> filters = null, bool? includeTotal = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	projectId	Content that belongs to this project
string	environmentId	Content that belongs to this environment
int?	offset	The amount of results to skip (optional)
int?	limit	The amount of results to take (optional)
List<string>	sortBys	The field to use to sort by in ascending order, prefix - for descending (optional)
string	search	Only return results with this search term in their name (optional)
List<string>	filters	You can filter on any field in the DTO<br /> Syntax for filters is: {field},{operator},{value}<br /> The operators are: eq (equal to), neq (not equal to), gt (greater than), gte (greater than or equal), lt (less than), lte (less than or equal)<br /> The field can be nested up to two levels. Ex: "field.nestedField.nestedNestedField"<br /> filters="deletedAt,eq,null" will only return entities that have not been deleted<br /> (optional)
bool?	includeTotal	Should the result include the total count of objects available to page (optional)
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation<ContentDTOPagedResult>	The operation

Implements

IUGCModerationApi

IApiAccessor