Namespace Unity.Services.Ugc

Classes

BaseSearchArgs<T>

Base class for supporting other SearchRequest class with pagination information

Content

Contains content metadata

ContentUserRating

Contains content user rating metadata

ContentVersion

Contains content version metadata

CreateContentArgs

Support class to make a content request with CreateContentAsync(CreateContentArgs) Contains all the parameters of the request

CreateRepresentationArgs

Support class to make a representation request with CreateRepresentationAsync(CreateRepresentationArgs) Contains all the parameters of the request

DeleteRepresentationArgs

Support class to make a representation request with DeleteRepresentationAsync(DeleteRepresentationArgs) Contains all the parameters of the request

GetContentArgs

Support class to make a content request with GetContentAsync(GetContentArgs) Contains all the parameters of the request

GetContentTrendsArgs

Support class to make a content request with GetContentTrendsAsync(GetContentTrendsArgs) Contains all the required and optional parameters of the request

GetContentVersionsArgs

Support class to make a content version request with GetRepresentationVersionsAsync(GetRepresentationVersionsArgs) Contains all the required and optional parameters of the request

GetContentsArgs

Support class to make a content request with GetContentsAsync(GetContentsArgs) Contains all the required and optional parameters of the request

GetPlayerContentsArgs

Support class to make a content request with GetPlayerContentsAsync(GetPlayerContentsArgs) Contains all the required and optional parameters of the request

GetRepresentationArgs

Support class to make a representation request with GetRepresentationAsync(GetRepresentationArgs) Contains all the parameters of the request

GetRepresentationVersionsArgs

Support class to make a representation version request with GetRepresentationVersionsAsync(GetRepresentationVersionsArgs) Contains all the required and optional parameters of the request

GetRepresentationsArgs

Support class to make a representation request with GetRepresentationsAsync(GetRepresentationsArgs) Contains all the required and optional parameters of the request

GetSubscriptionsArgs

Support class to make a subscription request with GetSubscriptionsAsync(GetSubscriptionsArgs) Contains all the required and optional parameters of the request

PagedResults<T>

Container for paginated results used in search requests

ReportContentArgs

Support class to make a content request with ReportContentAsync(ReportContentArgs) Contains all the required and optional parameters of the request

Representation

Contains source content representation metadata

RepresentationTag

Contains representation tag metadata

RepresentationVersion

Contains source content representation metadata

SearchContentModerationArgs

Support class to make a content request with SearchContentModerationAsync(SearchContentModerationArgs) Contains all the required and optional parameters of the request

SearchRepresentationsArgs

Support class to make a representation request with SearchRepresentationsAsync(SearchRepresentationsArgs) Contains all the required and optional parameters of the request

Subscription

Contains subscription metadata

Tag

Contains tag metadata

UgcErrorCodes

UgcErrorCodes lists the error codes to expect from UgcException and failed events. The error code range is: 22000 to 22999.

UgcException

UgcException represents a runtime exception from UGC.

UgcService

The entry point of the UGC package. Once initialized, you can use the Instance singleton to implement UGC features.

UpdateContentDetailsArgs

Support class to update details about a content item UpdateContentDetailsAsync(UpdateContentDetailsArgs) Contains all the required and optional parameters of the request

UpdateRepresentationArgs

Support class to update details about a representation item UpdateRepresentationAsync(UpdateRepresentationArgs) Contains all the required and optional parameters of the request

Interfaces

IUgcService

This interface describes the UGC related methods available to game clients.

Enums

BaseSearchSortBy

Field by which results can be sorted.

ContentTrendType

Trend type used to retrieve trending contents

SearchContentSortBy

Fields by which results can be sorted while searching contents.

SearchContentVersionsSortBy

Field by which results can be sorted while searching content versions.

SearchRepresentationVersionSortBy

Field by which results can be sorted while searching RepresentationVersions.

SearchSubscriptionSortBy

Fields by which results can be sorted while searching subscriptions.