Provide APIs to access UGC service. More...

#include <AccelByteUGCApi.h>

Inheritance diagram for AccelByte::Api::UGC:

Public Member Functions
	UGC (Credentials const &InCredentialsRef, Settings const &InSettingsRef, FHttpRetrySchedulerBase &InHttpRef, TSharedPtr< AccelByte::FApiClient, ESPMode::ThreadSafe > const &InApiClient=nullptr)
	UGC (Credentials const &InCredentialsRef, Settings const &InSettingsRef, FHttpRetrySchedulerBase &InHttpRef, FAccelBytePlatformPtr const &InAccelBytePlatform)
FAccelByteTaskWPtr	CreateContent (FString const &ChannelId, FAccelByteModelsUGCRequest const &UGCRequest, THandler< FAccelByteModelsUGCResponse > const &OnSuccess, FErrorHandler const &OnError)
	Create a content with FString preview and get the payload url to upload the content.
FAccelByteTaskWPtr	CreateContent (FString const &ChannelId, FString const &Name, FString const &Type, FString const &SubType, TArray< FString > const &Tags, TArray< uint8 > const &Preview, FString const &FileExtension, THandler< FAccelByteModelsUGCResponse > const &OnSuccess, FErrorHandler const &OnError, FString const &ContentType=TEXT("application/octet-stream"))
	Create a content with TArray<uint8> Preview parameter and get the payload url to upload the content.
FAccelByteTaskWPtr	ModifyContent (FString const &ChannelId, FString const &ContentId, FAccelByteModelsUGCUpdateRequest const &ModifyRequest, THandler< FAccelByteModelsUGCResponse > const &OnSuccess, FErrorHandler const &OnError)
	Modify existing content to update some information with FString preview.
FAccelByteTaskWPtr	ModifyContent (FString const &ChannelId, FString const &ContentId, FAccelByteModelsUGCRequest const &UGCRequest, THandler< FAccelByteModelsUGCResponse > const &OnSuccess, FErrorHandler const &OnError, bool bUpdateContent=false)
	Modify existing content to update some information with FString preview.
FAccelByteTaskWPtr	ModifyContent (FString const &ChannelId, FString const &ContentId, FString const &Name, FString const &Type, FString const &SubType, TArray< FString > const &Tags, TArray< uint8 > const &Preview, FString const &FileExtension, THandler< FAccelByteModelsUGCResponse > const &OnSuccess, FErrorHandler const &OnError, FString const &ContentType=TEXT("application/octet-stream"), bool bUpdateContent=false)
	Modify existing content to update some information with TArray<uint8> Preview parameter.
FAccelByteTaskWPtr	DeleteContent (FString const &ChannelId, FString const &ContentId, FVoidHandler const &OnSuccess, FErrorHandler const &OnError)
	Delete a content based on the its channel id and content id.
FAccelByteTaskWPtr	GetContentByContentId (FString const &ContentId, THandler< FAccelByteModelsUGCContentResponse > const &OnSuccess, FErrorHandler const &OnError)
	Get a content information by its content id.
FAccelByteTaskWPtr	PublicGetContentByContentId (FString const &ContentId, THandler< FAccelByteModelsUGCContentResponse > const &OnSuccess, FErrorHandler const &OnError)
	Get a content information by its content id. Can be used without logged in.
FAccelByteTaskWPtr	GetContentByShareCode (FString const &ShareCode, THandler< FAccelByteModelsUGCContentResponse > const &OnSuccess, FErrorHandler const &OnError)
	Get a content information by its share code.
FAccelByteTaskWPtr	PublicGetContentByShareCode (FString const &ShareCode, THandler< FAccelByteModelsUGCContentResponse > const &OnSuccess, FErrorHandler const &OnError)
	Get a content information by its share code. Can be used without logged in.
FAccelByteTaskWPtr	GetContentPreview (FString const &ContentId, THandler< FAccelByteModelsUGCPreview > const &OnSuccess, FErrorHandler const &OnError)
	Get content Preview as FAccelByteModelsUGCPreview.
FAccelByteTaskWPtr	GetContentPreview (FString const &ContentId, THandler< TArray< uint8 > > const &OnSuccess, FErrorHandler const &OnError)
	Get content preview as TArray<uint8>.
FAccelByteTaskWPtr	GetTags (THandler< FAccelByteModelsUGCTagsPagingResponse > const &OnSuccess, FErrorHandler const &OnError, int32 Limit=1000, int32 Offset=0)
	Get all tags.
FAccelByteTaskWPtr	GetTypes (THandler< FAccelByteModelsUGCTypesPagingResponse > const &OnSuccess, FErrorHandler const &OnError, int32 Limit=1000, int32 Offset=0)
	Get all types and subtypes.
FAccelByteTaskWPtr	CreateChannel (FString const &ChannelName, THandler< FAccelByteModelsUGCChannelResponse > const &OnSuccess, FErrorHandler const &OnError)
	Create a player's channel with specific channel name.
FAccelByteTaskWPtr	UpdateChannel (FString const &ChannelId, FString const &ChannelName, THandler< FAccelByteModelsUGCChannelResponse > const &OnSuccess, FErrorHandler const &OnError)
	Update a player's channel with specific channel name.
FAccelByteTaskWPtr	GetChannels (THandler< FAccelByteModelsUGCChannelsPagingResponse > const &OnSuccess, FErrorHandler const &OnError, int32 Limit=1000, int32 Offset=0, FString const &ChannelName="")
	Get all of the player's channels.
FAccelByteTaskWPtr	GetChannels (FString const &UserId, THandler< FAccelByteModelsUGCChannelsPagingResponse > const &OnSuccess, FErrorHandler const &OnError, int32 Limit=1000, int32 Offset=0, FString const &ChannelName="")
	Get all of the player's channels.
FAccelByteTaskWPtr	DeleteChannel (FString const &ChannelId, FVoidHandler const &OnSuccess, FErrorHandler const &OnError)
	Delete a player's channel based on the its channel id.
FAccelByteTaskWPtr	SearchContents (FString const &Name, FString const &Creator, FString const &Type, FString const &Subtype, TArray< FString > const &Tags, bool IsOfficial, FString const &UserId, THandler< FAccelByteModelsUGCSearchContentsPagingResponse > const &OnSuccess, FErrorHandler const &OnError, EAccelByteUgcSortBy SortBy=EAccelByteUgcSortBy::DATE, EAccelByteUgcOrderBy OrderBy=EAccelByteUgcOrderBy::DESC, int32 Limit=1000, int32 Offset=0)
	Search specific contents based on the given filter.
FAccelByteTaskWPtr	SearchContents (FAccelByteModelsUGCSearchContentsRequest const &Request, THandler< FAccelByteModelsUGCSearchContentsPagingResponse > const &OnSuccess, FErrorHandler const &OnError, int32 Limit=20, int32 Offset=0)
	Search specific contents based on the given filter.
FAccelByteTaskWPtr	PublicSearchContents (FString const &Name, FString const &Creator, FString const &Type, FString const &Subtype, TArray< FString > const &Tags, bool IsOfficial, FString const &UserId, THandler< FAccelByteModelsUGCSearchContentsPagingResponse > const &OnSuccess, FErrorHandler const &OnError, EAccelByteUgcSortBy SortBy=EAccelByteUgcSortBy::DATE, EAccelByteUgcOrderBy OrderBy=EAccelByteUgcOrderBy::DESC, int32 Limit=1000, int32 Offset=0)
	Search specific contents based on the given filter. Can be used without logged in.
FAccelByteTaskWPtr	PublicSearchContents (FAccelByteModelsUGCSearchContentsRequest const &Request, THandler< FAccelByteModelsUGCSearchContentsPagingResponse > const &OnSuccess, FErrorHandler const &OnError, int32 Limit=20, int32 Offset=0)
	Search specific contents based on the given filter. Can be used without logged in.
FAccelByteTaskWPtr	UpdateLikeStatusToContent (FString const &ContentId, bool bLikeStatus, THandler< FAccelByteModelsUGCUpdateLikeStatusToContentResponse > const &OnSuccess, FErrorHandler const &OnError)
	Update like/unlike status to a content.
FAccelByteTaskWPtr	GetListFollowers (FString const &UserId, THandler< FAccelByteModelsUGCGetListFollowersPagingResponse > const &OnSuccess, FErrorHandler const &OnError, int32 Limit=1000, int32 Offset=0)
	Get list of followers.
FAccelByteTaskWPtr	UpdateFollowStatusToUser (FString const &UserId, bool bFollowStatus, THandler< FAccelByteModelsUGCUpdateFollowStatusToUserResponse > const &OnSuccess, FErrorHandler const &OnError)
	Update follow/unfollow status to a user.
FAccelByteTaskWPtr	SearchContentsSpecificToChannel (FString const &ChannelId, FString const &Name, FString const &Creator, FString const &Type, FString const &Subtype, TArray< FString > const &Tags, bool IsOfficial, FString const &UserId, THandler< FAccelByteModelsUGCSearchContentsPagingResponse > const &OnSuccess, FErrorHandler const &OnError, EAccelByteUgcSortBy SortBy=EAccelByteUgcSortBy::DATE, EAccelByteUgcOrderBy OrderBy=EAccelByteUgcOrderBy::DESC, int32 Limit=1000, int32 Offset=0)
	Search contents specific to a channel.
FAccelByteTaskWPtr	SearchContentsSpecificToChannel (FString const &ChannelId, FAccelByteModelsUGCSearchContentsRequest const &Request, THandler< FAccelByteModelsUGCSearchContentsPagingResponse > const &OnSuccess, FErrorHandler const &OnError, int32 Limit=20, int32 Offset=0)
	Search contents specific to a channel.
FAccelByteTaskWPtr	GetContentBulk (TArray< FString > const &ContentIds, THandler< TArray< FAccelByteModelsUGCContentResponse > > const &OnSuccess, FErrorHandler const &OnError)
	Get contents by content Ids.
FAccelByteTaskWPtr	PublicGetContentBulk (TArray< FString > const &ContentIds, THandler< TArray< FAccelByteModelsUGCContentResponse > > const &OnSuccess, FErrorHandler const &OnError)
	Get contents by content Ids. Can be used without logged in.
FAccelByteTaskWPtr	GetUserContent (FString const &UserId, THandler< FAccelByteModelsUGCContentPageResponse > const &OnSuccess, FErrorHandler const &OnError, int32 Limit=1000, int32 Offset=0)
	Get user's generated contents.
FAccelByteTaskWPtr	PublicGetUserContent (FString const &UserId, THandler< FAccelByteModelsUGCContentPageResponse > const &OnSuccess, FErrorHandler const &OnError, int32 Limit=1000, int32 Offset=0)
	Get user's generated contents. Can be used without logged in.
FAccelByteTaskWPtr	UploadContentScreenshot (FString const &ContentId, FString const &UserId, FAccelByteModelsUGCScreenshotsRequest ScreenshotsRequest, THandler< FAccelByteModelsUGCUpdateContentScreenshotResponse > const &OnSuccess, FErrorHandler const &OnError)
	Upload screenshots for content.
FAccelByteTaskWPtr	GetFollowedContent (THandler< FAccelByteModelsUGCContentPageResponse > const &OnSuccess, FErrorHandler const &OnError, int32 Limit=1000, int32 Offset=0)
	Get contents from followed creators.
FAccelByteTaskWPtr	GetFollowedUsers (THandler< FAccelByteModelsUGCFollowedUsersResponse > const &OnSuccess, FErrorHandler const &OnError, int32 Limit=1000, int32 Offset=0)
	Get followed creators.
FAccelByteTaskWPtr	GetLikedContent (TArray< FString > const &Tags, FString const &Name, FString const &Type, FString const &Subtype, bool IsOfficial, THandler< FAccelByteModelsUGCContentPageResponse > const &OnSuccess, FErrorHandler const &OnError, int32 Limit=1000, int32 Offset=0, EAccelByteUgcSortBy SortBy=EAccelByteUgcSortBy::DATE, EAccelByteUgcOrderBy OrderBy=EAccelByteUgcOrderBy::DESC)
	Get liked contents.
FAccelByteTaskWPtr	GetLikedContent (TArray< FString > const &Tags, FString const &Name, FString const &Type, FString const &Subtype, bool IsOfficial, THandler< FAccelByteModelsUGCContentPageResponse > const &OnSuccess, FErrorHandler const &OnError, int32 Limit=1000, int32 Offset=0, EAccelByteLikedContentSortBy SortBy=EAccelByteLikedContentSortBy::DATE, EAccelByteUgcOrderBy OrderBy=EAccelByteUgcOrderBy::DESC)
	Get liked contents.
FAccelByteTaskWPtr	GetCreator (FString const &UserId, THandler< FAccelByteModelsUGCGetListFollowersResponse > const &OnSuccess, FErrorHandler const &OnError)
	Get creator stats: number of total like by other user, number of total following and follower user.
FAccelByteTaskWPtr	GetGroups (FString const &UserId, THandler< FAccelByteModelsUGCGetGroupsResponse > const &OnSuccess, FErrorHandler const &OnError, int32 Limit=1000, int32 Offset=0)
	Get all user groups.
FAccelByteTaskWPtr	BulkGetContentByShareCode (TArray< FString > const &ShareCodes, THandler< TArray< FAccelByteModelsUGCContentResponse > > const &OnSuccess, FErrorHandler const &OnError)
	Bulk Get contents by ShareCodes.
FAccelByteTaskWPtr	SearchContentsSpecificToChannelV2 (FString const &ChannelId, THandler< FAccelByteModelsUGCSearchContentsPagingResponseV2 > const &OnSuccess, FErrorHandler const &OnError, int32 Limit=20, int32 Offset=0, EAccelByteUGCContentUtilitiesSortByV2 SortBy=EAccelByteUGCContentUtilitiesSortByV2::CREATED_TIME_DESC)
	Search contents specific to a channel.
FAccelByteTaskWPtr	PublicSearchContentsSpecificToChannelV2 (FString const &ChannelId, THandler< FAccelByteModelsUGCSearchContentsPagingResponseV2 > const &OnSuccess, FErrorHandler const &OnError, int32 Limit=20, int32 Offset=0, EAccelByteUGCContentUtilitiesSortByV2 SortBy=EAccelByteUGCContentUtilitiesSortByV2::CREATED_TIME_DESC)
	Search contents specific to a channel. Can be used without logged in.
FAccelByteTaskWPtr	SearchContentsV2 (FAccelByteModelsUGCFilterRequestV2 const &Filter, THandler< FAccelByteModelsUGCSearchContentsPagingResponseV2 > const &OnSuccess, FErrorHandler const &OnError, int32 Limit=20, int32 Offset=0, EAccelByteUGCContentSortByV2 SortBy=EAccelByteUGCContentSortByV2::CREATED_TIME_DESC)
	Get all contents in current namespace.
FAccelByteTaskWPtr	PublicSearchContentsV2 (FAccelByteModelsUGCFilterRequestV2 const &Filter, THandler< FAccelByteModelsUGCSearchContentsPagingResponseV2 > const &OnSuccess, FErrorHandler const &OnError, int32 Limit=20, int32 Offset=0, EAccelByteUGCContentSortByV2 SortBy=EAccelByteUGCContentSortByV2::CREATED_TIME_DESC)
	Get all contents in current namespace. Can be used without logged in.
FAccelByteTaskWPtr	GetContentBulkByIdsV2 (TArray< FString > const &ContentIds, THandler< TArray< FAccelByteModelsUGCContentResponseV2 > > const &OnSuccess, FErrorHandler const &OnError)
	Get contents by content Ids.
FAccelByteTaskWPtr	PublicGetContentBulkByIdsV2 (TArray< FString > const &ContentIds, THandler< TArray< FAccelByteModelsUGCContentResponseV2 > > const &OnSuccess, FErrorHandler const &OnError)
	Get contents by content Ids. Can be used without logged in.
FAccelByteTaskWPtr	GetContentByShareCodeV2 (FString const &ShareCode, THandler< FAccelByteModelsUGCContentResponseV2 > const &OnSuccess, FErrorHandler const &OnError)
	Get a content information by its share code.
FAccelByteTaskWPtr	PublicGetContentByShareCodeV2 (FString const &ShareCode, THandler< FAccelByteModelsUGCContentResponseV2 > const &OnSuccess, FErrorHandler const &OnError)
	Get a content information by its share code. Can be used without logged in.
FAccelByteTaskWPtr	GetContentByContentIdV2 (FString const &ContentId, THandler< FAccelByteModelsUGCContentResponseV2 > const &OnSuccess, FErrorHandler const &OnError)
	Get a content information by its content id.
FAccelByteTaskWPtr	PublicGetContentByContentIdV2 (FString const &ContentId, THandler< FAccelByteModelsUGCContentResponseV2 > const &OnSuccess, FErrorHandler const &OnError)
	Get a content information by its content id. Can be used without logged in.
FAccelByteTaskWPtr	CreateContentV2 (FString const &ChannelId, FAccelByteModelsCreateUGCRequestV2 const &CreateRequest, THandler< FAccelByteModelsUGCCreateUGCResponseV2 > const &OnSuccess, FErrorHandler const &OnError)
	Create a UGC content with create content request.
FAccelByteTaskWPtr	DeleteContentV2 (FString const &ChannelId, FString const &ContentId, FVoidHandler const &OnSuccess, FErrorHandler const &OnError)
	Delete a content based on the its channel id and content id.
FAccelByteTaskWPtr	ModifyContentV2 (FString const &ChannelId, FString const &ContentId, FAccelByteModelsModifyUGCRequestV2 const &ModifyRequest, THandler< FAccelByteModelsUGCModifyUGCResponseV2 > const &OnSuccess, FErrorHandler const &OnError)
	Modify existing content to update content metadata.
FAccelByteTaskWPtr	GenerateUploadContentURLV2 (FString const &ChannelId, FString const &ContentId, FAccelByteModelsUploadContentURLRequestV2 const &UploadRequest, THandler< FAccelByteModelsUGCUploadContentURLResponseV2 > const &OnSuccess, FErrorHandler const &OnError)
	Generate Upload URL and Conten File Location.
FAccelByteTaskWPtr	UpdateContentFileLocationV2 (FString const &ChannelId, FString const &ContentId, FString const &FileExtension, FString const &S3Key, THandler< FAccelByteModelsUGCUpdateContentFileLocationResponseV2 > const &OnSuccess, FErrorHandler const &OnError)
	Update Content File Location in S3.
FAccelByteTaskWPtr	GetUserContentsV2 (FString const &UserId, THandler< FAccelByteModelsUGCSearchContentsPagingResponseV2 > const &OnSuccess, FErrorHandler const &OnError, int32 Limit=20, int32 Offset=0, EAccelByteUGCContentUtilitiesSortByV2 SortBy=EAccelByteUGCContentUtilitiesSortByV2::CREATED_TIME_DESC)
	Get user's generated contents.
FAccelByteTaskWPtr	PublicGetUserContentsV2 (FString const &UserId, THandler< FAccelByteModelsUGCSearchContentsPagingResponseV2 > const &OnSuccess, FErrorHandler const &OnError, int32 Limit=20, int32 Offset=0, EAccelByteUGCContentUtilitiesSortByV2 SortBy=EAccelByteUGCContentUtilitiesSortByV2::CREATED_TIME_DESC)
	Get user's generated contents. Can be used without logged in.
FAccelByteTaskWPtr	UpdateContentScreenshotV2 (FString const &ContentId, FAccelByteModelsUGCUpdateScreenshotsV2 const &ScreenshotsRequest, THandler< FAccelByteModelsUGCUpdateScreenshotsV2 > const &OnSuccess, FErrorHandler const &OnError)
	Update screenshots for content.
FAccelByteTaskWPtr	UploadContentScreenshotV2 (FString const &ContentId, FAccelByteModelsUGCUploadScreenshotsRequestV2 const &ScreenshotsRequest, THandler< FAccelByteModelsUGCUpdateContentScreenshotResponse > const &OnSuccess, FErrorHandler const &OnError)
	Upload screenshots for content.
FAccelByteTaskWPtr	DeleteContentScreenshotV2 (FString const &ContentId, FString const &ScreenshotId, FVoidHandler const &OnSuccess, FErrorHandler const &OnError)
	Delete screenshots for content.
FAccelByteTaskWPtr	ModifyContentByShareCode (FString const &ChannelId, FString const &ShareCode, FAccelByteModelsUGCUpdateRequest const &ModifyRequest, THandler< FAccelByteModelsUGCResponse > const &OnSuccess, FErrorHandler const &OnError)
	Modify existing content to update some information by share code.
FAccelByteTaskWPtr	ModifyContentShareCode (FString const &ChannelId, FString const &ContentId, FAccelByteModelsUGCModifyContentShareCodeRequest const &ModifyContentShareCodeRequest, THandler< FAccelByteModelsUGCResponse > const &OnSuccess, FErrorHandler const &OnError)
	Modify the shareCode of a content.
FAccelByteTaskWPtr	DeleteContentByShareCode (FString const &ChannelId, FString const &ShareCode, FVoidHandler const &OnSuccess, FErrorHandler const &OnError)
	Delete a content based on the its channel id and share code.
FAccelByteTaskWPtr	BulkGetContentByShareCodeV2 (TArray< FString > const &ShareCodes, THandler< TArray< FAccelByteModelsUGCContentResponseV2 > > const &OnSuccess, FErrorHandler const &OnError)
	Bulk Get contents by ShareCodes.
FAccelByteTaskWPtr	ModifyContentShareCodeV2 (FString const &ChannelId, FString const &ContentId, FAccelByteModelsUGCModifyContentShareCodeRequest const &ModifyContentShareCodeRequest, THandler< FAccelByteModelsUGCCreateUGCResponseV2 > const &OnSuccess, FErrorHandler const &OnError)
	Modify the shareCode of a content.
FAccelByteTaskWPtr	AddDownloadContentCountV2 (FString const &ContentId, THandler< FAccelByteModelsUGCAddDownloadContentCountResponseV2 > const &OnSuccess, FErrorHandler const &OnError)
	Add download count for a content.
FAccelByteTaskWPtr	GetListContentDownloaderV2 (FString const &ContentId, THandler< FAccelByteModelsUGCGetPaginatedContentDownloaderResponseV2 > const &OnSuccess, FErrorHandler const &OnError, FString const &UserId=TEXT(""), int32 Limit=20, int32 Offset=0, EAccelByteUGCContentUtilitiesSortByV2 SortBy=EAccelByteUGCContentUtilitiesSortByV2::CREATED_TIME_DESC)
	Get list of UGC content downloader.
FAccelByteTaskWPtr	GetListContentLikerV2 (FString const &ContentId, THandler< FAccelByteModelsUGCGetPaginatedContentLikerResponseV2 > const &OnSuccess, FErrorHandler const &OnError, int32 Limit=20, int32 Offset=0, EAccelByteUGCContentUtilitiesSortByV2 SortBy=EAccelByteUGCContentUtilitiesSortByV2::CREATED_TIME_DESC)
	Get a list of users who like the content.
FAccelByteTaskWPtr	UpdateLikeStatusToContentV2 (FString const &ContentId, bool bLikeStatus, THandler< FAccelByteModelsUGCUpdateLikeStatusToContentResponse > const &OnSuccess, FErrorHandler const &OnError)
	Update like/unlike status to a content.
FAccelByteTaskWPtr	GetStagingContents (EStagingContentRequestStatus Status, THandler< FAccelByteModelsUGCPaginatedListStagingContentResponse > const &OnSuccess, FErrorHandler const &OnError, int32 Limit=20, int32 Offset=0, EAccelByteStagingContentUtilitiesSortBy SortBy=EAccelByteStagingContentUtilitiesSortBy::NONE)
	Get a list of staging contents and sort by status.
FAccelByteTaskWPtr	GetStagingContentById (FString const &ContentId, THandler< FAccelByteModelsUGCStagingContentResponse > const &OnSuccess, FErrorHandler const &OnError)
	Get user staging content.
FAccelByteTaskWPtr	UpdateStagingContent (FString const &ContentId, FAccelByteModelsUGCUpdateContentFileLocationRequestV2 UpdateRequest, THandler< FAccelByteModelsUGCStagingContentResponse > const &OnSuccess, FErrorHandler const &OnError)
	Update staging content by content id using update request struct.
FAccelByteTaskWPtr	DeleteStagingContent (FString const &ContentId, FVoidHandler const &OnSuccess, FErrorHandler const &OnError)
	Delete staging content by user id and content id.
Public Member Functions inherited from AccelByte::FApiBase
	FApiBase (Credentials const &InCredentialsRef, Settings const &InSettingsRef, FHttpRetrySchedulerBase &InHttpRef, TSharedPtr< AccelByte::FApiClient, ESPMode::ThreadSafe > const &InApiClient)
	FApiBase (Credentials const &InCredentialsRef, Settings const &InSettingsRef, FHttpRetrySchedulerBase &InHttpRef, FAccelBytePlatformPtr const &InAccelBytePlatform)
void	SetApiClient (TSharedPtr< AccelByte::FApiClient, ESPMode::ThreadSafe > const &InApiClient)

Additional Inherited Members
Protected Member Functions inherited from AccelByte::FApiBase
template<typename T>
bool	ValidateAccelByteId (FString const &Id, EAccelByteIdHypensRule HypenRule, FString const &ErrorMessage, T const &OnError)
Protected Attributes inherited from AccelByte::FApiBase
TSharedRef< Credentials const, ESPMode::ThreadSafe >	CredentialsRef
Settings const &	SettingsRef
FHttpRetrySchedulerBase &	HttpRef
FHttpClient	HttpClient
FAccelBytePlatformPtr	AccelBytePlatformPtr

Detailed Description

Provide APIs to access UGC service.

Member Function Documentation

◆ AddDownloadContentCountV2()

FAccelByteTaskWPtr AccelByte::Api::UGC::AddDownloadContentCountV2	(	FString const &	ContentId,
		THandler< FAccelByteModelsUGCAddDownloadContentCountResponseV2 > const &	OnSuccess,
		FErrorHandler const &	OnError )

Add download count for a content.

Parameters

ContentId	The id of the content.
OnSuccess	This will be called when the operation succeeded. The result is FAccelByteModelsUGCAddDownloadContentCountResponseV2.
OnError	This will be called when the operation failed.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ BulkGetContentByShareCode()

FAccelByteTaskWPtr AccelByte::Api::UGC::BulkGetContentByShareCode	(	TArray< FString > const &	ShareCodes,
		THandler< TArray< FAccelByteModelsUGCContentResponse > > const &	OnSuccess,
		FErrorHandler const &	OnError )

Bulk Get contents by ShareCodes.

Parameters

ShareCodes	Content ShareCodes Array
OnSuccess	This will be called when the operation succeeded.
OnError	This will be called when the operation failed.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ BulkGetContentByShareCodeV2()

FAccelByteTaskWPtr AccelByte::Api::UGC::BulkGetContentByShareCodeV2	(	TArray< FString > const &	ShareCodes,
		THandler< TArray< FAccelByteModelsUGCContentResponseV2 > > const &	OnSuccess,
		FErrorHandler const &	OnError )

Bulk Get contents by ShareCodes.

Parameters

ShareCodes	Content ShareCodes Array
OnSuccess	This will be called when the operation succeeded.
OnError	This will be called when the operation failed.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ CreateChannel()

FAccelByteTaskWPtr AccelByte::Api::UGC::CreateChannel	(	FString const &	ChannelName,
		THandler< FAccelByteModelsUGCChannelResponse > const &	OnSuccess,
		FErrorHandler const &	OnError )

Create a player's channel with specific channel name.

Parameters

ChannelName	The name of the channel.
OnSuccess	This will be called when the operation succeeded. The result is FAccelByteModelsUGCChannelResponse.
OnError	This will be called when the operation failed.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ CreateContent() [1/2]

FAccelByteTaskWPtr AccelByte::Api::UGC::CreateContent	(	FString const &	ChannelId,
		FAccelByteModelsUGCRequest const &	UGCRequest,
		THandler< FAccelByteModelsUGCResponse > const &	OnSuccess,
		FErrorHandler const &	OnError )

Create a content with FString preview and get the payload url to upload the content.

Parameters

ChannelId	The id of the content's channel.
UGCRequest	Detail information for the content request.
OnSuccess	This will be called when the operation succeeded. The result is FAccelByteModelsUGCResponse.
OnError	This will be called when the operation failed.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ CreateContent() [2/2]

FAccelByteTaskWPtr AccelByte::Api::UGC::CreateContent	(	FString const &	ChannelId,
		FString const &	Name,
		FString const &	Type,
		FString const &	SubType,
		TArray< FString > const &	Tags,
		TArray< uint8 > const &	Preview,
		FString const &	FileExtension,
		THandler< FAccelByteModelsUGCResponse > const &	OnSuccess,
		FErrorHandler const &	OnError,
		FString const &	ContentType = TEXT("application/octet-stream") )

Create a content with TArray<uint8> Preview parameter and get the payload url to upload the content.

Parameters

ChannelId	The id of the content's channel.
Name	Name of the content.
Type	Type of the content.
SubType	SubType of the content.
Tags	Tags of the content.
Preview	The TArray<uint8> of the content's Preview
FileExtension	FileExtension of the content.
OnSuccess	This will be called when the operation succeeded. The result is FAccelByteModelsUGCResponse.
OnError	This will be called when the operation failed.
ContentType	The specific type of the content's created, default value is "application/octet-stream".

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ CreateContentV2()

FAccelByteTaskWPtr AccelByte::Api::UGC::CreateContentV2	(	FString const &	ChannelId,
		FAccelByteModelsCreateUGCRequestV2 const &	CreateRequest,
		THandler< FAccelByteModelsUGCCreateUGCResponseV2 > const &	OnSuccess,
		FErrorHandler const &	OnError )

Create a UGC content with create content request.

Parameters

ChannelId	The id of the content's channel.
CreateRequest	Detail information for the content request.
OnSuccess	This will be called when the operation succeeded. The result is FAccelByteModelsUGCCreateUGCResponseV2.
OnError	This will be called when the operation failed.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ DeleteChannel()

FAccelByteTaskWPtr AccelByte::Api::UGC::DeleteChannel	(	FString const &	ChannelId,
		FVoidHandler const &	OnSuccess,
		FErrorHandler const &	OnError )

Delete a player's channel based on the its channel id.

Parameters

ChannelId	The id of the channel that will be deleted.
OnSuccess	This will be called when the operation succeeded.
OnError	This will be called when the operation failed.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ DeleteContent()

FAccelByteTaskWPtr AccelByte::Api::UGC::DeleteContent	(	FString const &	ChannelId,
		FString const &	ContentId,
		FVoidHandler const &	OnSuccess,
		FErrorHandler const &	OnError )

Delete a content based on the its channel id and content id.

Parameters

ChannelId	The id of the content's channel.
ContentId	The id of the content that will be deleted.
OnSuccess	This will be called when the operation succeeded.
OnError	This will be called when the operation failed.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ DeleteContentByShareCode()

FAccelByteTaskWPtr AccelByte::Api::UGC::DeleteContentByShareCode	(	FString const &	ChannelId,
		FString const &	ShareCode,
		FVoidHandler const &	OnSuccess,
		FErrorHandler const &	OnError )

Delete a content based on the its channel id and share code.

Parameters

ChannelId	The id of the content's channel.
ShareCode	The share code of the content that will be fetched.
OnSuccess	This will be called when the operation succeeded.
OnError	This will be called when the operation failed.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ DeleteContentScreenshotV2()

FAccelByteTaskWPtr AccelByte::Api::UGC::DeleteContentScreenshotV2	(	FString const &	ContentId,
		FString const &	ScreenshotId,
		FVoidHandler const &	OnSuccess,
		FErrorHandler const &	OnError )

Delete screenshots for content.

Parameters

ContentId	Content Id.
ScreenshotId	Screenshot Id
OnSuccess	This will be called when the operation succeeded.
OnError	This will be called when the operation failed.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ DeleteContentV2()

FAccelByteTaskWPtr AccelByte::Api::UGC::DeleteContentV2	(	FString const &	ChannelId,
		FString const &	ContentId,
		FVoidHandler const &	OnSuccess,
		FErrorHandler const &	OnError )

Delete a content based on the its channel id and content id.

Parameters

ChannelId	The id of the content's channel.
ContentId	The id of the content that will be deleted.
OnSuccess	This will be called when the operation succeeded.
OnError	This will be called when the operation failed.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ DeleteStagingContent()

FAccelByteTaskWPtr AccelByte::Api::UGC::DeleteStagingContent	(	FString const &	ContentId,
		FVoidHandler const &	OnSuccess,
		FErrorHandler const &	OnError )

Delete staging content by user id and content id.

Parameters

ContentId	Target content id to update the content
OnSuccess	This will be called when the operation succeeded.
OnError	This will be called when the operation failed.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ GenerateUploadContentURLV2()

FAccelByteTaskWPtr AccelByte::Api::UGC::GenerateUploadContentURLV2	(	FString const &	ChannelId,
		FString const &	ContentId,
		FAccelByteModelsUploadContentURLRequestV2 const &	UploadRequest,
		THandler< FAccelByteModelsUGCUploadContentURLResponseV2 > const &	OnSuccess,
		FErrorHandler const &	OnError )

Generate Upload URL and Conten File Location.

Parameters

ChannelId	The id of the content's channel.
ContentId	The id of the content.
UploadRequest	Detail information for the upload request.
OnSuccess	This will be called when the operation succeeded. The result is FAccelByteModelsUGCUploadContentURLResponseV2.
OnError	This will be called when the operation failed.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ GetChannels() [1/2]

FAccelByteTaskWPtr AccelByte::Api::UGC::GetChannels	(	FString const &	UserId,
		THandler< FAccelByteModelsUGCChannelsPagingResponse > const &	OnSuccess,
		FErrorHandler const &	OnError,
		int32	Limit = 1000,
		int32	Offset = 0,
		FString const &	ChannelName = "" )

Get all of the player's channels.

Parameters

UserId	User Id
OnSuccess	This will be called when the operation succeeded. The result is FAccelByteModelsUGCChannelsPagingResponse.
OnError	This will be called when the operation failed.
Limit	The limit of the channel results. Default value is 1000.
Offset	The offset of the channel results. Default value is 0.
ChannelName	The name of the channel you want to query.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ GetChannels() [2/2]

FAccelByteTaskWPtr AccelByte::Api::UGC::GetChannels	(	THandler< FAccelByteModelsUGCChannelsPagingResponse > const &	OnSuccess,
		FErrorHandler const &	OnError,
		int32	Limit = 1000,
		int32	Offset = 0,
		FString const &	ChannelName = "" )

Get all of the player's channels.

Parameters

OnSuccess	This will be called when the operation succeeded. The result is FAccelByteModelsUGCChannelsPagingResponse.
OnError	This will be called when the operation failed.
Limit	The limit of the channel results. Default value is 1000.
Offset	The offset of the channel results. Default value is 0.
ChannelName	The name of the channel you want to query.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ GetContentBulk()

FAccelByteTaskWPtr AccelByte::Api::UGC::GetContentBulk	(	TArray< FString > const &	ContentIds,
		THandler< TArray< FAccelByteModelsUGCContentResponse > > const &	OnSuccess,
		FErrorHandler const &	OnError )

Get contents by content Ids.

Parameters

ContentIds	Content Ids Array
OnSuccess	This will be called when the operation succeeded.
OnError	This will be called when the operation failed.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ GetContentBulkByIdsV2()

FAccelByteTaskWPtr AccelByte::Api::UGC::GetContentBulkByIdsV2	(	TArray< FString > const &	ContentIds,
		THandler< TArray< FAccelByteModelsUGCContentResponseV2 > > const &	OnSuccess,
		FErrorHandler const &	OnError )

Get contents by content Ids.

Parameters

ContentIds	Content Ids Array
OnSuccess	This will be called when the operation succeeded. The result is TArray<FAccelByteModelsUGCContentResponseV2>.
OnError	This will be called when the operation failed.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ GetContentByContentId()

FAccelByteTaskWPtr AccelByte::Api::UGC::GetContentByContentId	(	FString const &	ContentId,
		THandler< FAccelByteModelsUGCContentResponse > const &	OnSuccess,
		FErrorHandler const &	OnError )

Get a content information by its content id.

Parameters

ContentId	The id of the content that will be fetched.
OnSuccess	This will be called when the operation succeeded. The result is FAccelByteModelsUGCContentResponse.
OnError	This will be called when the operation failed.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ GetContentByContentIdV2()

FAccelByteTaskWPtr AccelByte::Api::UGC::GetContentByContentIdV2	(	FString const &	ContentId,
		THandler< FAccelByteModelsUGCContentResponseV2 > const &	OnSuccess,
		FErrorHandler const &	OnError )

Get a content information by its content id.

Parameters

ContentId	The id of the content that will be fetched.
OnSuccess	This will be called when the operation succeeded. The result is FAccelByteModelsUGCContentResponseV2.
OnError	This will be called when the operation failed.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ GetContentByShareCode()

FAccelByteTaskWPtr AccelByte::Api::UGC::GetContentByShareCode	(	FString const &	ShareCode,
		THandler< FAccelByteModelsUGCContentResponse > const &	OnSuccess,
		FErrorHandler const &	OnError )

Get a content information by its share code.

Parameters

ShareCode	The share code of the content that will be fetched.
OnSuccess	This will be called when the operation succeeded. The result is FAccelByteModelsUGCContentResponse.
OnError	This will be called when the operation failed.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ GetContentByShareCodeV2()

FAccelByteTaskWPtr AccelByte::Api::UGC::GetContentByShareCodeV2	(	FString const &	ShareCode,
		THandler< FAccelByteModelsUGCContentResponseV2 > const &	OnSuccess,
		FErrorHandler const &	OnError )

Get a content information by its share code.

Parameters

ShareCode	The share code of the content that will be fetched.
OnSuccess	This will be called when the operation succeeded. The result is FAccelByteModelsUGCContentResponseV2.
OnError	This will be called when the operation failed.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ GetContentPreview() [1/2]

FAccelByteTaskWPtr AccelByte::Api::UGC::GetContentPreview	(	FString const &	ContentId,
		THandler< FAccelByteModelsUGCPreview > const &	OnSuccess,
		FErrorHandler const &	OnError )

Get content Preview as FAccelByteModelsUGCPreview.

Parameters

ContentId	The id of the Preview's content that will be fetched.
OnSuccess	This will be called when the operation succeeded. The result is FAccelByteModelsUGCPreview.
OnError	This will be called when the operation failed.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ GetContentPreview() [2/2]

FAccelByteTaskWPtr AccelByte::Api::UGC::GetContentPreview	(	FString const &	ContentId,
		THandler< TArray< uint8 > > const &	OnSuccess,
		FErrorHandler const &	OnError )

Get content preview as TArray<uint8>.

Parameters

ContentId	The id of the Preview's content that will be fetched.
OnSuccess	This will be called when the operation succeeded. The result is TArray<uint8>.
OnError	This will be called when the operation failed.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ GetCreator()

FAccelByteTaskWPtr AccelByte::Api::UGC::GetCreator	(	FString const &	UserId,
		THandler< FAccelByteModelsUGCGetListFollowersResponse > const &	OnSuccess,
		FErrorHandler const &	OnError )

Get creator stats: number of total like by other user, number of total following and follower user.

Parameters

UserId	User Id
OnSuccess	This will be called when the operation succeeded.
OnError	This will be called when the operation failed.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ GetFollowedContent()

FAccelByteTaskWPtr AccelByte::Api::UGC::GetFollowedContent	(	THandler< FAccelByteModelsUGCContentPageResponse > const &	OnSuccess,
		FErrorHandler const &	OnError,
		int32	Limit = 1000,
		int32	Offset = 0 )

Get contents from followed creators.

Parameters

OnSuccess	This will be called when the operation succeeded.
OnError	This will be called when the operation failed.
Limit	Number of content per page. Default value : 1000
Offset	The offset number to retrieve. Default value : 0

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ GetFollowedUsers()

FAccelByteTaskWPtr AccelByte::Api::UGC::GetFollowedUsers	(	THandler< FAccelByteModelsUGCFollowedUsersResponse > const &	OnSuccess,
		FErrorHandler const &	OnError,
		int32	Limit = 1000,
		int32	Offset = 0 )

Get followed creators.

Parameters

OnSuccess	This will be called when the operation succeeded.
OnError	This will be called when the operation failed.
Limit	Number of content per page. Default value : 1000
Offset	The offset number to retrieve. Default value : 0

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ GetGroups()

FAccelByteTaskWPtr AccelByte::Api::UGC::GetGroups	(	FString const &	UserId,
		THandler< FAccelByteModelsUGCGetGroupsResponse > const &	OnSuccess,
		FErrorHandler const &	OnError,
		int32	Limit = 1000,
		int32	Offset = 0 )

Get all user groups.

Parameters

UserId	User Id
OnSuccess	This will be called when the operation succeeded.
OnError	This will be called when the operation failed.
Limit	Number of content per page. Default value : 1000
Offset	The offset number to retrieve. Default value : 0

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ GetLikedContent() [1/2]

FAccelByteTaskWPtr AccelByte::Api::UGC::GetLikedContent	(	TArray< FString > const &	Tags,
		FString const &	Name,
		FString const &	Type,
		FString const &	Subtype,
		bool	IsOfficial,
		THandler< FAccelByteModelsUGCContentPageResponse > const &	OnSuccess,
		FErrorHandler const &	OnError,
		int32	Limit = 1000,
		int32	Offset = 0,
		EAccelByteLikedContentSortBy	SortBy = EAccelByteLikedContentSortBy::DATE,
		EAccelByteUgcOrderBy	OrderBy = EAccelByteUgcOrderBy::DESC )

Get liked contents.

Parameters

Tags	Content Tags.
Name	Content Name.
Type	Content Type.
Subtype	Content Subtype.
IsOfficial	Filter only official contents
OnSuccess	This will be called when the operation succeeded.
OnError	This will be called when the operation failed.
Limit	Number of content per page. Default value : 1000
Offset	The offset number to retrieve. Default value : 0
SortBy	Sorting criteria, name,download,like,date. default=date.
OrderBy	Sorting order: asc, desc. default=desc

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ GetLikedContent() [2/2]

FAccelByteTaskWPtr AccelByte::Api::UGC::GetLikedContent	(	TArray< FString > const &	Tags,
		FString const &	Name,
		FString const &	Type,
		FString const &	Subtype,
		bool	IsOfficial,
		THandler< FAccelByteModelsUGCContentPageResponse > const &	OnSuccess,
		FErrorHandler const &	OnError,
		int32	Limit = 1000,
		int32	Offset = 0,
		EAccelByteUgcSortBy	SortBy = EAccelByteUgcSortBy::DATE,
		EAccelByteUgcOrderBy	OrderBy = EAccelByteUgcOrderBy::DESC )

Get liked contents.

Parameters

Tags	Content Tags.
Name	Content Name.
Type	Content Type.
Subtype	Content Subtype.
IsOfficial	Filter only official contents
OnSuccess	This will be called when the operation succeeded.
OnError	This will be called when the operation failed.
Limit	Number of content per page. Default value : 1000
Offset	The offset number to retrieve. Default value : 0
SortBy	Sorting criteria, name,download,like,date. default=date.
OrderBy	Sorting order: asc, desc. default=desc

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ GetListContentDownloaderV2()

FAccelByteTaskWPtr AccelByte::Api::UGC::GetListContentDownloaderV2	(	FString const &	ContentId,
		THandler< FAccelByteModelsUGCGetPaginatedContentDownloaderResponseV2 > const &	OnSuccess,
		FErrorHandler const &	OnError,
		FString const &	UserId = TEXT(""),
		int32	Limit = 20,
		int32	Offset = 0,
		EAccelByteUGCContentUtilitiesSortByV2	SortBy = EAccelByteUGCContentUtilitiesSortByV2::CREATED_TIME_DESC )

Get list of UGC content downloader.

Parameters

ContentId	The id of the content.
OnSuccess	This will be called when the operation succeeded. The result is FAccelByteModelsUGCGetPaginatedContentDownloaderResponseV2.
OnError	This will be called when the operation failed.
UserId	The id of the user who downloaded the content.
Limit	Number of content per page. Default value : 1000
Offset	The offset number to retrieve. Default value : 0
SortBy	Sorting criteria: created time with asc or desc. default = created time and desc.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ GetListContentLikerV2()

FAccelByteTaskWPtr AccelByte::Api::UGC::GetListContentLikerV2	(	FString const &	ContentId,
		THandler< FAccelByteModelsUGCGetPaginatedContentLikerResponseV2 > const &	OnSuccess,
		FErrorHandler const &	OnError,
		int32	Limit = 20,
		int32	Offset = 0,
		EAccelByteUGCContentUtilitiesSortByV2	SortBy = EAccelByteUGCContentUtilitiesSortByV2::CREATED_TIME_DESC )

Get a list of users who like the content.

Parameters

ContentId	The id of the content.
OnSuccess	This will be called when the operation succeeded. The result is FAccelByteModelsUGCGetPaginatedContentLikerResponseV2.
OnError	This will be called when the operation failed.
Limit	Number of content per page. Default value : 1000
Offset	The offset number to retrieve. Default value : 0
SortBy	Sorting criteria: created time with asc or desc. default = created time and desc.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ GetListFollowers()

FAccelByteTaskWPtr AccelByte::Api::UGC::GetListFollowers	(	FString const &	UserId,
		THandler< FAccelByteModelsUGCGetListFollowersPagingResponse > const &	OnSuccess,
		FErrorHandler const &	OnError,
		int32	Limit = 1000,
		int32	Offset = 0 )

Get list of followers.

Parameters

UserId	The id of the user that will be given it's followers.
OnSuccess	This will be called when the operation succeeded.
OnError	This will be called when the operation failed.
Limit	Number of user per page, Default value : 1000.
Offset	The offset number to retrieve, Default value : 0.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ GetStagingContentById()

FAccelByteTaskWPtr AccelByte::Api::UGC::GetStagingContentById	(	FString const &	ContentId,
		THandler< FAccelByteModelsUGCStagingContentResponse > const &	OnSuccess,
		FErrorHandler const &	OnError )

Get user staging content.

Parameters

ContentId	Target content id to retrieved
OnSuccess	This will be called when the operation succeeded. The result is FAccelByteModelsStagingContentResponse.
OnError	This will be called when the operation failed.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ GetStagingContents()

FAccelByteTaskWPtr AccelByte::Api::UGC::GetStagingContents	(	EStagingContentRequestStatus	Status,
		THandler< FAccelByteModelsUGCPaginatedListStagingContentResponse > const &	OnSuccess,
		FErrorHandler const &	OnError,
		int32	Limit = 20,
		int32	Offset = 0,
		EAccelByteStagingContentUtilitiesSortBy	SortBy = EAccelByteStagingContentUtilitiesSortBy::NONE )

Get a list of staging contents and sort by status.

Parameters

Status	Sort the response item by status of the staging list contents
OnSuccess	This will be called when the operation succeeded. The result is FAccelByteModelsPaginatedListStagingContentResponse.
OnError	This will be called when the operation failed.
Limit	Number of content per page. Default value : 20
Offset	The offset number to retrieve. Default value : 0
SortBy	Sorting criteria: created time with asc or desc and updated time with asc or desc. default = none.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ GetTags()

FAccelByteTaskWPtr AccelByte::Api::UGC::GetTags	(	THandler< FAccelByteModelsUGCTagsPagingResponse > const &	OnSuccess,
		FErrorHandler const &	OnError,
		int32	Limit = 1000,
		int32	Offset = 0 )

Get all tags.

Parameters

OnSuccess	This will be called when the operation succeeded. The result is FAccelByteModelsUGCTagsPagingResponse.
OnError	This will be called when the operation failed.
Limit	The limit of the tags results. Default value is 1000.
Offset	The offset of the tags results. Default value is 0.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ GetTypes()

FAccelByteTaskWPtr AccelByte::Api::UGC::GetTypes	(	THandler< FAccelByteModelsUGCTypesPagingResponse > const &	OnSuccess,
		FErrorHandler const &	OnError,
		int32	Limit = 1000,
		int32	Offset = 0 )

Get all types and subtypes.

Parameters

OnSuccess	This will be called when the operation succeeded. The result is FAccelByteModelsUGCTypesPagingResponse.
OnError	This will be called when the operation failed.
Limit	The limit of the types and subtypes results. Default value is 1000.
Offset	The offset of the types and subtypes results. Default value is 0.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ GetUserContent()

FAccelByteTaskWPtr AccelByte::Api::UGC::GetUserContent	(	FString const &	UserId,
		THandler< FAccelByteModelsUGCContentPageResponse > const &	OnSuccess,
		FErrorHandler const &	OnError,
		int32	Limit = 1000,
		int32	Offset = 0 )

Get user's generated contents.

Parameters

UserId	User Id
OnSuccess	This will be called when the operation succeeded.
OnError	This will be called when the operation failed.
Limit	Number of content per page. Default value : 1000
Offset	The offset number to retrieve. Default value : 0

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ GetUserContentsV2()

FAccelByteTaskWPtr AccelByte::Api::UGC::GetUserContentsV2	(	FString const &	UserId,
		THandler< FAccelByteModelsUGCSearchContentsPagingResponseV2 > const &	OnSuccess,
		FErrorHandler const &	OnError,
		int32	Limit = 20,
		int32	Offset = 0,
		EAccelByteUGCContentUtilitiesSortByV2	SortBy = EAccelByteUGCContentUtilitiesSortByV2::CREATED_TIME_DESC )

Get user's generated contents.

Parameters

UserId	User Id
OnSuccess	This will be called when the operation succeeded. The result is FAccelByteModelsUGCSearchContentsPagingResponseV2.
OnError	This will be called when the operation failed.
Limit	Number of content per page. Default value : 20
Offset	The offset number to retrieve. Default value : 0

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ ModifyContent() [1/3]

FAccelByteTaskWPtr AccelByte::Api::UGC::ModifyContent	(	FString const &	ChannelId,
		FString const &	ContentId,
		FAccelByteModelsUGCRequest const &	UGCRequest,
		THandler< FAccelByteModelsUGCResponse > const &	OnSuccess,
		FErrorHandler const &	OnError,
		bool	bUpdateContent = false )

Modify existing content to update some information with FString preview.

Parameters

ChannelId	The id of the content's channel.
ContentId	The id of the content that will be modified.
UGCRequest	Detail information for the content request that will be modified.
OnSuccess	This will be called when the operation succeeded. The result is FAccelByteModelsUGCResponse.
OnError	This will be called when the operation failed.
bUpdateContent	This will be used to update the content too or only content information . Default value is false.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ ModifyContent() [2/3]

FAccelByteTaskWPtr AccelByte::Api::UGC::ModifyContent	(	FString const &	ChannelId,
		FString const &	ContentId,
		FAccelByteModelsUGCUpdateRequest const &	ModifyRequest,
		THandler< FAccelByteModelsUGCResponse > const &	OnSuccess,
		FErrorHandler const &	OnError )

Modify existing content to update some information with FString preview.

Parameters

ChannelId	The id of the content's channel.
ContentId	The id of the content that will be modified.
ModifyRequest	Detail information for the content request that will be modified.
OnSuccess	This will be called when the operation succeeded. The result is FAccelByteModelsUGCResponse.
OnError	This will be called when the operation failed.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ ModifyContent() [3/3]

FAccelByteTaskWPtr AccelByte::Api::UGC::ModifyContent	(	FString const &	ChannelId,
		FString const &	ContentId,
		FString const &	Name,
		FString const &	Type,
		FString const &	SubType,
		TArray< FString > const &	Tags,
		TArray< uint8 > const &	Preview,
		FString const &	FileExtension,
		THandler< FAccelByteModelsUGCResponse > const &	OnSuccess,
		FErrorHandler const &	OnError,
		FString const &	ContentType = TEXT("application/octet-stream"),
		bool	bUpdateContent = false )

Modify existing content to update some information with TArray<uint8> Preview parameter.

Parameters

ChannelId	The id of the content's channel.
ContentId	The id of the content that will be modified.
Name	Name of the content.
Type	Type of the content.
SubType	SubType of the content.
Tags	Tags of the content.
Preview	The TArray<uint8> of the content's Preview
FileExtension	FileExtension of the content.
OnSuccess	This will be called when the operation succeeded. The result is FAccelByteModelsUGCResponse.
OnError	This will be called when the operation failed.
ContentType	The specific type of the content's modified. Default value is "application/octet-stream".
bUpdateContent	This will be used to update the content too or only content information . Default value is false.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ ModifyContentByShareCode()

FAccelByteTaskWPtr AccelByte::Api::UGC::ModifyContentByShareCode	(	FString const &	ChannelId,
		FString const &	ShareCode,
		FAccelByteModelsUGCUpdateRequest const &	ModifyRequest,
		THandler< FAccelByteModelsUGCResponse > const &	OnSuccess,
		FErrorHandler const &	OnError )

Modify existing content to update some information by share code.

Parameters

ChannelId	The id of the content's channel.
ShareCode	The share code of the content that will be fetched.
ModifyRequest	Detail information for the content request that will be modified.
OnSuccess	This will be called when the operation succeeded. The result is FAccelByteModelsUGCResponse.
OnError	This will be called when the operation failed.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ ModifyContentShareCode()

FAccelByteTaskWPtr AccelByte::Api::UGC::ModifyContentShareCode	(	FString const &	ChannelId,
		FString const &	ContentId,
		FAccelByteModelsUGCModifyContentShareCodeRequest const &	ModifyContentShareCodeRequest,
		THandler< FAccelByteModelsUGCResponse > const &	OnSuccess,
		FErrorHandler const &	OnError )

Modify the shareCode of a content.

Parameters

ChannelId	The id of the content's channel.
ContentId	Content Id.
ModifyContentShareCodeRequest	Detail information for the content request that will be modified.
OnSuccess	This will be called when the operation succeeded. The result is FAccelByteModelsUGCResponse.
OnError	This will be called when the operation failed.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ ModifyContentShareCodeV2()

FAccelByteTaskWPtr AccelByte::Api::UGC::ModifyContentShareCodeV2	(	FString const &	ChannelId,
		FString const &	ContentId,
		FAccelByteModelsUGCModifyContentShareCodeRequest const &	ModifyContentShareCodeRequest,
		THandler< FAccelByteModelsUGCCreateUGCResponseV2 > const &	OnSuccess,
		FErrorHandler const &	OnError )

Modify the shareCode of a content.

Parameters

ChannelId	The id of the content's channel.
ContentId	Content Id.
ModifyContentShareCodeRequest	Detail information for the content request that will be modified.
OnSuccess	This will be called when the operation succeeded. The result is FAccelByteModelsUGCCreateUGCResponseV2.
OnError	This will be called when the operation failed.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ ModifyContentV2()

FAccelByteTaskWPtr AccelByte::Api::UGC::ModifyContentV2	(	FString const &	ChannelId,
		FString const &	ContentId,
		FAccelByteModelsModifyUGCRequestV2 const &	ModifyRequest,
		THandler< FAccelByteModelsUGCModifyUGCResponseV2 > const &	OnSuccess,
		FErrorHandler const &	OnError )

Modify existing content to update content metadata.

Parameters

ChannelId	The id of the content's channel.
ContentId	The id of the content.
ModifyRequest	Detail information for the content request that will be modified.
OnSuccess	This will be called when the operation succeeded. The result is FAccelByteModelsUGCModifyUGCResponseV2.
OnError	This will be called when the operation failed.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ PublicGetContentBulk()

FAccelByteTaskWPtr AccelByte::Api::UGC::PublicGetContentBulk	(	TArray< FString > const &	ContentIds,
		THandler< TArray< FAccelByteModelsUGCContentResponse > > const &	OnSuccess,
		FErrorHandler const &	OnError )

Get contents by content Ids. Can be used without logged in.

Parameters

ContentIds	Content Ids Array
OnSuccess	This will be called when the operation succeeded.
OnError	This will be called when the operation failed.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ PublicGetContentBulkByIdsV2()

FAccelByteTaskWPtr AccelByte::Api::UGC::PublicGetContentBulkByIdsV2	(	TArray< FString > const &	ContentIds,
		THandler< TArray< FAccelByteModelsUGCContentResponseV2 > > const &	OnSuccess,
		FErrorHandler const &	OnError )

Get contents by content Ids. Can be used without logged in.

Parameters

ContentIds	Content Ids Array
OnSuccess	This will be called when the operation succeeded. The result is TArray<FAccelByteModelsUGCContentResponseV2>.
OnError	This will be called when the operation failed.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ PublicGetContentByContentId()

FAccelByteTaskWPtr AccelByte::Api::UGC::PublicGetContentByContentId	(	FString const &	ContentId,
		THandler< FAccelByteModelsUGCContentResponse > const &	OnSuccess,
		FErrorHandler const &	OnError )

Get a content information by its content id. Can be used without logged in.

Parameters

ContentId	The id of the content that will be fetched.
OnSuccess	This will be called when the operation succeeded. The result is FAccelByteModelsUGCContentResponse.
OnError	This will be called when the operation failed.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ PublicGetContentByContentIdV2()

FAccelByteTaskWPtr AccelByte::Api::UGC::PublicGetContentByContentIdV2	(	FString const &	ContentId,
		THandler< FAccelByteModelsUGCContentResponseV2 > const &	OnSuccess,
		FErrorHandler const &	OnError )

Get a content information by its content id. Can be used without logged in.

Parameters

ContentId	The id of the content that will be fetched.
OnSuccess	This will be called when the operation succeeded. The result is FAccelByteModelsUGCContentResponseV2.
OnError	This will be called when the operation failed.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ PublicGetContentByShareCode()

FAccelByteTaskWPtr AccelByte::Api::UGC::PublicGetContentByShareCode	(	FString const &	ShareCode,
		THandler< FAccelByteModelsUGCContentResponse > const &	OnSuccess,
		FErrorHandler const &	OnError )

Get a content information by its share code. Can be used without logged in.

Parameters

ShareCode	The share code of the content that will be fetched.
OnSuccess	This will be called when the operation succeeded. The result is FAccelByteModelsUGCContentResponse.
OnError	This will be called when the operation failed.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ PublicGetContentByShareCodeV2()

FAccelByteTaskWPtr AccelByte::Api::UGC::PublicGetContentByShareCodeV2	(	FString const &	ShareCode,
		THandler< FAccelByteModelsUGCContentResponseV2 > const &	OnSuccess,
		FErrorHandler const &	OnError )

Get a content information by its share code. Can be used without logged in.

Parameters

ShareCode	The share code of the content that will be fetched.
OnSuccess	This will be called when the operation succeeded. The result is FAccelByteModelsUGCContentResponseV2.
OnError	This will be called when the operation failed.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ PublicGetUserContent()

FAccelByteTaskWPtr AccelByte::Api::UGC::PublicGetUserContent	(	FString const &	UserId,
		THandler< FAccelByteModelsUGCContentPageResponse > const &	OnSuccess,
		FErrorHandler const &	OnError,
		int32	Limit = 1000,
		int32	Offset = 0 )

Get user's generated contents. Can be used without logged in.

Parameters

UserId	User Id
OnSuccess	This will be called when the operation succeeded.
OnError	This will be called when the operation failed.
Limit	Number of content per page. Default value : 1000
Offset	The offset number to retrieve. Default value : 0

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ PublicGetUserContentsV2()

FAccelByteTaskWPtr AccelByte::Api::UGC::PublicGetUserContentsV2	(	FString const &	UserId,
		THandler< FAccelByteModelsUGCSearchContentsPagingResponseV2 > const &	OnSuccess,
		FErrorHandler const &	OnError,
		int32	Limit = 20,
		int32	Offset = 0,
		EAccelByteUGCContentUtilitiesSortByV2	SortBy = EAccelByteUGCContentUtilitiesSortByV2::CREATED_TIME_DESC )

Get user's generated contents. Can be used without logged in.

Parameters

UserId	User Id
OnSuccess	This will be called when the operation succeeded. The result is FAccelByteModelsUGCSearchContentsPagingResponseV2.
OnError	This will be called when the operation failed.
Limit	Number of content per page. Default value : 20
Offset	The offset number to retrieve. Default value : 0

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ PublicSearchContents() [1/2]

FAccelByteTaskWPtr AccelByte::Api::UGC::PublicSearchContents	(	FAccelByteModelsUGCSearchContentsRequest const &	Request,
		THandler< FAccelByteModelsUGCSearchContentsPagingResponse > const &	OnSuccess,
		FErrorHandler const &	OnError,
		int32	Limit = 20,
		int32	Offset = 0 )

Search specific contents based on the given filter. Can be used without logged in.

Parameters

Request	Filter request to specify the search result.
OnSuccess	This will be called when the operation succeeded.
OnError	This will be called when the operation failed.
Limit	Number of content per page. Default value : 20
Offset	The offset number to retrieve. Default value : 0

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ PublicSearchContents() [2/2]

FAccelByteTaskWPtr AccelByte::Api::UGC::PublicSearchContents	(	FString const &	Name,
		FString const &	Creator,
		FString const &	Type,
		FString const &	Subtype,
		TArray< FString > const &	Tags,
		bool	IsOfficial,
		FString const &	UserId,
		THandler< FAccelByteModelsUGCSearchContentsPagingResponse > const &	OnSuccess,
		FErrorHandler const &	OnError,
		EAccelByteUgcSortBy	SortBy = EAccelByteUgcSortBy::DATE,
		EAccelByteUgcOrderBy	OrderBy = EAccelByteUgcOrderBy::DESC,
		int32	Limit = 1000,
		int32	Offset = 0 )

Search specific contents based on the given filter. Can be used without logged in.

Parameters

Name	Content Name.
Creator	Creator Name.
Type	Content Type.
Subtype	Content Subtype.
Tags	Content Tags.
IsOfficial	Filter only official contents
UserId	User Id
OnSuccess	This will be called when the operation succeeded.
OnError	This will be called when the operation failed.
SortBy	Sorting criteria, name,download,like,date. default=date.
OrderBy	Sorting order: asc, desc. default=desc
Limit	Number of content per page. Default value : 1000
Offset	The offset number to retrieve. Default value : 0

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ PublicSearchContentsSpecificToChannelV2()

FAccelByteTaskWPtr AccelByte::Api::UGC::PublicSearchContentsSpecificToChannelV2	(	FString const &	ChannelId,
		THandler< FAccelByteModelsUGCSearchContentsPagingResponseV2 > const &	OnSuccess,
		FErrorHandler const &	OnError,
		int32	Limit = 20,
		int32	Offset = 0,
		EAccelByteUGCContentUtilitiesSortByV2	SortBy = EAccelByteUGCContentUtilitiesSortByV2::CREATED_TIME_DESC )

Search contents specific to a channel. Can be used without logged in.

Parameters

ChannelId	Channel Id.
OnSuccess	This will be called when the operation succeeded. The result is FAccelByteModelsUGCSearchContentsPagingResponseV2.
OnError	This will be called when the operation failed.
Limit	Number of content per page. Default value : 20
Offset	The offset number to retrieve. Default value : 0
SortBy	Sorting criteria: created time with asc or desc. default = created time and desc.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ PublicSearchContentsV2()

FAccelByteTaskWPtr AccelByte::Api::UGC::PublicSearchContentsV2	(	FAccelByteModelsUGCFilterRequestV2 const &	Filter,
		THandler< FAccelByteModelsUGCSearchContentsPagingResponseV2 > const &	OnSuccess,
		FErrorHandler const &	OnError,
		int32	Limit = 20,
		int32	Offset = 0,
		EAccelByteUGCContentSortByV2	SortBy = EAccelByteUGCContentSortByV2::CREATED_TIME_DESC )

Get all contents in current namespace. Can be used without logged in.

Parameters

Filter	To filter the returned UGC contets.
OnSuccess	This will be called when the operation succeeded. The result is FAccelByteModelsUGCSearchContentsPagingResponseV2.
OnError	This will be called when the operation failed.
Limit	Number of content per page. Default value : 20
Offset	The offset number to retrieve. Default value : 0
SortBy	Sorting criteria: name, download, like, created time with asc or desc. default = created time and desc.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ SearchContents() [1/2]

FAccelByteTaskWPtr AccelByte::Api::UGC::SearchContents	(	FAccelByteModelsUGCSearchContentsRequest const &	Request,
		THandler< FAccelByteModelsUGCSearchContentsPagingResponse > const &	OnSuccess,
		FErrorHandler const &	OnError,
		int32	Limit = 20,
		int32	Offset = 0 )

Search specific contents based on the given filter.

Parameters

Request	Filter request to specify the search result.
OnSuccess	This will be called when the operation succeeded.
OnError	This will be called when the operation failed.
Limit	Number of content per page. Default value : 20
Offset	The offset number to retrieve. Default value : 0

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ SearchContents() [2/2]

FAccelByteTaskWPtr AccelByte::Api::UGC::SearchContents	(	FString const &	Name,
		FString const &	Creator,
		FString const &	Type,
		FString const &	Subtype,
		TArray< FString > const &	Tags,
		bool	IsOfficial,
		FString const &	UserId,
		THandler< FAccelByteModelsUGCSearchContentsPagingResponse > const &	OnSuccess,
		FErrorHandler const &	OnError,
		EAccelByteUgcSortBy	SortBy = EAccelByteUgcSortBy::DATE,
		EAccelByteUgcOrderBy	OrderBy = EAccelByteUgcOrderBy::DESC,
		int32	Limit = 1000,
		int32	Offset = 0 )

Search specific contents based on the given filter.

Parameters

Name	Content Name.
Creator	Creator Name.
Type	Content Type.
Subtype	Content Subtype.
Tags	Content Tags.
IsOfficial	Filter only official contents
UserId	User Id
OnSuccess	This will be called when the operation succeeded.
OnError	This will be called when the operation failed.
SortBy	Sorting criteria, name,download,like,date. default=date.
OrderBy	Sorting order: asc, desc. default=desc
Limit	Number of content per page. Default value : 1000
Offset	The offset number to retrieve. Default value : 0

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ SearchContentsSpecificToChannel() [1/2]

FAccelByteTaskWPtr AccelByte::Api::UGC::SearchContentsSpecificToChannel	(	FString const &	ChannelId,
		FAccelByteModelsUGCSearchContentsRequest const &	Request,
		THandler< FAccelByteModelsUGCSearchContentsPagingResponse > const &	OnSuccess,
		FErrorHandler const &	OnError,
		int32	Limit = 20,
		int32	Offset = 0 )

Search contents specific to a channel.

Parameters

ChannelId	Channel Id.
Request	Filter request to specify the search result.
OnSuccess	This will be called when the operation succeeded.
OnError	This will be called when the operation failed.
Limit	Number of content per page. Default value : 1000
Offset	The offset number to retrieve. Default value : 0

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ SearchContentsSpecificToChannel() [2/2]

FAccelByteTaskWPtr AccelByte::Api::UGC::SearchContentsSpecificToChannel	(	FString const &	ChannelId,
		FString const &	Name,
		FString const &	Creator,
		FString const &	Type,
		FString const &	Subtype,
		TArray< FString > const &	Tags,
		bool	IsOfficial,
		FString const &	UserId,
		THandler< FAccelByteModelsUGCSearchContentsPagingResponse > const &	OnSuccess,
		FErrorHandler const &	OnError,
		EAccelByteUgcSortBy	SortBy = EAccelByteUgcSortBy::DATE,
		EAccelByteUgcOrderBy	OrderBy = EAccelByteUgcOrderBy::DESC,
		int32	Limit = 1000,
		int32	Offset = 0 )

Search contents specific to a channel.

Parameters

ChannelId	Channel Id.
Name	Content Name.
Creator	Creator Name.
Type	Content Type.
Subtype	Content Subtype.
Tags	Content Tags.
IsOfficial	Filter only official contents
UserId	User Id
OnSuccess	This will be called when the operation succeeded.
OnError	This will be called when the operation failed.
SortBy	Sorting criteria, name,download,like,date. default=date.
OrderBy	Sorting order: asc, desc. default=desc
Limit	Number of content per page. Default value : 1000
Offset	The offset number to retrieve. Default value : 0

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ SearchContentsSpecificToChannelV2()

FAccelByteTaskWPtr AccelByte::Api::UGC::SearchContentsSpecificToChannelV2	(	FString const &	ChannelId,
		THandler< FAccelByteModelsUGCSearchContentsPagingResponseV2 > const &	OnSuccess,
		FErrorHandler const &	OnError,
		int32	Limit = 20,
		int32	Offset = 0,
		EAccelByteUGCContentUtilitiesSortByV2	SortBy = EAccelByteUGCContentUtilitiesSortByV2::CREATED_TIME_DESC )

Search contents specific to a channel.

Parameters

ChannelId	Channel Id.
OnSuccess	This will be called when the operation succeeded. The result is FAccelByteModelsUGCSearchContentsPagingResponseV2.
OnError	This will be called when the operation failed.
Limit	Number of content per page. Default value : 20
Offset	The offset number to retrieve. Default value : 0
SortBy	Sorting criteria: created time with asc or desc. default = created time and desc.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ SearchContentsV2()

FAccelByteTaskWPtr AccelByte::Api::UGC::SearchContentsV2	(	FAccelByteModelsUGCFilterRequestV2 const &	Filter,
		THandler< FAccelByteModelsUGCSearchContentsPagingResponseV2 > const &	OnSuccess,
		FErrorHandler const &	OnError,
		int32	Limit = 20,
		int32	Offset = 0,
		EAccelByteUGCContentSortByV2	SortBy = EAccelByteUGCContentSortByV2::CREATED_TIME_DESC )

Get all contents in current namespace.

Parameters

Filter	To filter the returned UGC contets.
OnSuccess	This will be called when the operation succeeded. The result is FAccelByteModelsUGCSearchContentsPagingResponseV2.
OnError	This will be called when the operation failed.
Limit	Number of content per page. Default value : 20
Offset	The offset number to retrieve. Default value : 0
SortBy	Sorting criteria: name, download, like, created time with asc or desc. default = created time and desc.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ UpdateChannel()

FAccelByteTaskWPtr AccelByte::Api::UGC::UpdateChannel	(	FString const &	ChannelId,
		FString const &	ChannelName,
		THandler< FAccelByteModelsUGCChannelResponse > const &	OnSuccess,
		FErrorHandler const &	OnError )

Update a player's channel with specific channel name.

Parameters

ChannelId	The id of the channel that will be updated.
ChannelName	The name of the channel.
OnSuccess	This will be called when the operation succeeded. The result is FAccelByteModelsUGCChannelResponse.
OnError	This will be called when the operation failed.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ UpdateContentFileLocationV2()

FAccelByteTaskWPtr AccelByte::Api::UGC::UpdateContentFileLocationV2	(	FString const &	ChannelId,
		FString const &	ContentId,
		FString const &	FileExtension,
		FString const &	S3Key,
		THandler< FAccelByteModelsUGCUpdateContentFileLocationResponseV2 > const &	OnSuccess,
		FErrorHandler const &	OnError )

Update Content File Location in S3.

Parameters

ChannelId	The id of the content's channel.
ContentId	The id of the content.
FileExtension	FileExtension of the content.
S3Key	Detail information about the file location in S3.
OnSuccess	This will be called when the operation succeeded. The result is FAccelByteModelsUGCUpdateContentFileLocationResponseV2.
OnError	This will be called when the operation failed.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ UpdateContentScreenshotV2()

FAccelByteTaskWPtr AccelByte::Api::UGC::UpdateContentScreenshotV2	(	FString const &	ContentId,
		FAccelByteModelsUGCUpdateScreenshotsV2 const &	ScreenshotsRequest,
		THandler< FAccelByteModelsUGCUpdateScreenshotsV2 > const &	OnSuccess,
		FErrorHandler const &	OnError )

Update screenshots for content.

Parameters

ContentId	Content Id.
ScreenshotsRequest	Screenshots Request Supported file extensions: pjp, jpg, jpeg, jfif, bmp, png. Maximum description length: 1024.
OnSuccess	This will be called when the operation succeeded. The result is FAccelByteModelsUGCUpdateScreenshotsV2.
OnError	This will be called when the operation failed.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ UpdateFollowStatusToUser()

FAccelByteTaskWPtr AccelByte::Api::UGC::UpdateFollowStatusToUser	(	FString const &	UserId,
		bool	bFollowStatus,
		THandler< FAccelByteModelsUGCUpdateFollowStatusToUserResponse > const &	OnSuccess,
		FErrorHandler const &	OnError )

Update follow/unfollow status to a user.

Parameters

UserId	The id of the user that will be updated.
bFollowStatus	The new follow status value.
OnSuccess	This will be called when the operation succeeded.
OnError	This will be called when the operation failed.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ UpdateLikeStatusToContent()

FAccelByteTaskWPtr AccelByte::Api::UGC::UpdateLikeStatusToContent	(	FString const &	ContentId,
		bool	bLikeStatus,
		THandler< FAccelByteModelsUGCUpdateLikeStatusToContentResponse > const &	OnSuccess,
		FErrorHandler const &	OnError )

Update like/unlike status to a content.

Parameters

ContentId	The content id that will be updated.
bLikeStatus	New like Status value.
OnSuccess	This will be called when the operation succeeded.
OnError	This will be called when the operation failed.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ UpdateLikeStatusToContentV2()

FAccelByteTaskWPtr AccelByte::Api::UGC::UpdateLikeStatusToContentV2	(	FString const &	ContentId,
		bool	bLikeStatus,
		THandler< FAccelByteModelsUGCUpdateLikeStatusToContentResponse > const &	OnSuccess,
		FErrorHandler const &	OnError )

Update like/unlike status to a content.

Parameters

ContentId	The content id that will be updated.
bLikeStatus	New like Status value.
OnSuccess	This will be called when the operation succeeded.
OnError	This will be called when the operation failed.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ UpdateStagingContent()

FAccelByteTaskWPtr AccelByte::Api::UGC::UpdateStagingContent	(	FString const &	ContentId,
		FAccelByteModelsUGCUpdateContentFileLocationRequestV2	UpdateRequest,
		THandler< FAccelByteModelsUGCStagingContentResponse > const &	OnSuccess,
		FErrorHandler const &	OnError )

Update staging content by content id using update request struct.

Parameters

ContentId	Target content id to update the content
UpdateRequest	Query or params in struct to request an update
OnSuccess	This will be called when the operation succeeded. The result is FAccelByteModelsStagingContentResponse.
OnError	This will be called when the operation failed.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ UploadContentScreenshot()

FAccelByteTaskWPtr AccelByte::Api::UGC::UploadContentScreenshot	(	FString const &	ContentId,
		FString const &	UserId,
		FAccelByteModelsUGCScreenshotsRequest	ScreenshotsRequest,
		THandler< FAccelByteModelsUGCUpdateContentScreenshotResponse > const &	OnSuccess,
		FErrorHandler const &	OnError )

Upload screenshots for content.

Parameters

ContentId	Content Id.
UserId	User Id
ScreenshotsRequest	Screenshots Request Supported file extensions: pjp, jpg, jpeg, jfif, bmp, png. Maximum description length: 1024.
OnSuccess	This will be called when the operation succeeded.
OnError	This will be called when the operation failed.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ UploadContentScreenshotV2()

FAccelByteTaskWPtr AccelByte::Api::UGC::UploadContentScreenshotV2	(	FString const &	ContentId,
		FAccelByteModelsUGCUploadScreenshotsRequestV2 const &	ScreenshotsRequest,
		THandler< FAccelByteModelsUGCUpdateContentScreenshotResponse > const &	OnSuccess,
		FErrorHandler const &	OnError )

Upload screenshots for content.

Parameters

ContentId	Content Id.
ScreenshotsRequest	Screenshots Request. Supported file extensions: pjp, jpg, jpeg, jfif, bmp, png. Maximum description length: 1024.
OnSuccess	This will be called when the operation succeeded. The result is FAccelByteModelsUGCUpdateContentScreenshotResponse.
OnError	This will be called when the operation failed.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ AddDownloadContentCountV2()

◆ BulkGetContentByShareCode()

◆ BulkGetContentByShareCodeV2()

◆ CreateChannel()

◆ CreateContent() [1/2]

◆ CreateContent() [2/2]

◆ CreateContentV2()

◆ DeleteChannel()

◆ DeleteContent()

◆ DeleteContentByShareCode()

◆ DeleteContentScreenshotV2()

◆ DeleteContentV2()

◆ DeleteStagingContent()

◆ GenerateUploadContentURLV2()

◆ GetChannels() [1/2]

◆ GetChannels() [2/2]

◆ GetContentBulk()

◆ GetContentBulkByIdsV2()

◆ GetContentByContentId()

◆ GetContentByContentIdV2()

◆ GetContentByShareCode()

◆ GetContentByShareCodeV2()

◆ GetContentPreview() [1/2]

◆ GetContentPreview() [2/2]

◆ GetCreator()

◆ GetFollowedContent()

◆ GetFollowedUsers()

◆ GetGroups()

◆ GetLikedContent() [1/2]

◆ GetLikedContent() [2/2]

◆ GetListContentDownloaderV2()

◆ GetListContentLikerV2()

◆ GetListFollowers()

◆ GetStagingContentById()

◆ GetStagingContents()

◆ GetTags()

◆ GetTypes()

◆ GetUserContent()

◆ GetUserContentsV2()

◆ ModifyContent() [1/3]

◆ ModifyContent() [2/3]

◆ ModifyContent() [3/3]

◆ ModifyContentByShareCode()

◆ ModifyContentShareCode()

◆ ModifyContentShareCodeV2()

◆ ModifyContentV2()

◆ PublicGetContentBulk()

◆ PublicGetContentBulkByIdsV2()

◆ PublicGetContentByContentId()

◆ PublicGetContentByContentIdV2()

◆ PublicGetContentByShareCode()

◆ PublicGetContentByShareCodeV2()

◆ PublicGetUserContent()

◆ PublicGetUserContentsV2()

◆ PublicSearchContents() [1/2]

◆ PublicSearchContents() [2/2]

◆ PublicSearchContentsSpecificToChannelV2()

◆ PublicSearchContentsV2()

◆ SearchContents() [1/2]

◆ SearchContents() [2/2]

◆ SearchContentsSpecificToChannel() [1/2]

◆ SearchContentsSpecificToChannel() [2/2]

◆ SearchContentsSpecificToChannelV2()

◆ SearchContentsV2()

◆ UpdateChannel()

◆ UpdateContentFileLocationV2()

◆ UpdateContentScreenshotV2()

◆ UpdateFollowStatusToUser()

◆ UpdateLikeStatusToContent()

◆ UpdateLikeStatusToContentV2()

◆ UpdateStagingContent()

◆ UploadContentScreenshot()

◆ UploadContentScreenshotV2()