Table of Contents

Class ISteamUGC

Namespace
MarymoorStudios.Core.Steamworks
Assembly
MarymoorStudios.Core.Steamworks.dll
public sealed class ISteamUGC : SteamNativeObject
Inheritance
ISteamUGC
Inherited Members

Fields

INTERFACE_VERSION 

public const string INTERFACE_VERSION = "STEAMUGC_INTERFACE_VERSION021"

Field Value

string

Methods

AddAppDependency(PublishedFileId, AppId) 

public Promise<AddAppDependencyResult> AddAppDependency(PublishedFileId publishedFileID, AppId appId)

Parameters

publishedFileID PublishedFileId
appId AppId

Returns

Promise<AddAppDependencyResult>

AddContentDescriptor(UGCUpdateHandle, EUGCContentDescriptorID) 

public bool AddContentDescriptor(UGCUpdateHandle handle, EUGCContentDescriptorID descid)

Parameters

handle UGCUpdateHandle
descid EUGCContentDescriptorID

Returns

bool

AddDependency(PublishedFileId, PublishedFileId) 

public Promise<AddUGCDependencyResult> AddDependency(PublishedFileId parentPublishedFileID, PublishedFileId childPublishedFileID)

Parameters

parentPublishedFileID PublishedFileId
childPublishedFileID PublishedFileId

Returns

Promise<AddUGCDependencyResult>

AddExcludedTag(UGCQueryHandle, string) 

public bool AddExcludedTag(UGCQueryHandle handle, string tagName)

Parameters

handle UGCQueryHandle
tagName string

Returns

bool

AddItemKeyValueTag(UGCUpdateHandle, string, string) 

public bool AddItemKeyValueTag(UGCUpdateHandle handle, string key, string value)

Parameters

handle UGCUpdateHandle
key string
value string

Returns

bool

AddItemPreviewFile(UGCUpdateHandle, string, EItemPreviewType) 

public bool AddItemPreviewFile(UGCUpdateHandle handle, string pszPreviewFile, EItemPreviewType type)

Parameters

handle UGCUpdateHandle
pszPreviewFile string
type EItemPreviewType

Returns

bool

AddItemPreviewVideo(UGCUpdateHandle, string) 

public bool AddItemPreviewVideo(UGCUpdateHandle handle, string pszVideoID)

Parameters

handle UGCUpdateHandle
pszVideoID string

Returns

bool

AddItemToFavorites(AppId, PublishedFileId) 

public Promise<UserFavoriteItemsListChanged> AddItemToFavorites(AppId appId, PublishedFileId publishedFileID)

Parameters

appId AppId
publishedFileID PublishedFileId

Returns

Promise<UserFavoriteItemsListChanged>

AddRequiredKeyValueTag(UGCQueryHandle, string, string) 

public bool AddRequiredKeyValueTag(UGCQueryHandle handle, string key, string value)

Parameters

handle UGCQueryHandle
key string
value string

Returns

bool

AddRequiredTag(UGCQueryHandle, string) 

public bool AddRequiredTag(UGCQueryHandle handle, string tagName)

Parameters

handle UGCQueryHandle
tagName string

Returns

bool

AddRequiredTagGroup(UGCQueryHandle, in SteamParamStringArray) 

public bool AddRequiredTagGroup(UGCQueryHandle handle, in SteamParamStringArray tagGroups)

Parameters

handle UGCQueryHandle
tagGroups SteamParamStringArray

Returns

bool

BInitWorkshopForGameServer(DepotId, string) 

public bool BInitWorkshopForGameServer(DepotId workshopDepotID, string pszFolder)

Parameters

workshopDepotID DepotId
pszFolder string

Returns

bool

CreateItem(AppId, EWorkshopFileType) 

public Promise<CreateItemResult> CreateItem(AppId consumerAppId, EWorkshopFileType fileType)

Parameters

consumerAppId AppId
fileType EWorkshopFileType

Returns

Promise<CreateItemResult>

CreateQueryAllUGCRequest(EUGCQuery, EUGCMatchingUGCType, AppId, AppId, string) 

public UGCQueryHandle CreateQueryAllUGCRequest(EUGCQuery queryType, EUGCMatchingUGCType matchingeMatchingUGCTypeFileType, AppId creatorAppID, AppId consumerAppID, string cursor)

Parameters

queryType EUGCQuery
matchingeMatchingUGCTypeFileType EUGCMatchingUGCType
creatorAppID AppId
consumerAppID AppId
cursor string

Returns

UGCQueryHandle

CreateQueryAllUGCRequest(EUGCQuery, EUGCMatchingUGCType, AppId, AppId, uint) 

public UGCQueryHandle CreateQueryAllUGCRequest(EUGCQuery queryType, EUGCMatchingUGCType matchingeMatchingUGCTypeFileType, AppId creatorAppID, AppId consumerAppID, uint page)

Parameters

queryType EUGCQuery
matchingeMatchingUGCTypeFileType EUGCMatchingUGCType
creatorAppID AppId
consumerAppID AppId
page uint

Returns

UGCQueryHandle

CreateQueryUGCDetailsRequest(out PublishedFileId, uint) 

public UGCQueryHandle CreateQueryUGCDetailsRequest(out PublishedFileId publishedFileID, uint numPublishedFileIDs)

Parameters

publishedFileID PublishedFileId
numPublishedFileIDs uint

Returns

UGCQueryHandle

CreateQueryUserUGCRequest(AccountID, EUserUGCList, EUGCMatchingUGCType, EUserUGCListSortOrder, AppId, AppId, uint) 

public UGCQueryHandle CreateQueryUserUGCRequest(AccountID accountID, EUserUGCList listType, EUGCMatchingUGCType matchingUGCType, EUserUGCListSortOrder sortOrder, AppId creatorAppID, AppId consumerAppID, uint page)

Parameters

accountID AccountID
listType EUserUGCList
matchingUGCType EUGCMatchingUGCType
sortOrder EUserUGCListSortOrder
creatorAppID AppId
consumerAppID AppId
page uint

Returns

UGCQueryHandle

DeleteItem(PublishedFileId) 

public Promise<DeleteItemResult> DeleteItem(PublishedFileId publishedFileID)

Parameters

publishedFileID PublishedFileId

Returns

Promise<DeleteItemResult>

DownloadItem(PublishedFileId, bool) 

public bool DownloadItem(PublishedFileId publishedFileID, bool highPriority)

Parameters

publishedFileID PublishedFileId
highPriority bool

Returns

bool

GetAppDependencies(PublishedFileId) 

public Promise<GetAppDependenciesResult> GetAppDependencies(PublishedFileId publishedFileID)

Parameters

publishedFileID PublishedFileId

Returns

Promise<GetAppDependenciesResult>

GetItemDownloadInfo(PublishedFileId, out ulong, out ulong) 

public bool GetItemDownloadInfo(PublishedFileId publishedFileID, out ulong bytesDownloaded, out ulong bytesTotal)

Parameters

publishedFileID PublishedFileId
bytesDownloaded ulong
bytesTotal ulong

Returns

bool

GetItemInstallInfo(PublishedFileId, out ulong, Span<byte>, out uint) 

public bool GetItemInstallInfo(PublishedFileId publishedFileID, out ulong sizeOnDisk, Span<byte> folder, out uint timeStamp)

Parameters

publishedFileID PublishedFileId
sizeOnDisk ulong
folder Span<byte>
timeStamp uint

Returns

bool

GetItemState(PublishedFileId) 

public uint GetItemState(PublishedFileId publishedFileID)

Parameters

publishedFileID PublishedFileId

Returns

uint

GetItemUpdateProgress(UGCUpdateHandle, out ulong, out ulong) 

public EItemUpdateStatus GetItemUpdateProgress(UGCUpdateHandle handle, out ulong bytesProcessed, out ulong bytesTotal)

Parameters

handle UGCUpdateHandle
bytesProcessed ulong
bytesTotal ulong

Returns

EItemUpdateStatus

GetNumSubscribedItems(bool) 

public uint GetNumSubscribedItems(bool includeLocallyDisabled)

Parameters

includeLocallyDisabled bool

Returns

uint

GetNumSupportedGameVersions(UGCQueryHandle, uint) 

public uint GetNumSupportedGameVersions(UGCQueryHandle handle, uint index)

Parameters

handle UGCQueryHandle
index uint

Returns

uint

GetQueryUGCAdditionalPreview(UGCQueryHandle, uint, uint, Span<byte>, Span<byte>, out EItemPreviewType) 

public bool GetQueryUGCAdditionalPreview(UGCQueryHandle handle, uint index, uint previewIndex, Span<byte> urlOrVideoID, Span<byte> originalFileName, out EItemPreviewType previewType)

Parameters

handle UGCQueryHandle
index uint
previewIndex uint
urlOrVideoID Span<byte>
originalFileName Span<byte>
previewType EItemPreviewType

Returns

bool

GetQueryUGCChildren(UGCQueryHandle, uint, out PublishedFileId, uint) 

public bool GetQueryUGCChildren(UGCQueryHandle handle, uint index, out PublishedFileId publishedFileID, uint maxEntries)

Parameters

handle UGCQueryHandle
index uint
publishedFileID PublishedFileId
maxEntries uint

Returns

bool

GetQueryUGCContentDescriptors(UGCQueryHandle, uint, out EUGCContentDescriptorID, uint) 

public uint GetQueryUGCContentDescriptors(UGCQueryHandle handle, uint index, out EUGCContentDescriptorID descriptors, uint maxEntries)

Parameters

handle UGCQueryHandle
index uint
descriptors EUGCContentDescriptorID
maxEntries uint

Returns

uint

GetQueryUGCKeyValueTag(UGCQueryHandle, uint, string, Span<byte>) 

public bool GetQueryUGCKeyValueTag(UGCQueryHandle handle, uint index, string key, Span<byte> value)

Parameters

handle UGCQueryHandle
index uint
key string
value Span<byte>

Returns

bool

GetQueryUGCKeyValueTag(UGCQueryHandle, uint, uint, Span<byte>, Span<byte>) 

public bool GetQueryUGCKeyValueTag(UGCQueryHandle handle, uint index, uint keyValueTagIndex, Span<byte> key, Span<byte> value)

Parameters

handle UGCQueryHandle
index uint
keyValueTagIndex uint
key Span<byte>
value Span<byte>

Returns

bool

GetQueryUGCMetadata(UGCQueryHandle, uint, Span<byte>) 

public bool GetQueryUGCMetadata(UGCQueryHandle handle, uint index, Span<byte> metadata)

Parameters

handle UGCQueryHandle
index uint
metadata Span<byte>

Returns

bool

GetQueryUGCNumAdditionalPreviews(UGCQueryHandle, uint) 

public uint GetQueryUGCNumAdditionalPreviews(UGCQueryHandle handle, uint index)

Parameters

handle UGCQueryHandle
index uint

Returns

uint

GetQueryUGCNumKeyValueTags(UGCQueryHandle, uint) 

public uint GetQueryUGCNumKeyValueTags(UGCQueryHandle handle, uint index)

Parameters

handle UGCQueryHandle
index uint

Returns

uint

GetQueryUGCNumTags(UGCQueryHandle, uint) 

public uint GetQueryUGCNumTags(UGCQueryHandle handle, uint index)

Parameters

handle UGCQueryHandle
index uint

Returns

uint

GetQueryUGCPreviewURL(UGCQueryHandle, uint, Span<byte>) 

public bool GetQueryUGCPreviewURL(UGCQueryHandle handle, uint index, Span<byte> url)

Parameters

handle UGCQueryHandle
index uint
url Span<byte>

Returns

bool

GetQueryUGCResult(UGCQueryHandle, uint, out SteamUGCDetails) 

public bool GetQueryUGCResult(UGCQueryHandle handle, uint index, out SteamUGCDetails details)

Parameters

handle UGCQueryHandle
index uint
details SteamUGCDetails

Returns

bool

GetQueryUGCStatistic(UGCQueryHandle, uint, EItemStatistic, out ulong) 

public bool GetQueryUGCStatistic(UGCQueryHandle handle, uint index, EItemStatistic statType, out ulong statValue)

Parameters

handle UGCQueryHandle
index uint
statType EItemStatistic
statValue ulong

Returns

bool

GetQueryUGCTag(UGCQueryHandle, uint, uint, Span<byte>) 

public bool GetQueryUGCTag(UGCQueryHandle handle, uint index, uint indexTag, Span<byte> value)

Parameters

handle UGCQueryHandle
index uint
indexTag uint
value Span<byte>

Returns

bool

GetQueryUGCTagDisplayName(UGCQueryHandle, uint, uint, Span<byte>) 

public bool GetQueryUGCTagDisplayName(UGCQueryHandle handle, uint index, uint indexTag, Span<byte> value)

Parameters

handle UGCQueryHandle
index uint
indexTag uint
value Span<byte>

Returns

bool

GetSubscribedItems(out PublishedFileId, uint, bool) 

public uint GetSubscribedItems(out PublishedFileId publishedFileID, uint maxEntries, bool includeLocallyDisabled)

Parameters

publishedFileID PublishedFileId
maxEntries uint
includeLocallyDisabled bool

Returns

uint

GetSupportedGameVersionData(UGCQueryHandle, uint, uint, Span<byte>, Span<byte>) 

public bool GetSupportedGameVersionData(UGCQueryHandle handle, uint index, uint versionIndex, Span<byte> gameBranchMin, Span<byte> gameBranchMax)

Parameters

handle UGCQueryHandle
index uint
versionIndex uint
gameBranchMin Span<byte>
gameBranchMax Span<byte>

Returns

bool

GetUserContentDescriptorPreferences(out EUGCContentDescriptorID, uint) 

public uint GetUserContentDescriptorPreferences(out EUGCContentDescriptorID descriptors, uint maxEntries)

Parameters

descriptors EUGCContentDescriptorID
maxEntries uint

Returns

uint

GetUserItemVote(PublishedFileId) 

public Promise<GetUserItemVoteResult> GetUserItemVote(PublishedFileId publishedFileID)

Parameters

publishedFileID PublishedFileId

Returns

Promise<GetUserItemVoteResult>

GetWorkshopEULAStatus() 

public Promise<WorkshopEULAStatus> GetWorkshopEULAStatus()

Returns

Promise<WorkshopEULAStatus>

OnDownloadItemResult(CallbackAction<DownloadItemResult>) 

public IDisposable OnDownloadItemResult(CallbackAction<DownloadItemResult> func)

Parameters

func CallbackAction<DownloadItemResult>

Returns

IDisposable

OnItemInstalled(CallbackAction<ItemInstalled>) 

public IDisposable OnItemInstalled(CallbackAction<ItemInstalled> func)

Parameters

func CallbackAction<ItemInstalled>

Returns

IDisposable

OnUserSubscribedItemsListChanged(CallbackAction<UserSubscribedItemsListChanged>) 

public IDisposable OnUserSubscribedItemsListChanged(CallbackAction<UserSubscribedItemsListChanged> func)

Parameters

func CallbackAction<UserSubscribedItemsListChanged>

Returns

IDisposable

ReleaseQueryUGCRequest(UGCQueryHandle) 

public bool ReleaseQueryUGCRequest(UGCQueryHandle handle)

Parameters

handle UGCQueryHandle

Returns

bool

RemoveAllItemKeyValueTags(UGCUpdateHandle) 

public bool RemoveAllItemKeyValueTags(UGCUpdateHandle handle)

Parameters

handle UGCUpdateHandle

Returns

bool

RemoveAppDependency(PublishedFileId, AppId) 

public Promise<RemoveAppDependencyResult> RemoveAppDependency(PublishedFileId publishedFileID, AppId appId)

Parameters

publishedFileID PublishedFileId
appId AppId

Returns

Promise<RemoveAppDependencyResult>

RemoveContentDescriptor(UGCUpdateHandle, EUGCContentDescriptorID) 

public bool RemoveContentDescriptor(UGCUpdateHandle handle, EUGCContentDescriptorID descid)

Parameters

handle UGCUpdateHandle
descid EUGCContentDescriptorID

Returns

bool

RemoveDependency(PublishedFileId, PublishedFileId) 

public Promise<RemoveUGCDependencyResult> RemoveDependency(PublishedFileId parentPublishedFileID, PublishedFileId childPublishedFileID)

Parameters

parentPublishedFileID PublishedFileId
childPublishedFileID PublishedFileId

Returns

Promise<RemoveUGCDependencyResult>

RemoveItemFromFavorites(AppId, PublishedFileId) 

public Promise<UserFavoriteItemsListChanged> RemoveItemFromFavorites(AppId appId, PublishedFileId publishedFileID)

Parameters

appId AppId
publishedFileID PublishedFileId

Returns

Promise<UserFavoriteItemsListChanged>

RemoveItemKeyValueTags(UGCUpdateHandle, string) 

public bool RemoveItemKeyValueTags(UGCUpdateHandle handle, string key)

Parameters

handle UGCUpdateHandle
key string

Returns

bool

RemoveItemPreview(UGCUpdateHandle, uint) 

public bool RemoveItemPreview(UGCUpdateHandle handle, uint index)

Parameters

handle UGCUpdateHandle
index uint

Returns

bool

RequestUGCDetails(PublishedFileId, uint) 

public Promise<SteamUGCRequestUGCDetailsResult> RequestUGCDetails(PublishedFileId publishedFileID, uint maxAgeSeconds)

Parameters

publishedFileID PublishedFileId
maxAgeSeconds uint

Returns

Promise<SteamUGCRequestUGCDetailsResult>

SendQueryUGCRequest(UGCQueryHandle) 

public Promise<SteamUGCQueryCompleted> SendQueryUGCRequest(UGCQueryHandle handle)

Parameters

handle UGCQueryHandle

Returns

Promise<SteamUGCQueryCompleted>

SetAdminQuery(UGCUpdateHandle, bool) 

public bool SetAdminQuery(UGCUpdateHandle handle, bool adminQuery)

Parameters

handle UGCUpdateHandle
adminQuery bool

Returns

bool

SetAllowCachedResponse(UGCQueryHandle, uint) 

public bool SetAllowCachedResponse(UGCQueryHandle handle, uint maxAgeSeconds)

Parameters

handle UGCQueryHandle
maxAgeSeconds uint

Returns

bool

SetAllowLegacyUpload(UGCUpdateHandle, bool) 

public bool SetAllowLegacyUpload(UGCUpdateHandle handle, bool allowLegacyUpload)

Parameters

handle UGCUpdateHandle
allowLegacyUpload bool

Returns

bool

SetCloudFileNameFilter(UGCQueryHandle, string) 

public bool SetCloudFileNameFilter(UGCQueryHandle handle, string matchCloudFileName)

Parameters

handle UGCQueryHandle
matchCloudFileName string

Returns

bool

SetItemContent(UGCUpdateHandle, string) 

public bool SetItemContent(UGCUpdateHandle handle, string pszContentFolder)

Parameters

handle UGCUpdateHandle
pszContentFolder string

Returns

bool

SetItemDescription(UGCUpdateHandle, string) 

public bool SetItemDescription(UGCUpdateHandle handle, string description)

Parameters

handle UGCUpdateHandle
description string

Returns

bool

SetItemMetadata(UGCUpdateHandle, string) 

public bool SetItemMetadata(UGCUpdateHandle handle, string metaData)

Parameters

handle UGCUpdateHandle
metaData string

Returns

bool

SetItemPreview(UGCUpdateHandle, string) 

public bool SetItemPreview(UGCUpdateHandle handle, string pszPreviewFile)

Parameters

handle UGCUpdateHandle
pszPreviewFile string

Returns

bool

SetItemTags(UGCUpdateHandle, in SteamParamStringArray, bool) 

public bool SetItemTags(UGCUpdateHandle updateHandle, in SteamParamStringArray tags, bool allowAdminTags)

Parameters

updateHandle UGCUpdateHandle
tags SteamParamStringArray
allowAdminTags bool

Returns

bool

SetItemTitle(UGCUpdateHandle, string) 

public bool SetItemTitle(UGCUpdateHandle handle, string title)

Parameters

handle UGCUpdateHandle
title string

Returns

bool

SetItemUpdateLanguage(UGCUpdateHandle, string) 

public bool SetItemUpdateLanguage(UGCUpdateHandle handle, string language)

Parameters

handle UGCUpdateHandle
language string

Returns

bool

SetItemVisibility(UGCUpdateHandle, ERemoteStoragePublishedFileVisibility) 

public bool SetItemVisibility(UGCUpdateHandle handle, ERemoteStoragePublishedFileVisibility visibility)

Parameters

handle UGCUpdateHandle
visibility ERemoteStoragePublishedFileVisibility

Returns

bool

SetItemsDisabledLocally(out PublishedFileId, uint, bool) 

public bool SetItemsDisabledLocally(out PublishedFileId publishedFileIDs, uint numPublishedFileIDs, bool disabledLocally)

Parameters

publishedFileIDs PublishedFileId
numPublishedFileIDs uint
disabledLocally bool

Returns

bool

SetLanguage(UGCQueryHandle, string) 

public bool SetLanguage(UGCQueryHandle handle, string language)

Parameters

handle UGCQueryHandle
language string

Returns

bool

SetMatchAnyTag(UGCQueryHandle, bool) 

public bool SetMatchAnyTag(UGCQueryHandle handle, bool matchAnyTag)

Parameters

handle UGCQueryHandle
matchAnyTag bool

Returns

bool

SetRankedByTrendDays(UGCQueryHandle, uint) 

public bool SetRankedByTrendDays(UGCQueryHandle handle, uint days)

Parameters

handle UGCQueryHandle
days uint

Returns

bool

SetRequiredGameVersions(UGCUpdateHandle, string, string) 

public bool SetRequiredGameVersions(UGCUpdateHandle handle, string pszGameBranchMin, string pszGameBranchMax)

Parameters

handle UGCUpdateHandle
pszGameBranchMin string
pszGameBranchMax string

Returns

bool

SetReturnAdditionalPreviews(UGCQueryHandle, bool) 

public bool SetReturnAdditionalPreviews(UGCQueryHandle handle, bool returnAdditionalPreviews)

Parameters

handle UGCQueryHandle
returnAdditionalPreviews bool

Returns

bool

SetReturnChildren(UGCQueryHandle, bool) 

public bool SetReturnChildren(UGCQueryHandle handle, bool returnChildren)

Parameters

handle UGCQueryHandle
returnChildren bool

Returns

bool

SetReturnKeyValueTags(UGCQueryHandle, bool) 

public bool SetReturnKeyValueTags(UGCQueryHandle handle, bool returnKeyValueTags)

Parameters

handle UGCQueryHandle
returnKeyValueTags bool

Returns

bool

SetReturnLongDescription(UGCQueryHandle, bool) 

public bool SetReturnLongDescription(UGCQueryHandle handle, bool returnLongDescription)

Parameters

handle UGCQueryHandle
returnLongDescription bool

Returns

bool

SetReturnMetadata(UGCQueryHandle, bool) 

public bool SetReturnMetadata(UGCQueryHandle handle, bool returnMetadata)

Parameters

handle UGCQueryHandle
returnMetadata bool

Returns

bool

SetReturnOnlyIDs(UGCQueryHandle, bool) 

public bool SetReturnOnlyIDs(UGCQueryHandle handle, bool returnOnlyIDs)

Parameters

handle UGCQueryHandle
returnOnlyIDs bool

Returns

bool

SetReturnPlaytimeStats(UGCQueryHandle, uint) 

public bool SetReturnPlaytimeStats(UGCQueryHandle handle, uint days)

Parameters

handle UGCQueryHandle
days uint

Returns

bool

SetReturnTotalOnly(UGCQueryHandle, bool) 

public bool SetReturnTotalOnly(UGCQueryHandle handle, bool returnTotalOnly)

Parameters

handle UGCQueryHandle
returnTotalOnly bool

Returns

bool

SetSearchText(UGCQueryHandle, string) 

public bool SetSearchText(UGCQueryHandle handle, string searchText)

Parameters

handle UGCQueryHandle
searchText string

Returns

bool

SetSubscriptionsLoadOrder(out PublishedFileId, uint) 

public bool SetSubscriptionsLoadOrder(out PublishedFileId publishedFileIDs, uint numPublishedFileIDs)

Parameters

publishedFileIDs PublishedFileId
numPublishedFileIDs uint

Returns

bool

SetTimeCreatedDateRange(UGCQueryHandle, RTime32, RTime32) 

public bool SetTimeCreatedDateRange(UGCQueryHandle handle, RTime32 start, RTime32 end)

Parameters

handle UGCQueryHandle
start RTime32
end RTime32

Returns

bool

SetTimeUpdatedDateRange(UGCQueryHandle, RTime32, RTime32) 

public bool SetTimeUpdatedDateRange(UGCQueryHandle handle, RTime32 start, RTime32 end)

Parameters

handle UGCQueryHandle
start RTime32
end RTime32

Returns

bool

SetUserItemVote(PublishedFileId, bool) 

public Promise<SetUserItemVoteResult> SetUserItemVote(PublishedFileId publishedFileID, bool voteUp)

Parameters

publishedFileID PublishedFileId
voteUp bool

Returns

Promise<SetUserItemVoteResult>

ShowWorkshopEULA() 

public bool ShowWorkshopEULA()

Returns

bool

StartItemUpdate(AppId, PublishedFileId) 

public UGCUpdateHandle StartItemUpdate(AppId consumerAppId, PublishedFileId publishedFileID)

Parameters

consumerAppId AppId
publishedFileID PublishedFileId

Returns

UGCUpdateHandle

StartPlaytimeTracking(out PublishedFileId, uint) 

public Promise<StartPlaytimeTrackingResult> StartPlaytimeTracking(out PublishedFileId publishedFileID, uint numPublishedFileIDs)

Parameters

publishedFileID PublishedFileId
numPublishedFileIDs uint

Returns

Promise<StartPlaytimeTrackingResult>

StopPlaytimeTracking(out PublishedFileId, uint) 

public Promise<StopPlaytimeTrackingResult> StopPlaytimeTracking(out PublishedFileId publishedFileID, uint numPublishedFileIDs)

Parameters

publishedFileID PublishedFileId
numPublishedFileIDs uint

Returns

Promise<StopPlaytimeTrackingResult>

StopPlaytimeTrackingForAllItems() 

public Promise<StopPlaytimeTrackingResult> StopPlaytimeTrackingForAllItems()

Returns

Promise<StopPlaytimeTrackingResult>

SubmitItemUpdate(UGCUpdateHandle, string) 

public Promise<SubmitItemUpdateResult> SubmitItemUpdate(UGCUpdateHandle handle, string changeNote)

Parameters

handle UGCUpdateHandle
changeNote string

Returns

Promise<SubmitItemUpdateResult>

SubscribeItem(PublishedFileId) 

public Promise<RemoteStorageSubscribePublishedFileResult> SubscribeItem(PublishedFileId publishedFileID)

Parameters

publishedFileID PublishedFileId

Returns

Promise<RemoteStorageSubscribePublishedFileResult>

SuspendDownloads(bool) 

public void SuspendDownloads(bool suspend)

Parameters

suspend bool

UnsubscribeItem(PublishedFileId) 

public Promise<RemoteStorageUnsubscribePublishedFileResult> UnsubscribeItem(PublishedFileId publishedFileID)

Parameters

publishedFileID PublishedFileId

Returns

Promise<RemoteStorageUnsubscribePublishedFileResult>

UpdateItemPreviewFile(UGCUpdateHandle, uint, string) 

public bool UpdateItemPreviewFile(UGCUpdateHandle handle, uint index, string pszPreviewFile)

Parameters

handle UGCUpdateHandle
index uint
pszPreviewFile string

Returns

bool

UpdateItemPreviewVideo(UGCUpdateHandle, uint, string) 

public bool UpdateItemPreviewVideo(UGCUpdateHandle handle, uint index, string pszVideoID)

Parameters

handle UGCUpdateHandle
index uint
pszVideoID string

Returns

bool