Provide APIs to access User-Generated Content (UGC) service. More...

Inheritance diagram for AccelByte.Api.UGC:

Public Member Functions
void	CreateContent (string channelId, UGCRequest createRequest, ResultCallback< UGCResponse > callback)
	Create a content with string preview and get the payload url to upload the content.
void	CreateContent (string channelId, string name, string type, string subtype, string[] tags, byte[] preview, string fileExtension, ResultCallback< UGCResponse > callback, string contentType="application/octet-stream")
	Create a content with byte array Preview paramater and get the payload url to upload the content.
void	ModifyContent (string channelId, string contentId, UGCUpdateRequest ModifyRequest, ResultCallback< UGCResponse > callback)
	Modify existing content to update some information with string preview.
void	ModifyContent (string channelId, string contentId, UGCRequest ModifyRequest, ResultCallback< UGCResponse > callback, bool updateContent=false)
	Modify existing content to update some information with string preview.
void	ModifyContent (string channelId, string contentId, string name, string type, string subtype, string[] tags, byte[] preview, string fileExtension, ResultCallback< UGCResponse > callback, string contentType="application/octet-stream", bool updateContent=false)
	Modify existing content to update some information with byte array Preview paramater.
void	DeleteContent (string channelId, string contentId, ResultCallback callback)
	Delete a content based on the its channel id and content id.
void	GetContentByContentId (string contentId, ResultCallback< UGCContentResponse > callback)
	Get a content information by its content id.
void	GetContentByShareCode (string shareCode, ResultCallback< UGCContentResponse > callback)
	Get a content information by its share code.
void	GetContentPreview (string contentId, ResultCallback< UGCPreview > callback)
	Get content preview as UGCPreview Model.
void	GetContentPreview (string contentId, ResultCallback< byte[]> callback)
	Get content preview as byte array.
void	GetTags (ResultCallback< UGCTagsPagingResponse > callback, int offset=0, int limit=1000)
	Get all tags.
void	GetTypes (ResultCallback< UGCTypesPagingResponse > callback, int offset=0, int limit=1000)
	Get all of player's types and subtypes.
void	CreateChannel (string channelName, ResultCallback< UGCChannelResponse > callback)
	Create player's channel with specific channel name.
void	GetChannels (string userId, ResultCallback< UGCChannelPagingResponse > callback, int offset=0, int limit=1000, string channelName="")
	Get all of the player's channels.
void	GetChannels (ResultCallback< UGCChannelPagingResponse > callback, int offset=0, int limit=1000, string channelName="")
	Get all of the player's channels.
void	DeleteChannel (string channelId, ResultCallback callback)
	Delete player's channel based on the its channel id.
void	SearchContent (SearchContentRequest searchContentRequest, ResultCallback< UGCSearchContentsPagingResponse > callback)
	Search Content player's channel based on the its channel id.
void	SearchContentsSpesificToChannel (string channelId, SearchContentRequest searchContentRequest, ResultCallback< UGCSearchContentsPagingResponse > callback)
	Search Content player's channel based on the its channel id.
void	UpdateLikeStatusToContent (string contentId, bool likeStatus, ResultCallback< UGCUpdateLikeStatusToContentResponse > callback)
void	GetListFollowers (ResultCallback< UGCGetListFollowersPagingResponse > callback, int limit=1000, int offset=0)
	Get List Followers.
void	UpdateFollowStatus (bool followStatus, ResultCallback< UGCUpdateFollowStatusToUserResponse > callback)
	Update follow/unfollow status to user.
void	UpdateFollowStatus (bool followStatus, string userId, ResultCallback< UGCUpdateFollowStatusToUserResponse > callback)
	Update follow/unfollow status to user.
void	GetBulkContentId (string[] contentIds, ResultCallback< UGCModelsContentsResponse[]> callback)
	Get Bulk ContentId.
void	GetUserContents (string userId, ResultCallback< UGCContentsPagingResponse > callback, int limit=1000, int offset=0)
	Get User Contents.
void	UploadScreenshotContent (string contentId, string userId, ScreenshotsRequest screenshotsRequest, ResultCallback< ScreenshotsResponse > callback)
	Get User Contents.
void	GetContentFollowed (ResultCallback< UGCContentsPagingResponse > callback, int limit=1000, int offset=0)
	Get Content Followed.
void	GetFollowedCreators (ResultCallback< UGCGetListFollowersPagingResponse > callback, int limit=1000, int offset=0)
	Get Followed Creators.
void	GetListFollowing (string userId, ResultCallback< UGCGetListFollowersPagingResponse > callback, int limit=1000, int offset=0)
	Get List Following.
void	GetLikedContents (GetLikedContentRequest getLikedContentRequest, ResultCallback< UGCContentsPagingResponse > callback)
	Get Liked Contents.
void	GetLikedContents (GetAllLikedContentRequest getLikedContentRequest, ResultCallback< UGCContentsPagingResponse > callback)
	Get Liked Contents.
void	GetCreatorStats (string userId, ResultCallback< UGCGetCreatorStatsResponse > callback)
	Get Creator Stats.
void	GetUserGroups (string userId, ResultCallback< UGCGetUserGroupsPagingResponse > callback, int limit=1000, int offset=0)
	Get User Groups.
void	UpdateChannel (string channelId, string name, ResultCallback< UGCChannelResponse > callback)
	Update channel.
void	ModifyContentByShareCode (string channelId, string shareCode, UGCUpdateRequest modifyRequest, ResultCallback< UGCResponse > callback)
	Modify existing content to update some information by share code.
void	DeleteContentByShareCode (string channelId, string shareCode, ResultCallback callback)
	Delete a content based on its channel id and share code.
void	BulkGetContentByShareCode (string[] shareCodes, ResultCallback< UGCModelsContentsResponse[]> callback)
	Get contents by share codes.
void	SearchContentsSpecificToChannelV2 (string channelId, ResultCallback< UGCSearchContentsPagingResponseV2 > callback, int limit=20, int offset=0, UGCContentDownloaderSortBy sortBy=UGCContentDownloaderSortBy.CreatedTimeDesc)
	Search contents specific to a channel.
void	SearchContentsV2 (UGCGetContentFilterRequestV2 filterRequest, ResultCallback< UGCSearchContentsPagingResponseV2 > callback, int limit=20, int offset=0, UGCContentSortBy sortBy=UGCContentSortBy.CreatedTimeDesc)
	Get all contents in current namespace.
void	GetContentBulkByIdsV2 (string[] contentIds, ResultCallback< UGCModelsContentsResponseV2[]> callback)
	Get contents by content Ids.
void	GetContentByShareCodeV2 (string shareCode, ResultCallback< UGCModelsContentsResponseV2 > callback)
	Get a content information by its share code.
void	GetContentByContentIdV2 (string contentId, ResultCallback< UGCModelsContentsResponseV2 > callback)
	Get a content information by its content id.
void	CreateContentV2 (string channelId, CreateUGCRequestV2 createRequest, ResultCallback< UGCModelsCreateUGCResponseV2 > callback)
	Create a UGC content with create content request.
void	DeleteContentV2 (string channelId, string contentId, ResultCallback callback)
	Delete a content based on the its channel id and content id.
void	ModifyContentV2 (string channelId, string contentId, ModifyUGCRequestV2 modifyRequest, ResultCallback< UGCModelsModifyUGCResponseV2 > callback)
	Modify existing content to update some information.
void	GenerateUploadContentURLV2 (string channelId, string contentId, UGCUploadContentURLRequestV2 uploadRequest, ResultCallback< UGCModelsUploadContentURLResponseV2 > callback)
	Generate Upload URL and Conten File Location.
void	UpdateContentFileLocationV2 (string channelId, string contentId, string fileExtension, string s3Key, ResultCallback< UpdateContentFileLocationResponseV2 > callback)
	Update Content File Location in S3.
void	GetUserContentsV2 (string userId, ResultCallback< UGCSearchContentsPagingResponseV2 > callback, int limit=20, int offset=0, UGCContentDownloaderSortBy sortBy=UGCContentDownloaderSortBy.CreatedTimeDesc)
	Get user's generated contents.
void	UpdateContentScreenshotV2 (string contentId, ScreenshotsUpdatesV2 updateSreenshotsRequest, ResultCallback< ScreenshotsUpdatesV2 > callback)
	Update screenshots for content.
void	UploadContentScreenshotV2 (string contentId, ScreenshotsRequest screenshotsRequest, ResultCallback< ScreenshotsResponseV2 > callback)
	Upload screenshots for content.
void	DeleteContentScreenshotV2 (string contentId, string screenshotId, ResultCallback callback)
	Delete screenshots for content.
void	BulkGetContentByShareCodeV2 (string[] shareCodes, ResultCallback< UGCModelsContentsResponseV2[]> callback)
	Get contents by share codes.
void	AddDownloadContentCountV2 (string contentId, ResultCallback< UGCModelsAddDownloadContentCountResponseV2 > callback)
	Add download count for a content.
void	GetListContentDownloaderV2 (string contentId, ResultCallback< UGCModelsPaginatedContentDownloaderResponseV2 > callback, string userId="", int limit=20, int offset=0, UGCContentDownloaderSortBy sortBy=UGCContentDownloaderSortBy.CreatedTimeDesc)
	Get list of UGC content downloader.
void	GetListContentLikerV2 (string contentId, ResultCallback< UGCModelsPaginatedContentLikerResponseV2 > callback, int limit=20, int offset=0, UGCContentDownloaderSortBy sortBy=UGCContentDownloaderSortBy.CreatedTimeDesc)
	Get a list of users who like the content.
void	UpdateLikeStatusToContentV2 (string contentId, bool likeStatus, ResultCallback< UGCUpdateLikeStatusToContentResponse > callback)
void	GetUserStagingContentByContentId (string userId, string contentId, ResultCallback< UGCModelStagingContent > callback)
void	GetListStagingContent (string userId, UGCStagingContentStatus status, int limit, int offset, UGCListStagingContentSortBy sortBy, ResultCallback< UGCModelsPaginatedStagingContentResponse > callback)
void	ModifyStagingContentByContentId (string userId, string contentId, UGCUpdateStagingContentRequest modifyRequest, ResultCallback< UGCModelStagingContent > callback)
	Modify staging content to update some information based on content id.
void	DeleteStagingContentByContentId (string userId, string contentId, ResultCallback callback)

Additional Inherited Members
Properties inherited from AccelByte.Core.WrapperBase
Utils.AccelByteIdValidator	IdValidator `[get]`

Detailed Description

Provide APIs to access User-Generated Content (UGC) service.

Member Function Documentation

◆ AddDownloadContentCountV2()

void AccelByte.Api.UGC.AddDownloadContentCountV2	(	string	contentId,
		ResultCallback< UGCModelsAddDownloadContentCountResponseV2 >	callback )

inline

Add download count for a content.

Parameters

contentId	The contentId.
callback	This will be called when the operation succeeded.

◆ BulkGetContentByShareCode()

void AccelByte.Api.UGC.BulkGetContentByShareCode	(	string[]	shareCodes,
		ResultCallback< UGCModelsContentsResponse[]>	callback )

inline

Get contents by share codes.

Parameters

shareCodes	Content ShareCodes Array
callback	This will be called when the operation succeeded.

◆ BulkGetContentByShareCodeV2()

void AccelByte.Api.UGC.BulkGetContentByShareCodeV2	(	string[]	shareCodes,
		ResultCallback< UGCModelsContentsResponseV2[]>	callback )

inline

Get contents by share codes.

Parameters

shareCodes	Content ShareCodes Array
callback	This will be called when the operation succeeded.

◆ CreateChannel()

void AccelByte.Api.UGC.CreateChannel	(	string	channelName,
		ResultCallback< UGCChannelResponse >	callback )

inline

Create player's channel with specific channel name.

Parameters

channelName	The name of the channel.
callback	This will be called when the operation succeeded. The result is UGCChannelResponse Model.

◆ CreateContent() [1/2]

void AccelByte.Api.UGC.CreateContent	(	string	channelId,
		string	name,
		string	type,
		string	subtype,
		string[]	tags,
		byte[]	preview,
		string	fileExtension,
		ResultCallback< UGCResponse >	callback,
		string	contentType = "application/octet-stream" )

inline

Create a content with byte array Preview paramater 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	Preview the byte array of the content's preview.
fileExtension	FileExtension of the content
callback	This will be called when the operation succeeded. The result is UGCResponse Model.
contentType	The specific type of the content's created. default value is "application/octet-stream"

◆ CreateContent() [2/2]

void AccelByte.Api.UGC.CreateContent	(	string	channelId,
		UGCRequest	createRequest,
		ResultCallback< UGCResponse >	callback )

inline

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

Parameters

channelId	The id of the content's channel.
createRequest	Detail information for the content request.
callback	This will be called when the operation succeeded. The result is UGCResponse Model.

◆ CreateContentV2()

void AccelByte.Api.UGC.CreateContentV2	(	string	channelId,
		CreateUGCRequestV2	createRequest,
		ResultCallback< UGCModelsCreateUGCResponseV2 >	callback )

inline

Create a UGC content with create content request.

Parameters

channelId	The id of the content's channel.
createRequest	Detail information for the content request.
callback	This will be called when the operation succeeded.

◆ DeleteChannel()

void AccelByte.Api.UGC.DeleteChannel	(	string	channelId,
		ResultCallback	callback )

inline

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

Parameters

channelId	The id of the channel that will be deleted.
callback	This will be called when the operation succeeded.

◆ DeleteContent()

void AccelByte.Api.UGC.DeleteContent	(	string	channelId,
		string	contentId,
		ResultCallback	callback )

inline

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.
callback	This will be called when the operation succeeded.

◆ DeleteContentByShareCode()

void AccelByte.Api.UGC.DeleteContentByShareCode	(	string	channelId,
		string	shareCode,
		ResultCallback	callback )

inline

Delete a content based on 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.
callback	This will be called when the operation succeeded.

◆ DeleteContentScreenshotV2()

void AccelByte.Api.UGC.DeleteContentScreenshotV2	(	string	contentId,
		string	screenshotId,
		ResultCallback	callback )

inline

Delete screenshots for content.

Parameters

contentId	Content Id.
screenshotId	Screenshot Id.
callback	This will be called when the operation succeeded.</param

◆ DeleteContentV2()

void AccelByte.Api.UGC.DeleteContentV2	(	string	channelId,
		string	contentId,
		ResultCallback	callback )

inline

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.
callback	This will be called when the operation succeeded.

◆ DeleteStagingContentByContentId()

void AccelByte.Api.UGC.DeleteStagingContentByContentId	(	string	userId,
		string	contentId,
		ResultCallback	callback )

inline

Delete a content based on content id. </summary

Parameters

userId	The User id.
contentId	The content id that will be fetched.
callback	This will be called when the operation succeeded.

◆ GenerateUploadContentURLV2()

void AccelByte.Api.UGC.GenerateUploadContentURLV2	(	string	channelId,
		string	contentId,
		UGCUploadContentURLRequestV2	uploadRequest,
		ResultCallback< UGCModelsUploadContentURLResponseV2 >	callback )

inline

Generate Upload URL and Conten File Location.

Parameters

channelId	The id of the content's channel.
contentId	The contentId.
uploadRequest	Detail information for the upload request.
callback	This will be called when the operation succeeded.

◆ GetBulkContentId()

void AccelByte.Api.UGC.GetBulkContentId	(	string[]	contentIds,
		ResultCallback< UGCModelsContentsResponse[]>	callback )

inline

Get Bulk ContentId.

Parameters

contentId	The content Ids.
callback	This will be called when the operation succeeded.

◆ GetChannels() [1/2]

void AccelByte.Api.UGC.GetChannels	(	ResultCallback< UGCChannelPagingResponse >	callback,
		int	offset = 0,
		int	limit = 1000,
		string	channelName = "" )

inline

Get all of the player's channels.

Parameters

callback	This will be called when the operation succeeded. The result is UGCChannelsPagingResponse Model.
offset	The offset of the channel results. Default value is 0.
limit	The limit of the channel results. Default value is 1000.
channelName	The name of the channel you want to query.

◆ GetChannels() [2/2]

void AccelByte.Api.UGC.GetChannels	(	string	userId,
		ResultCallback< UGCChannelPagingResponse >	callback,
		int	offset = 0,
		int	limit = 1000,
		string	channelName = "" )

inline

Get all of the player's channels.

Parameters

userId	The userId.
callback	This will be called when the operation succeeded. The result is UGCChannelsPagingResponse Model.
offset	The offset of the channel results. Default value is 0.
limit	The limit of the channel results. Default value is 1000.
channelName	The name of the channel you want to query.

◆ GetContentBulkByIdsV2()

void AccelByte.Api.UGC.GetContentBulkByIdsV2	(	string[]	contentIds,
		ResultCallback< UGCModelsContentsResponseV2[]>	callback )

inline

Get contents by content Ids.

Parameters

contentId	Content Ids Array
callback	This will be called when the operation succeeded.

◆ GetContentByContentId()

void AccelByte.Api.UGC.GetContentByContentId	(	string	contentId,
		ResultCallback< UGCContentResponse >	callback )

inline

Get a content information by its content id.

Parameters

contentId	The id of the content that will be fetched.
callback	This will be called when the operation succeeded. The result is UGCContentResponse Model.

◆ GetContentByContentIdV2()

void AccelByte.Api.UGC.GetContentByContentIdV2	(	string	contentId,
		ResultCallback< UGCModelsContentsResponseV2 >	callback )

inline

Get a content information by its content id.

Parameters

contentId	The id of the content that will be fetched.
callback	This will be called when the operation succeeded.

◆ GetContentByShareCode()

void AccelByte.Api.UGC.GetContentByShareCode	(	string	shareCode,
		ResultCallback< UGCContentResponse >	callback )

inline

Get a content information by its share code.

Parameters

shareCode	The share code of the content that will be fetched.
callback	This will be called when the operation succeeded. The result is UGCContentResponse Model.

◆ GetContentByShareCodeV2()

void AccelByte.Api.UGC.GetContentByShareCodeV2	(	string	shareCode,
		ResultCallback< UGCModelsContentsResponseV2 >	callback )

inline

Get a content information by its share code.

Parameters

shareCode	The share code of the content that will be fetched.
callback	This will be called when the operation succeeded.

◆ GetContentFollowed()

void AccelByte.Api.UGC.GetContentFollowed	(	ResultCallback< UGCContentsPagingResponse >	callback,
		int	limit = 1000,
		int	offset = 0 )

inline

Get Content Followed.

Parameters

callback	This will be called when the operation succeeded.
limit	The limit Number of user per page. Default value is 1000.
offset	The offset number to retrieve. Default value is 0.

◆ GetContentPreview() [1/2]

void AccelByte.Api.UGC.GetContentPreview	(	string	contentId,
		ResultCallback< byte[]>	callback )

inline

Get content preview as byte array.

Parameters

contentId	The id of the Preview's content that will be fetched.
callback	This will be called when the operation succeeded. The result is byte array

◆ GetContentPreview() [2/2]

void AccelByte.Api.UGC.GetContentPreview	(	string	contentId,
		ResultCallback< UGCPreview >	callback )

inline

Get content preview as UGCPreview Model.

Parameters

contentId	The id of the Preview's content that will be fetched.
callback	This will be called when the operation succeeded. The result is UGCPreview Model.

◆ GetCreatorStats()

void AccelByte.Api.UGC.GetCreatorStats	(	string	userId,
		ResultCallback< UGCGetCreatorStatsResponse >	callback )

inline

Get Creator Stats.

Parameters

userId	The userId.
callback	This will be called when the operation succeeded.

◆ GetFollowedCreators()

void AccelByte.Api.UGC.GetFollowedCreators	(	ResultCallback< UGCGetListFollowersPagingResponse >	callback,
		int	limit = 1000,
		int	offset = 0 )

inline

Get Followed Creators.

Parameters

callback	This will be called when the operation succeeded.
limit	The limit Number of user per page. Default value is 1000.
offset	The offset number to retrieve. Default value is 0.

◆ GetLikedContents() [1/2]

void AccelByte.Api.UGC.GetLikedContents	(	GetAllLikedContentRequest	getLikedContentRequest,
		ResultCallback< UGCContentsPagingResponse >	callback )

inline

Get Liked Contents.

Parameters

getLikedContentRequest	Detail information for the content request.
callback	This will be called when the operation succeeded.

◆ GetLikedContents() [2/2]

void AccelByte.Api.UGC.GetLikedContents	(	GetLikedContentRequest	getLikedContentRequest,
		ResultCallback< UGCContentsPagingResponse >	callback )

inline

Get Liked Contents.

Parameters

getLikedContentRequest	Detail information for the content request.
callback	This will be called when the operation succeeded.

◆ GetListContentDownloaderV2()

void AccelByte.Api.UGC.GetListContentDownloaderV2	(	string	contentId,
		ResultCallback< UGCModelsPaginatedContentDownloaderResponseV2 >	callback,
		string	userId = "",
		int	limit = 20,
		int	offset = 0,
		UGCContentDownloaderSortBy	sortBy = UGCContentDownloaderSortBy::CreatedTimeDesc )

inline

Get list of UGC content downloader.

Parameters

contentId	The contentId.
callback	This will be called when the operation succeeded.
userId	The userId.
limit	The limit Number of user per page. Default value is 20.
offset	The offset number to retrieve. Default value is 0.
sortBy	Sorting criteria: created time with asc or desc. Default= created time and desc.

◆ GetListContentLikerV2()

void AccelByte.Api.UGC.GetListContentLikerV2	(	string	contentId,
		ResultCallback< UGCModelsPaginatedContentLikerResponseV2 >	callback,
		int	limit = 20,
		int	offset = 0,
		UGCContentDownloaderSortBy	sortBy = UGCContentDownloaderSortBy::CreatedTimeDesc )

inline

Get a list of users who like the content.

Parameters

contentId	The contentId.
callback	This will be called when the operation succeeded.
limit	The limit Number of user per page. Default value is 20.
offset	The offset number to retrieve. Default value is 0.
sortBy	Sorting criteria: created time with asc or desc. Default= created time and desc.

◆ GetListFollowers()

void AccelByte.Api.UGC.GetListFollowers	(	ResultCallback< UGCGetListFollowersPagingResponse >	callback,
		int	limit = 1000,
		int	offset = 0 )

inline

Get List Followers.

Parameters

callback	This will be called when the operation succeeded.
limit	The limit Number of user per page. Default value is 1000.
offset	The offset number to retrieve. Default value is 0.

◆ GetListFollowing()

void AccelByte.Api.UGC.GetListFollowing	(	string	userId,
		ResultCallback< UGCGetListFollowersPagingResponse >	callback,
		int	limit = 1000,
		int	offset = 0 )

inline

Get List Following.

Parameters

userId	The userId.
callback	This will be called when the operation succeeded.
limit	The limit Number of user per page. Default value is 1000.
offset	The offset number to retrieve. Default value is 0.

◆ GetListStagingContent()

void AccelByte.Api.UGC.GetListStagingContent	(	string	userId,
		UGCStagingContentStatus	status,
		int	limit,
		int	offset,
		UGCListStagingContentSortBy	sortBy,
		ResultCallback< UGCModelsPaginatedStagingContentResponse >	callback )

inline

Get user staging content by Id.

Parameters

userId	The User id.
status	Status of staging content that will be fetched
offset	The offset of the channel results.
limit	The limit of the channel results.
callback	This will be called when the operation succeeded.

◆ GetTags()

void AccelByte.Api.UGC.GetTags	(	ResultCallback< UGCTagsPagingResponse >	callback,
		int	offset = 0,
		int	limit = 1000 )

inline

Get all tags.

Parameters

callback	This will be called when the operation succeeded. The result is UGCTagsPagingResponse Model.
offset	The offset of the tags results. Default value is 0.
limit	The limit of the tags results. Default value is 1000.

◆ GetTypes()

void AccelByte.Api.UGC.GetTypes	(	ResultCallback< UGCTypesPagingResponse >	callback,
		int	offset = 0,
		int	limit = 1000 )

inline

Get all of player's types and subtypes.

Parameters

callback	This will be called when the operation succeeded. The result is UGCTypesPagingResponse Model.
offset	The offset of the types and/or subtypes paging data result. Default value is 0.
limit	The limit of the types and subtypes results. Default value is 1000.

◆ GetUserContents()

void AccelByte.Api.UGC.GetUserContents	(	string	userId,
		ResultCallback< UGCContentsPagingResponse >	callback,
		int	limit = 1000,
		int	offset = 0 )

inline

Get User Contents.

Parameters

userId	The userId.
callback	This will be called when the operation succeeded.
limit	The limit Number of user per page. Default value is 1000.
offset	The offset number to retrieve. Default value is 0.

◆ GetUserContentsV2()

void AccelByte.Api.UGC.GetUserContentsV2	(	string	userId,
		ResultCallback< UGCSearchContentsPagingResponseV2 >	callback,
		int	limit = 20,
		int	offset = 0,
		UGCContentDownloaderSortBy	sortBy = UGCContentDownloaderSortBy::CreatedTimeDesc )

inline

Get user's generated contents.

Parameters

userId	User Id
callback	This will be called when the operation succeeded.
limit	The limit Number of user per page. Default value is 20.
offset	The offset number to retrieve. Default value is 0.
sortBy	Sorting criteria: created time with asc or desc. Default= created time and desc.

◆ GetUserGroups()

void AccelByte.Api.UGC.GetUserGroups	(	string	userId,
		ResultCallback< UGCGetUserGroupsPagingResponse >	callback,
		int	limit = 1000,
		int	offset = 0 )

inline

Get User Groups.

Parameters

userId	The userId.
callback	This will be called when the operation succeeded.
limit	The limit Number of user per page. Default value is 1000.
offset	The offset number to retrieve. Default value is 0.

◆ GetUserStagingContentByContentId()

void AccelByte.Api.UGC.GetUserStagingContentByContentId	(	string	userId,
		string	contentId,
		ResultCallback< UGCModelStagingContent >	callback )

inline

Get user staging content by Id.

Parameters

contentId	The content id that will be fetched.
callback	This will be called when the operation succeeded.

◆ ModifyContent() [1/3]

void AccelByte.Api.UGC.ModifyContent	(	string	channelId,
		string	contentId,
		string	name,
		string	type,
		string	subtype,
		string[]	tags,
		byte[]	preview,
		string	fileExtension,
		ResultCallback< UGCResponse >	callback,
		string	contentType = "application/octet-stream",
		bool	updateContent = false )

inline

Modify existing content to update some information with byte array Preview paramater.

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 byte array of the content's Preview
fileExtension	FileExtension of the content
callback	This will be called when the operation succeeded. The result is UGCResponse Model.
contentType	The specific type of the content's modified. Default value is "application/octet-stream"
updateContent	This will be used to update the content too or only content information . Default value is false.

◆ ModifyContent() [2/3]

void AccelByte.Api.UGC.ModifyContent	(	string	channelId,
		string	contentId,
		UGCRequest	ModifyRequest,
		ResultCallback< UGCResponse >	callback,
		bool	updateContent = false )

inline

Modify existing content to update some information with string 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.
callback	This will be called when the operation succeeded. The result is UGCResponse Model.
updateContent	This will be used to update the content too or only content information . Default value is false.

◆ ModifyContent() [3/3]

void AccelByte.Api.UGC.ModifyContent	(	string	channelId,
		string	contentId,
		UGCUpdateRequest	ModifyRequest,
		ResultCallback< UGCResponse >	callback )

inline

Modify existing content to update some information with string 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.
callback	This will be called when the operation succeeded. The result is UGCResponse Model.

◆ ModifyContentByShareCode()

void AccelByte.Api.UGC.ModifyContentByShareCode	(	string	channelId,
		string	shareCode,
		UGCUpdateRequest	modifyRequest,
		ResultCallback< UGCResponse >	callback )

inline

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.
callback	This will be called when the operation succeeded. The result is UGCResponse Model.

◆ ModifyContentV2()

void AccelByte.Api.UGC.ModifyContentV2	(	string	channelId,
		string	contentId,
		ModifyUGCRequestV2	modifyRequest,
		ResultCallback< UGCModelsModifyUGCResponseV2 >	callback )

inline

Modify existing content to update some information.

Parameters

channelId	The id of the content's channel.
contentId	The contentId.
modifyRequest	Detail information for the content request that will be modified.
callback	This will be called when the operation succeeded.

◆ ModifyStagingContentByContentId()

void AccelByte.Api.UGC.ModifyStagingContentByContentId	(	string	userId,
		string	contentId,
		UGCUpdateStagingContentRequest	modifyRequest,
		ResultCallback< UGCModelStagingContent >	callback )

inline

Modify staging content to update some information based on content id.

Parameters

userId	The User di.
contentId	The content Id.
modifyRequest	Detail information for the content request that will be modified.
callback	This will be called when the operation succeeded.

◆ SearchContent()

void AccelByte.Api.UGC.SearchContent	(	SearchContentRequest	searchContentRequest,
		ResultCallback< UGCSearchContentsPagingResponse >	callback )

inline

Search Content player's channel based on the its channel id.

Parameters

searchContentRequest	Detail information for the search content request..
callback	This will be called when the operation succeeded.

◆ SearchContentsSpecificToChannelV2()

void AccelByte.Api.UGC.SearchContentsSpecificToChannelV2	(	string	channelId,
		ResultCallback< UGCSearchContentsPagingResponseV2 >	callback,
		int	limit = 20,
		int	offset = 0,
		UGCContentDownloaderSortBy	sortBy = UGCContentDownloaderSortBy::CreatedTimeDesc )

inline

Search contents specific to a channel.

Parameters

channelId	Channel Id.
callback	This will be called when the operation succeeded.
limit	The limit Number of user per page. Default value is 20.
offset	The offset number to retrieve. Default value is 0.
sortBy	Sorting criteria: created time with asc or desc. Default= created time and desc.

◆ SearchContentsSpesificToChannel()

void AccelByte.Api.UGC.SearchContentsSpesificToChannel	(	string	channelId,
		SearchContentRequest	searchContentRequest,
		ResultCallback< UGCSearchContentsPagingResponse >	callback )

inline

Search Content player's channel based on the its channel id.

Parameters

channelId	The id of the content's channel.
searchContentRequest	Detail information for the content request..
callback	This will be called when the operation succeeded.

◆ SearchContentsV2()

void AccelByte.Api.UGC.SearchContentsV2	(	UGCGetContentFilterRequestV2	filterRequest,
		ResultCallback< UGCSearchContentsPagingResponseV2 >	callback,
		int	limit = 20,
		int	offset = 0,
		UGCContentSortBy	sortBy = UGCContentSortBy::CreatedTimeDesc )

inline

Get all contents in current namespace.

Parameters

filterRequest	To filter the returned UGC contets.
callback	This will be called when the operation succeeded.
limit	The limit Number of user per page. Default value is 20.
offset	The offset number to retrieve. Default value is 0.
sortBy	Sorting criteria: name, download, like, created time with asc or desc. Default= created time and asc.

◆ UpdateChannel()

void AccelByte.Api.UGC.UpdateChannel	(	string	channelId,
		string	name,
		ResultCallback< UGCChannelResponse >	callback )

inline

Update channel.

Parameters

channelId	The channelId value.
name	The new channel's name value.
callback	This will be called when the operation succeeded.

◆ UpdateContentFileLocationV2()

void AccelByte.Api.UGC.UpdateContentFileLocationV2	(	string	channelId,
		string	contentId,
		string	fileExtension,
		string	s3Key,
		ResultCallback< UpdateContentFileLocationResponseV2 >	callback )

inline

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.
callback	This will be called when the operation succeeded.

◆ UpdateContentScreenshotV2()

void AccelByte.Api.UGC.UpdateContentScreenshotV2	(	string	contentId,
		ScreenshotsUpdatesV2	updateSreenshotsRequest,
		ResultCallback< ScreenshotsUpdatesV2 >	callback )

inline

Update screenshots for content.

Parameters

contentId	Content Id.
userId	The userId.
screenshotsRequest	Supported file extensions: pjp, jpg, jpeg, jfif, bmp, png. Maximum description length: 1024.
callback	This will be called when the operation succeeded.</param

◆ UpdateFollowStatus() [1/2]

void AccelByte.Api.UGC.UpdateFollowStatus	(	bool	followStatus,
		ResultCallback< UGCUpdateFollowStatusToUserResponse >	callback )

inline

Update follow/unfollow status to user.

Parameters

followStatus	The new follow status value.
callback	This will be called when the operation succeeded.

◆ UpdateFollowStatus() [2/2]

void AccelByte.Api.UGC.UpdateFollowStatus	(	bool	followStatus,
		string	userId,
		ResultCallback< UGCUpdateFollowStatusToUserResponse >	callback )

inline

Update follow/unfollow status to user.

Parameters

followStatus	The new follow status value.
userId	The userId.
callback	This will be called when the operation succeeded.

◆ UpdateLikeStatusToContent()

void AccelByte.Api.UGC.UpdateLikeStatusToContent	(	string	contentId,
		bool	likeStatus,
		ResultCallback< UGCUpdateLikeStatusToContentResponse >	callback )

inline

Update like/unlike status to a content.

Parameters

contentId	The content id that will be updated.
likeStatus	New like Status value.
callback	This will be called when the operation succeeded.

◆ UpdateLikeStatusToContentV2()

void AccelByte.Api.UGC.UpdateLikeStatusToContentV2	(	string	contentId,
		bool	likeStatus,
		ResultCallback< UGCUpdateLikeStatusToContentResponse >	callback )

inline

Update like/unlike status to a content.

Parameters

contentId	The content id that will be updated.
likeStatus	New like Status value.
callback	This will be called when the operation succeeded.

◆ UploadContentScreenshotV2()

void AccelByte.Api.UGC.UploadContentScreenshotV2	(	string	contentId,
		ScreenshotsRequest	screenshotsRequest,
		ResultCallback< ScreenshotsResponseV2 >	callback )

inline

Upload screenshots for content.

Parameters

contentId	Content Id.
userId	The userId.
screenshotsRequest	Supported file extensions: pjp, jpg, jpeg, jfif, bmp, png. Maximum description length: 1024.
callback	This will be called when the operation succeeded.</param

◆ UploadScreenshotContent()

void AccelByte.Api.UGC.UploadScreenshotContent	(	string	contentId,
		string	userId,
		ScreenshotsRequest	screenshotsRequest,
		ResultCallback< ScreenshotsResponse >	callback )

inline

Get User Contents.

Parameters

contentId	The contentId.
userId	The userId.
screenshotsRequest	Supported file extensions: pjp, jpg, jpeg, jfif, bmp, png. Maximum description length: 1024..
callback	This will be called when the operation succeeded.

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()

◆ DeleteStagingContentByContentId()

◆ GenerateUploadContentURLV2()

◆ GetBulkContentId()

◆ GetChannels() [1/2]

◆ GetChannels() [2/2]

◆ GetContentBulkByIdsV2()

◆ GetContentByContentId()

◆ GetContentByContentIdV2()

◆ GetContentByShareCode()

◆ GetContentByShareCodeV2()

◆ GetContentFollowed()

◆ GetContentPreview() [1/2]

◆ GetContentPreview() [2/2]

◆ GetCreatorStats()

◆ GetFollowedCreators()

◆ GetLikedContents() [1/2]

◆ GetLikedContents() [2/2]

◆ GetListContentDownloaderV2()

◆ GetListContentLikerV2()

◆ GetListFollowers()

◆ GetListFollowing()

◆ GetListStagingContent()

◆ GetTags()

◆ GetTypes()

◆ GetUserContents()

◆ GetUserContentsV2()

◆ GetUserGroups()

◆ GetUserStagingContentByContentId()

◆ ModifyContent() [1/3]

◆ ModifyContent() [2/3]

◆ ModifyContent() [3/3]

◆ ModifyContentByShareCode()

◆ ModifyContentV2()

◆ ModifyStagingContentByContentId()

◆ SearchContent()

◆ SearchContentsSpecificToChannelV2()

◆ SearchContentsSpesificToChannel()

◆ SearchContentsV2()

◆ UpdateChannel()

◆ UpdateContentFileLocationV2()

◆ UpdateContentScreenshotV2()

◆ UpdateFollowStatus() [1/2]

◆ UpdateFollowStatus() [2/2]

◆ UpdateLikeStatusToContent()

◆ UpdateLikeStatusToContentV2()

◆ UploadContentScreenshotV2()

◆ UploadScreenshotContent()