Class SteamRemoteStorage

Purpose: Functions for accessing, reading and writing files stored remotely and cached locally

Inheritance

object

SteamRemoteStorage

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Unity.Steamworks.Interop

Assembly: Unity.Steamworks.Interop.dll

Syntax

public static class SteamRemoteStorage

Methods

BeginFileWriteBatch()

Indicate to Steam the beginning / end of a set of local file operations - for example, writing a game save that requires updating two files.

Declaration

public static bool BeginFileWriteBatch()

Returns

Type	Description
bool	The value ISteamRemoteStorage::BeginFileWriteBatch returns.

CommitPublishedFileUpdate(PublishedFileUpdateHandle_t)

Calls the Steamworks ISteamRemoteStorage::CommitPublishedFileUpdate method.

Declaration

public static SteamAPICall_t CommitPublishedFileUpdate(PublishedFileUpdateHandle_t updateHandle)

Parameters

Type	Name	Description
PublishedFileUpdateHandle_t	updateHandle	Passed through to ISteamRemoteStorage::CommitPublishedFileUpdate.

Returns

Type	Description
SteamAPICall_t	The value ISteamRemoteStorage::CommitPublishedFileUpdate returns.

CommitPublishedFileUpdateAsync(PublishedFileUpdateHandle_t)

Async version of CommitPublishedFileUpdate(PublishedFileUpdateHandle_t).

Declaration

public static Task<RemoteStorageUpdatePublishedFileResult_t> CommitPublishedFileUpdateAsync(PublishedFileUpdateHandle_t updateHandle)

Parameters

Type	Name	Description
PublishedFileUpdateHandle_t	updateHandle	Passed through to ISteamRemoteStorage::CommitPublishedFileUpdate.

Returns

Type	Description
Task<RemoteStorageUpdatePublishedFileResult_t>	The RemoteStorageUpdatePublishedFileResult_t Steam reports once the call completes.

CreatePublishedFileUpdateRequest(PublishedFileId_t)

Calls the Steamworks ISteamRemoteStorage::CreatePublishedFileUpdateRequest method.

Declaration

public static PublishedFileUpdateHandle_t CreatePublishedFileUpdateRequest(PublishedFileId_t unPublishedFileId)

Parameters

Type	Name	Description
PublishedFileId_t	unPublishedFileId	Passed through to ISteamRemoteStorage::CreatePublishedFileUpdateRequest.

Returns

Type	Description
PublishedFileUpdateHandle_t	The value ISteamRemoteStorage::CreatePublishedFileUpdateRequest returns.

DeletePublishedFile(PublishedFileId_t)

Calls the Steamworks ISteamRemoteStorage::DeletePublishedFile method.

Declaration

public static SteamAPICall_t DeletePublishedFile(PublishedFileId_t unPublishedFileId)

Parameters

Type	Name	Description
PublishedFileId_t	unPublishedFileId	Passed through to ISteamRemoteStorage::DeletePublishedFile.

Returns

Type	Description
SteamAPICall_t	The value ISteamRemoteStorage::DeletePublishedFile returns.

DeletePublishedFileAsync(PublishedFileId_t)

Async version of DeletePublishedFile(PublishedFileId_t).

Declaration

public static Task<RemoteStorageDeletePublishedFileResult_t> DeletePublishedFileAsync(PublishedFileId_t unPublishedFileId)

Parameters

Type	Name	Description
PublishedFileId_t	unPublishedFileId	Passed through to ISteamRemoteStorage::DeletePublishedFile.

Returns

Type	Description
Task<RemoteStorageDeletePublishedFileResult_t>	The RemoteStorageDeletePublishedFileResult_t Steam reports once the call completes.

EndFileWriteBatch()

Calls the Steamworks ISteamRemoteStorage::EndFileWriteBatch method.

Declaration

public static bool EndFileWriteBatch()

Returns

Type	Description
bool	The value ISteamRemoteStorage::EndFileWriteBatch returns.

EnumeratePublishedFilesByUserAction(EWorkshopFileAction, uint)

Calls the Steamworks ISteamRemoteStorage::EnumeratePublishedFilesByUserAction method.

Declaration

public static SteamAPICall_t EnumeratePublishedFilesByUserAction(EWorkshopFileAction eAction, uint unStartIndex)

Parameters

Type	Name	Description
EWorkshopFileAction	eAction	Passed through to ISteamRemoteStorage::EnumeratePublishedFilesByUserAction.
uint	unStartIndex	Passed through to ISteamRemoteStorage::EnumeratePublishedFilesByUserAction.

Returns

Type	Description
SteamAPICall_t	The value ISteamRemoteStorage::EnumeratePublishedFilesByUserAction returns.

EnumeratePublishedFilesByUserActionAsync(EWorkshopFileAction, uint)

Async version of EnumeratePublishedFilesByUserAction(EWorkshopFileAction, uint).

Declaration

public static Task<RemoteStorageEnumeratePublishedFilesByUserActionResult_t> EnumeratePublishedFilesByUserActionAsync(EWorkshopFileAction eAction, uint unStartIndex)

Parameters

Type	Name	Description
EWorkshopFileAction	eAction	Passed through to ISteamRemoteStorage::EnumeratePublishedFilesByUserAction.
uint	unStartIndex	Passed through to ISteamRemoteStorage::EnumeratePublishedFilesByUserAction.

Returns

Type	Description
Task<RemoteStorageEnumeratePublishedFilesByUserActionResult_t>	The RemoteStorageEnumeratePublishedFilesByUserActionResult_t Steam reports once the call completes.

EnumeratePublishedWorkshopFiles(EWorkshopEnumerationType, uint, uint, uint, IList<string>, IList<string>)

this method enumerates the public view of workshop files

Declaration

public static SteamAPICall_t EnumeratePublishedWorkshopFiles(EWorkshopEnumerationType eEnumerationType, uint unStartIndex, uint unCount, uint unDays, IList<string> pTags, IList<string> pUserTags)

Parameters

Type	Name	Description
EWorkshopEnumerationType	eEnumerationType	Passed through to ISteamRemoteStorage::EnumeratePublishedWorkshopFiles.
uint	unStartIndex	Passed through to ISteamRemoteStorage::EnumeratePublishedWorkshopFiles.
uint	unCount	Passed through to ISteamRemoteStorage::EnumeratePublishedWorkshopFiles.
uint	unDays	Passed through to ISteamRemoteStorage::EnumeratePublishedWorkshopFiles.
IList<string>	pTags	Passed through to ISteamRemoteStorage::EnumeratePublishedWorkshopFiles.
IList<string>	pUserTags	Passed through to ISteamRemoteStorage::EnumeratePublishedWorkshopFiles.

Returns

Type	Description
SteamAPICall_t	The value ISteamRemoteStorage::EnumeratePublishedWorkshopFiles returns.

EnumeratePublishedWorkshopFilesAsync(EWorkshopEnumerationType, uint, uint, uint, IList<string>, IList<string>)

Async version of EnumeratePublishedWorkshopFiles(EWorkshopEnumerationType, uint, uint, uint, IList<string>, IList<string>).

Declaration

public static Task<RemoteStorageEnumerateWorkshopFilesResult_t> EnumeratePublishedWorkshopFilesAsync(EWorkshopEnumerationType eEnumerationType, uint unStartIndex, uint unCount, uint unDays, IList<string> pTags, IList<string> pUserTags)

Parameters

Type	Name	Description
EWorkshopEnumerationType	eEnumerationType	Passed through to ISteamRemoteStorage::EnumeratePublishedWorkshopFiles.
uint	unStartIndex	Passed through to ISteamRemoteStorage::EnumeratePublishedWorkshopFiles.
uint	unCount	Passed through to ISteamRemoteStorage::EnumeratePublishedWorkshopFiles.
uint	unDays	Passed through to ISteamRemoteStorage::EnumeratePublishedWorkshopFiles.
IList<string>	pTags	Passed through to ISteamRemoteStorage::EnumeratePublishedWorkshopFiles.
IList<string>	pUserTags	Passed through to ISteamRemoteStorage::EnumeratePublishedWorkshopFiles.

Returns

Type	Description
Task<RemoteStorageEnumerateWorkshopFilesResult_t>	The RemoteStorageEnumerateWorkshopFilesResult_t Steam reports once the call completes.

EnumerateUserPublishedFiles(uint)

enumerate the files that the current user published with this app

Declaration

public static SteamAPICall_t EnumerateUserPublishedFiles(uint unStartIndex)

Parameters

Type	Name	Description
uint	unStartIndex	Passed through to ISteamRemoteStorage::EnumerateUserPublishedFiles.

Returns

Type	Description
SteamAPICall_t	The value ISteamRemoteStorage::EnumerateUserPublishedFiles returns.

EnumerateUserPublishedFilesAsync(uint)

Async version of EnumerateUserPublishedFiles(uint).

Declaration

public static Task<RemoteStorageEnumerateUserPublishedFilesResult_t> EnumerateUserPublishedFilesAsync(uint unStartIndex)

Parameters

Type	Name	Description
uint	unStartIndex	Passed through to ISteamRemoteStorage::EnumerateUserPublishedFiles.

Returns

Type	Description
Task<RemoteStorageEnumerateUserPublishedFilesResult_t>	The RemoteStorageEnumerateUserPublishedFilesResult_t Steam reports once the call completes.

EnumerateUserSharedWorkshopFiles(CSteamID, uint, IList<string>, IList<string>)

Calls the Steamworks ISteamRemoteStorage::EnumerateUserSharedWorkshopFiles method.

Declaration

public static SteamAPICall_t EnumerateUserSharedWorkshopFiles(CSteamID steamId, uint unStartIndex, IList<string> pRequiredTags, IList<string> pExcludedTags)

Parameters

Type	Name	Description
CSteamID	steamId	Passed through to ISteamRemoteStorage::EnumerateUserSharedWorkshopFiles.
uint	unStartIndex	Passed through to ISteamRemoteStorage::EnumerateUserSharedWorkshopFiles.
IList<string>	pRequiredTags	Passed through to ISteamRemoteStorage::EnumerateUserSharedWorkshopFiles.
IList<string>	pExcludedTags	Passed through to ISteamRemoteStorage::EnumerateUserSharedWorkshopFiles.

Returns

Type	Description
SteamAPICall_t	The value ISteamRemoteStorage::EnumerateUserSharedWorkshopFiles returns.

EnumerateUserSharedWorkshopFilesAsync(CSteamID, uint, IList<string>, IList<string>)

Async version of EnumerateUserSharedWorkshopFiles(CSteamID, uint, IList<string>, IList<string>).

Declaration

public static Task<RemoteStorageEnumerateUserPublishedFilesResult_t> EnumerateUserSharedWorkshopFilesAsync(CSteamID steamId, uint unStartIndex, IList<string> pRequiredTags, IList<string> pExcludedTags)

Parameters

Type	Name	Description
CSteamID	steamId	Passed through to ISteamRemoteStorage::EnumerateUserSharedWorkshopFiles.
uint	unStartIndex	Passed through to ISteamRemoteStorage::EnumerateUserSharedWorkshopFiles.
IList<string>	pRequiredTags	Passed through to ISteamRemoteStorage::EnumerateUserSharedWorkshopFiles.
IList<string>	pExcludedTags	Passed through to ISteamRemoteStorage::EnumerateUserSharedWorkshopFiles.

Returns

Type	Description
Task<RemoteStorageEnumerateUserPublishedFilesResult_t>	The RemoteStorageEnumerateUserPublishedFilesResult_t Steam reports once the call completes.

EnumerateUserSubscribedFiles(uint)

Calls the Steamworks ISteamRemoteStorage::EnumerateUserSubscribedFiles method.

Declaration

public static SteamAPICall_t EnumerateUserSubscribedFiles(uint unStartIndex)

Parameters

Type	Name	Description
uint	unStartIndex	Passed through to ISteamRemoteStorage::EnumerateUserSubscribedFiles.

Returns

Type	Description
SteamAPICall_t	The value ISteamRemoteStorage::EnumerateUserSubscribedFiles returns.

EnumerateUserSubscribedFilesAsync(uint)

Async version of EnumerateUserSubscribedFiles(uint).

Declaration

public static Task<RemoteStorageEnumerateUserSubscribedFilesResult_t> EnumerateUserSubscribedFilesAsync(uint unStartIndex)

Parameters

Type	Name	Description
uint	unStartIndex	Passed through to ISteamRemoteStorage::EnumerateUserSubscribedFiles.

Returns

Type	Description
Task<RemoteStorageEnumerateUserSubscribedFilesResult_t>	The RemoteStorageEnumerateUserSubscribedFilesResult_t Steam reports once the call completes.

FileDelete(string)

Calls the Steamworks ISteamRemoteStorage::FileDelete method.

Declaration

public static bool FileDelete(string pchFile)

Parameters

Type	Name	Description
string	pchFile	Passed through to ISteamRemoteStorage::FileDelete.

Returns

Type	Description
bool	The value ISteamRemoteStorage::FileDelete returns.

FileExists(string)

file information

Declaration

public static bool FileExists(string pchFile)

Parameters

Type	Name	Description
string	pchFile	Passed through to ISteamRemoteStorage::FileExists.

Returns

Type	Description
bool	The value ISteamRemoteStorage::FileExists returns.

FileForget(string)

Calls the Steamworks ISteamRemoteStorage::FileForget method.

Declaration

public static bool FileForget(string pchFile)

Parameters

Type	Name	Description
string	pchFile	Passed through to ISteamRemoteStorage::FileForget.

Returns

Type	Description
bool	The value ISteamRemoteStorage::FileForget returns.

FilePersisted(string)

Calls the Steamworks ISteamRemoteStorage::FilePersisted method.

Declaration

public static bool FilePersisted(string pchFile)

Parameters

Type	Name	Description
string	pchFile	Passed through to ISteamRemoteStorage::FilePersisted.

Returns

Type	Description
bool	The value ISteamRemoteStorage::FilePersisted returns.

FileRead(string, byte[], int)

Calls the Steamworks ISteamRemoteStorage::FileRead method.

Declaration

public static int FileRead(string pchFile, byte[] pvData, int cubDataToRead)

Parameters

Type	Name	Description
string	pchFile	Passed through to ISteamRemoteStorage::FileRead.
byte[]	pvData	Passed through to ISteamRemoteStorage::FileRead.
int	cubDataToRead	Passed through to ISteamRemoteStorage::FileRead.

Returns

Type	Description
int	The value ISteamRemoteStorage::FileRead returns.

FileReadAsync(string, uint, uint)

Calls the Steamworks ISteamRemoteStorage::FileReadAsync method.

Declaration

public static SteamAPICall_t FileReadAsync(string pchFile, uint nOffset, uint cubToRead)

Parameters

Type	Name	Description
string	pchFile	Passed through to ISteamRemoteStorage::FileReadAsync.
uint	nOffset	Passed through to ISteamRemoteStorage::FileReadAsync.
uint	cubToRead	Passed through to ISteamRemoteStorage::FileReadAsync.

Returns

Type	Description
SteamAPICall_t	The value ISteamRemoteStorage::FileReadAsync returns.

FileReadAsyncComplete(SteamAPICall_t, byte[], uint)

Calls the Steamworks ISteamRemoteStorage::FileReadAsyncComplete method.

Declaration

public static bool FileReadAsyncComplete(SteamAPICall_t hReadCall, byte[] pvBuffer, uint cubToRead)

Parameters

Type	Name	Description
SteamAPICall_t	hReadCall	Passed through to ISteamRemoteStorage::FileReadAsyncComplete.
byte[]	pvBuffer	Passed through to ISteamRemoteStorage::FileReadAsyncComplete.
uint	cubToRead	Passed through to ISteamRemoteStorage::FileReadAsyncComplete.

Returns

Type	Description
bool	The value ISteamRemoteStorage::FileReadAsyncComplete returns.

FileReadAsyncTask(string, uint, uint)

Async version of FileReadAsync(string, uint, uint).

Declaration

public static Task<RemoteStorageFileReadAsyncComplete_t> FileReadAsyncTask(string pchFile, uint nOffset, uint cubToRead)

Parameters

Type	Name	Description
string	pchFile	Passed through to ISteamRemoteStorage::FileReadAsync.
uint	nOffset	Passed through to ISteamRemoteStorage::FileReadAsync.
uint	cubToRead	Passed through to ISteamRemoteStorage::FileReadAsync.

Returns

Type	Description
Task<RemoteStorageFileReadAsyncComplete_t>	The RemoteStorageFileReadAsyncComplete_t Steam reports once the call completes.

FileShare(string)

Calls the Steamworks ISteamRemoteStorage::FileShare method.

Declaration

public static SteamAPICall_t FileShare(string pchFile)

Parameters

Type	Name	Description
string	pchFile	Passed through to ISteamRemoteStorage::FileShare.

Returns

Type	Description
SteamAPICall_t	The value ISteamRemoteStorage::FileShare returns.

FileShareAsync(string)

Async version of FileShare(string).

Declaration

public static Task<RemoteStorageFileShareResult_t> FileShareAsync(string pchFile)

Parameters

Type	Name	Description
string	pchFile	Passed through to ISteamRemoteStorage::FileShare.

Returns

Type	Description
Task<RemoteStorageFileShareResult_t>	The RemoteStorageFileShareResult_t Steam reports once the call completes.

FileWrite(string, byte[], int)

NOTE Filenames are case-insensitive, and will be converted to lowercase automatically. So "foo.bar" and "Foo.bar" are the same file, and if you write "Foo.bar" then iterate the files, the filename returned will be "foo.bar". file operations

Declaration

public static bool FileWrite(string pchFile, byte[] pvData, int cubData)

Parameters

Type	Name	Description
string	pchFile	Passed through to ISteamRemoteStorage::FileWrite.
byte[]	pvData	Passed through to ISteamRemoteStorage::FileWrite.
int	cubData	Passed through to ISteamRemoteStorage::FileWrite.

Returns

Type	Description
bool	The value ISteamRemoteStorage::FileWrite returns.

FileWriteAsync(string, byte[], uint)

Calls the Steamworks ISteamRemoteStorage::FileWriteAsync method.

Declaration

public static SteamAPICall_t FileWriteAsync(string pchFile, byte[] pvData, uint cubData)

Parameters

Type	Name	Description
string	pchFile	Passed through to ISteamRemoteStorage::FileWriteAsync.
byte[]	pvData	Passed through to ISteamRemoteStorage::FileWriteAsync.
uint	cubData	Passed through to ISteamRemoteStorage::FileWriteAsync.

Returns

Type	Description
SteamAPICall_t	The value ISteamRemoteStorage::FileWriteAsync returns.

FileWriteAsyncTask(string, byte[], uint)

Async version of FileWriteAsync(string, byte[], uint).

Declaration

public static Task<RemoteStorageFileWriteAsyncComplete_t> FileWriteAsyncTask(string pchFile, byte[] pvData, uint cubData)

Parameters

Type	Name	Description
string	pchFile	Passed through to ISteamRemoteStorage::FileWriteAsync.
byte[]	pvData	Passed through to ISteamRemoteStorage::FileWriteAsync.
uint	cubData	Passed through to ISteamRemoteStorage::FileWriteAsync.

Returns

Type	Description
Task<RemoteStorageFileWriteAsyncComplete_t>	The RemoteStorageFileWriteAsyncComplete_t Steam reports once the call completes.

FileWriteStreamCancel(UGCFileWriteStreamHandle_t)

Calls the Steamworks ISteamRemoteStorage::FileWriteStreamCancel method.

Declaration

public static bool FileWriteStreamCancel(UGCFileWriteStreamHandle_t writeHandle)

Parameters

Type	Name	Description
UGCFileWriteStreamHandle_t	writeHandle	Passed through to ISteamRemoteStorage::FileWriteStreamCancel.

Returns

Type	Description
bool	The value ISteamRemoteStorage::FileWriteStreamCancel returns.

FileWriteStreamClose(UGCFileWriteStreamHandle_t)

Calls the Steamworks ISteamRemoteStorage::FileWriteStreamClose method.

Declaration

public static bool FileWriteStreamClose(UGCFileWriteStreamHandle_t writeHandle)

Parameters

Type	Name	Description
UGCFileWriteStreamHandle_t	writeHandle	Passed through to ISteamRemoteStorage::FileWriteStreamClose.

Returns

Type	Description
bool	The value ISteamRemoteStorage::FileWriteStreamClose returns.

FileWriteStreamOpen(string)

file operations that cause network IO

Declaration

public static UGCFileWriteStreamHandle_t FileWriteStreamOpen(string pchFile)

Parameters

Type	Name	Description
string	pchFile	Passed through to ISteamRemoteStorage::FileWriteStreamOpen.

Returns

Type	Description
UGCFileWriteStreamHandle_t	The value ISteamRemoteStorage::FileWriteStreamOpen returns.

FileWriteStreamWriteChunk(UGCFileWriteStreamHandle_t, byte[], int)

Calls the Steamworks ISteamRemoteStorage::FileWriteStreamWriteChunk method.

Declaration

public static bool FileWriteStreamWriteChunk(UGCFileWriteStreamHandle_t writeHandle, byte[] pvData, int cubData)

Parameters

Type	Name	Description
UGCFileWriteStreamHandle_t	writeHandle	Passed through to ISteamRemoteStorage::FileWriteStreamWriteChunk.
byte[]	pvData	Passed through to ISteamRemoteStorage::FileWriteStreamWriteChunk.
int	cubData	Passed through to ISteamRemoteStorage::FileWriteStreamWriteChunk.

Returns

Type	Description
bool	The value ISteamRemoteStorage::FileWriteStreamWriteChunk returns.

GetCachedUGCCount()

Functions to iterate through UGC that has finished downloading but has not yet been read via UGCRead()

Declaration

public static int GetCachedUGCCount()

Returns

Type	Description
int	The value ISteamRemoteStorage::GetCachedUGCCount returns.

GetCachedUGCHandle(int)

Calls the Steamworks ISteamRemoteStorage::GetCachedUGCHandle method.

Declaration

public static UGCHandle_t GetCachedUGCHandle(int iCachedContent)

Parameters

Type	Name	Description
int	iCachedContent	Passed through to ISteamRemoteStorage::GetCachedUGCHandle.

Returns

Type	Description
UGCHandle_t	The value ISteamRemoteStorage::GetCachedUGCHandle returns.

GetFileCount()

iteration

Declaration

public static int GetFileCount()

Returns

Type	Description
int	The value ISteamRemoteStorage::GetFileCount returns.

GetFileNameAndSize(int, out int)

Calls the Steamworks ISteamRemoteStorage::GetFileNameAndSize method.

Declaration

public static string GetFileNameAndSize(int iFile, out int pnFileSizeInBytes)

Parameters

Type	Name	Description
int	iFile	Passed through to ISteamRemoteStorage::GetFileNameAndSize.
int	pnFileSizeInBytes	Passed through to ISteamRemoteStorage::GetFileNameAndSize.

Returns

Type	Description
string	The value ISteamRemoteStorage::GetFileNameAndSize returns.

GetFileSize(string)

Calls the Steamworks ISteamRemoteStorage::GetFileSize method.

Declaration

public static int GetFileSize(string pchFile)

Parameters

Type	Name	Description
string	pchFile	Passed through to ISteamRemoteStorage::GetFileSize.

Returns

Type	Description
int	The value ISteamRemoteStorage::GetFileSize returns.

GetFileTimestamp(string)

Calls the Steamworks ISteamRemoteStorage::GetFileTimestamp method.

Declaration

public static long GetFileTimestamp(string pchFile)

Parameters

Type	Name	Description
string	pchFile	Passed through to ISteamRemoteStorage::GetFileTimestamp.

Returns

Type	Description
long	The value ISteamRemoteStorage::GetFileTimestamp returns.

GetLocalFileChange(int, out ERemoteStorageLocalFileChange, out ERemoteStorageFilePathType)

Calls the Steamworks ISteamRemoteStorage::GetLocalFileChange method.

Declaration

public static string GetLocalFileChange(int iFile, out ERemoteStorageLocalFileChange pEChangeType, out ERemoteStorageFilePathType pEFilePathType)

Parameters

Type	Name	Description
int	iFile	Passed through to ISteamRemoteStorage::GetLocalFileChange.
ERemoteStorageLocalFileChange	pEChangeType	Passed through to ISteamRemoteStorage::GetLocalFileChange.
ERemoteStorageFilePathType	pEFilePathType	Passed through to ISteamRemoteStorage::GetLocalFileChange.

Returns

Type	Description
string	The value ISteamRemoteStorage::GetLocalFileChange returns.

GetLocalFileChangeCount()

Cloud dynamic state change notification

Declaration

public static int GetLocalFileChangeCount()

Returns

Type	Description
int	The value ISteamRemoteStorage::GetLocalFileChangeCount returns.

GetPublishedFileDetails(PublishedFileId_t, uint)

Gets published file details for the given publishedfileid. If unMaxSecondsOld is greater than 0, cached data may be returned, depending on how long ago it was cached. A value of 0 will force a refresh. A value of k_WorkshopForceLoadPublishedFileDetailsFromCache will use cached data if it exists, no matter how old it is.

Declaration

public static SteamAPICall_t GetPublishedFileDetails(PublishedFileId_t unPublishedFileId, uint unMaxSecondsOld)

Parameters

Type	Name	Description
PublishedFileId_t	unPublishedFileId	Passed through to ISteamRemoteStorage::GetPublishedFileDetails.
uint	unMaxSecondsOld	Passed through to ISteamRemoteStorage::GetPublishedFileDetails.

Returns

Type	Description
SteamAPICall_t	The value ISteamRemoteStorage::GetPublishedFileDetails returns.

GetPublishedFileDetailsAsync(PublishedFileId_t, uint)

Async version of GetPublishedFileDetails(PublishedFileId_t, uint).

Declaration

public static Task<RemoteStorageGetPublishedFileDetailsResult_t> GetPublishedFileDetailsAsync(PublishedFileId_t unPublishedFileId, uint unMaxSecondsOld)

Parameters

Type	Name	Description
PublishedFileId_t	unPublishedFileId	Passed through to ISteamRemoteStorage::GetPublishedFileDetails.
uint	unMaxSecondsOld	Passed through to ISteamRemoteStorage::GetPublishedFileDetails.

Returns

Type	Description
Task<RemoteStorageGetPublishedFileDetailsResult_t>	The RemoteStorageGetPublishedFileDetailsResult_t Steam reports once the call completes.

GetPublishedItemVoteDetails(PublishedFileId_t)

Calls the Steamworks ISteamRemoteStorage::GetPublishedItemVoteDetails method.

Declaration

public static SteamAPICall_t GetPublishedItemVoteDetails(PublishedFileId_t unPublishedFileId)

Parameters

Type	Name	Description
PublishedFileId_t	unPublishedFileId	Passed through to ISteamRemoteStorage::GetPublishedItemVoteDetails.

Returns

Type	Description
SteamAPICall_t	The value ISteamRemoteStorage::GetPublishedItemVoteDetails returns.

GetPublishedItemVoteDetailsAsync(PublishedFileId_t)

Async version of GetPublishedItemVoteDetails(PublishedFileId_t).

Declaration

public static Task<RemoteStorageGetPublishedItemVoteDetailsResult_t> GetPublishedItemVoteDetailsAsync(PublishedFileId_t unPublishedFileId)

Parameters

Type	Name	Description
PublishedFileId_t	unPublishedFileId	Passed through to ISteamRemoteStorage::GetPublishedItemVoteDetails.

Returns

Type	Description
Task<RemoteStorageGetPublishedItemVoteDetailsResult_t>	The RemoteStorageGetPublishedItemVoteDetailsResult_t Steam reports once the call completes.

GetQuota(out ulong, out ulong)

configuration management

Declaration

public static bool GetQuota(out ulong pnTotalBytes, out ulong puAvailableBytes)

Parameters

Type	Name	Description
ulong	pnTotalBytes	Passed through to ISteamRemoteStorage::GetQuota.
ulong	puAvailableBytes	Passed through to ISteamRemoteStorage::GetQuota.

Returns

Type	Description
bool	The value ISteamRemoteStorage::GetQuota returns.

GetSyncPlatforms(string)

Calls the Steamworks ISteamRemoteStorage::GetSyncPlatforms method.

Declaration

public static ERemoteStoragePlatform GetSyncPlatforms(string pchFile)

Parameters

Type	Name	Description
string	pchFile	Passed through to ISteamRemoteStorage::GetSyncPlatforms.

Returns

Type	Description
ERemoteStoragePlatform	The value ISteamRemoteStorage::GetSyncPlatforms returns.

GetUGCDetails(UGCHandle_t, out AppId_t, out string, out int, out CSteamID)

Gets metadata for a file after it has been downloaded. This is the same metadata given in the RemoteStorageDownloadUGCResult_t call result

Declaration

public static bool GetUGCDetails(UGCHandle_t hContent, out AppId_t pnAppID, out string ppchName, out int pnFileSizeInBytes, out CSteamID pSteamIDOwner)

Parameters

Type	Name	Description
UGCHandle_t	hContent	Passed through to ISteamRemoteStorage::GetUGCDetails.
AppId_t	pnAppID	Passed through to ISteamRemoteStorage::GetUGCDetails.
string	ppchName	Receives the string ISteamRemoteStorage::GetUGCDetails writes.
int	pnFileSizeInBytes	Passed through to ISteamRemoteStorage::GetUGCDetails.
CSteamID	pSteamIDOwner	Passed through to ISteamRemoteStorage::GetUGCDetails.

Returns

Type	Description
bool	The value ISteamRemoteStorage::GetUGCDetails returns.

GetUGCDownloadProgress(UGCHandle_t, out int, out int)

Gets the amount of data downloaded so far for a piece of content. pnBytesExpected can be 0 if function returns false or if the transfer hasn't started yet, so be careful to check for that before dividing to get a percentage

Declaration

public static bool GetUGCDownloadProgress(UGCHandle_t hContent, out int pnBytesDownloaded, out int pnBytesExpected)

Parameters

Type	Name	Description
UGCHandle_t	hContent	Passed through to ISteamRemoteStorage::GetUGCDownloadProgress.
int	pnBytesDownloaded	Passed through to ISteamRemoteStorage::GetUGCDownloadProgress.
int	pnBytesExpected	Passed through to ISteamRemoteStorage::GetUGCDownloadProgress.

Returns

Type	Description
bool	The value ISteamRemoteStorage::GetUGCDownloadProgress returns.

GetUserPublishedItemVoteDetails(PublishedFileId_t)

Calls the Steamworks ISteamRemoteStorage::GetUserPublishedItemVoteDetails method.

Declaration

public static SteamAPICall_t GetUserPublishedItemVoteDetails(PublishedFileId_t unPublishedFileId)

Parameters

Type	Name	Description
PublishedFileId_t	unPublishedFileId	Passed through to ISteamRemoteStorage::GetUserPublishedItemVoteDetails.

Returns

Type	Description
SteamAPICall_t	The value ISteamRemoteStorage::GetUserPublishedItemVoteDetails returns.

GetUserPublishedItemVoteDetailsAsync(PublishedFileId_t)

Async version of GetUserPublishedItemVoteDetails(PublishedFileId_t).

Declaration

public static Task<RemoteStorageGetPublishedItemVoteDetailsResult_t> GetUserPublishedItemVoteDetailsAsync(PublishedFileId_t unPublishedFileId)

Parameters

Type	Name	Description
PublishedFileId_t	unPublishedFileId	Passed through to ISteamRemoteStorage::GetUserPublishedItemVoteDetails.

Returns

Type	Description
Task<RemoteStorageGetPublishedItemVoteDetailsResult_t>	The RemoteStorageGetPublishedItemVoteDetailsResult_t Steam reports once the call completes.

IsCloudEnabledForAccount()

Calls the Steamworks ISteamRemoteStorage::IsCloudEnabledForAccount method.

Declaration

public static bool IsCloudEnabledForAccount()

Returns

Type	Description
bool	The value ISteamRemoteStorage::IsCloudEnabledForAccount returns.

IsCloudEnabledForApp()

Calls the Steamworks ISteamRemoteStorage::IsCloudEnabledForApp method.

Declaration

public static bool IsCloudEnabledForApp()

Returns

Type	Description
bool	The value ISteamRemoteStorage::IsCloudEnabledForApp returns.

PublishVideo(EWorkshopVideoProvider, string, string, string, AppId_t, string, string, ERemoteStoragePublishedFileVisibility, IList<string>)

Calls the Steamworks ISteamRemoteStorage::PublishVideo method.

Declaration

public static SteamAPICall_t PublishVideo(EWorkshopVideoProvider eVideoProvider, string pchVideoAccount, string pchVideoIdentifier, string pchPreviewFile, AppId_t nConsumerAppId, string pchTitle, string pchDescription, ERemoteStoragePublishedFileVisibility eVisibility, IList<string> pTags)

Parameters

Type	Name	Description
EWorkshopVideoProvider	eVideoProvider	Passed through to ISteamRemoteStorage::PublishVideo.
string	pchVideoAccount	Passed through to ISteamRemoteStorage::PublishVideo.
string	pchVideoIdentifier	Passed through to ISteamRemoteStorage::PublishVideo.
string	pchPreviewFile	Passed through to ISteamRemoteStorage::PublishVideo.
AppId_t	nConsumerAppId	Passed through to ISteamRemoteStorage::PublishVideo.
string	pchTitle	Passed through to ISteamRemoteStorage::PublishVideo.
string	pchDescription	Passed through to ISteamRemoteStorage::PublishVideo.
ERemoteStoragePublishedFileVisibility	eVisibility	Passed through to ISteamRemoteStorage::PublishVideo.
IList<string>	pTags	Passed through to ISteamRemoteStorage::PublishVideo.

Returns

Type	Description
SteamAPICall_t	The value ISteamRemoteStorage::PublishVideo returns.

PublishVideoAsync(EWorkshopVideoProvider, string, string, string, AppId_t, string, string, ERemoteStoragePublishedFileVisibility, IList<string>)

Async version of PublishVideo(EWorkshopVideoProvider, string, string, string, AppId_t, string, string, ERemoteStoragePublishedFileVisibility, IList<string>).

Declaration

public static Task<RemoteStoragePublishFileProgress_t> PublishVideoAsync(EWorkshopVideoProvider eVideoProvider, string pchVideoAccount, string pchVideoIdentifier, string pchPreviewFile, AppId_t nConsumerAppId, string pchTitle, string pchDescription, ERemoteStoragePublishedFileVisibility eVisibility, IList<string> pTags)

Parameters

Type	Name	Description
EWorkshopVideoProvider	eVideoProvider	Passed through to ISteamRemoteStorage::PublishVideo.
string	pchVideoAccount	Passed through to ISteamRemoteStorage::PublishVideo.
string	pchVideoIdentifier	Passed through to ISteamRemoteStorage::PublishVideo.
string	pchPreviewFile	Passed through to ISteamRemoteStorage::PublishVideo.
AppId_t	nConsumerAppId	Passed through to ISteamRemoteStorage::PublishVideo.
string	pchTitle	Passed through to ISteamRemoteStorage::PublishVideo.
string	pchDescription	Passed through to ISteamRemoteStorage::PublishVideo.
ERemoteStoragePublishedFileVisibility	eVisibility	Passed through to ISteamRemoteStorage::PublishVideo.
IList<string>	pTags	Passed through to ISteamRemoteStorage::PublishVideo.

Returns

Type	Description
Task<RemoteStoragePublishFileProgress_t>	The RemoteStoragePublishFileProgress_t Steam reports once the call completes.

PublishWorkshopFile(string, string, AppId_t, string, string, ERemoteStoragePublishedFileVisibility, IList<string>, EWorkshopFileType)

publishing UGC

Declaration

public static SteamAPICall_t PublishWorkshopFile(string pchFile, string pchPreviewFile, AppId_t nConsumerAppId, string pchTitle, string pchDescription, ERemoteStoragePublishedFileVisibility eVisibility, IList<string> pTags, EWorkshopFileType eWorkshopFileType)

Parameters

Type	Name	Description
string	pchFile	Passed through to ISteamRemoteStorage::PublishWorkshopFile.
string	pchPreviewFile	Passed through to ISteamRemoteStorage::PublishWorkshopFile.
AppId_t	nConsumerAppId	Passed through to ISteamRemoteStorage::PublishWorkshopFile.
string	pchTitle	Passed through to ISteamRemoteStorage::PublishWorkshopFile.
string	pchDescription	Passed through to ISteamRemoteStorage::PublishWorkshopFile.
ERemoteStoragePublishedFileVisibility	eVisibility	Passed through to ISteamRemoteStorage::PublishWorkshopFile.
IList<string>	pTags	Passed through to ISteamRemoteStorage::PublishWorkshopFile.
EWorkshopFileType	eWorkshopFileType	Passed through to ISteamRemoteStorage::PublishWorkshopFile.

Returns

Type	Description
SteamAPICall_t	The value ISteamRemoteStorage::PublishWorkshopFile returns.

PublishWorkshopFileAsync(string, string, AppId_t, string, string, ERemoteStoragePublishedFileVisibility, IList<string>, EWorkshopFileType)

Async version of PublishWorkshopFile(string, string, AppId_t, string, string, ERemoteStoragePublishedFileVisibility, IList<string>, EWorkshopFileType).

Declaration

public static Task<RemoteStoragePublishFileProgress_t> PublishWorkshopFileAsync(string pchFile, string pchPreviewFile, AppId_t nConsumerAppId, string pchTitle, string pchDescription, ERemoteStoragePublishedFileVisibility eVisibility, IList<string> pTags, EWorkshopFileType eWorkshopFileType)

Parameters

Type	Name	Description
string	pchFile	Passed through to ISteamRemoteStorage::PublishWorkshopFile.
string	pchPreviewFile	Passed through to ISteamRemoteStorage::PublishWorkshopFile.
AppId_t	nConsumerAppId	Passed through to ISteamRemoteStorage::PublishWorkshopFile.
string	pchTitle	Passed through to ISteamRemoteStorage::PublishWorkshopFile.
string	pchDescription	Passed through to ISteamRemoteStorage::PublishWorkshopFile.
ERemoteStoragePublishedFileVisibility	eVisibility	Passed through to ISteamRemoteStorage::PublishWorkshopFile.
IList<string>	pTags	Passed through to ISteamRemoteStorage::PublishWorkshopFile.
EWorkshopFileType	eWorkshopFileType	Passed through to ISteamRemoteStorage::PublishWorkshopFile.

Returns

Type	Description
Task<RemoteStoragePublishFileProgress_t>	The RemoteStoragePublishFileProgress_t Steam reports once the call completes.

SetCloudEnabledForApp(bool)

Calls the Steamworks ISteamRemoteStorage::SetCloudEnabledForApp method.

Declaration

public static void SetCloudEnabledForApp(bool bEnabled)

Parameters

Type	Name	Description
bool	bEnabled	Passed through to ISteamRemoteStorage::SetCloudEnabledForApp.

SetSyncPlatforms(string, ERemoteStoragePlatform)

Calls the Steamworks ISteamRemoteStorage::SetSyncPlatforms method.

Declaration

public static bool SetSyncPlatforms(string pchFile, ERemoteStoragePlatform eRemoteStoragePlatform)

Parameters

Type	Name	Description
string	pchFile	Passed through to ISteamRemoteStorage::SetSyncPlatforms.
ERemoteStoragePlatform	eRemoteStoragePlatform	Passed through to ISteamRemoteStorage::SetSyncPlatforms.

Returns

Type	Description
bool	The value ISteamRemoteStorage::SetSyncPlatforms returns.

SetUserPublishedFileAction(PublishedFileId_t, EWorkshopFileAction)

Calls the Steamworks ISteamRemoteStorage::SetUserPublishedFileAction method.

Declaration

public static SteamAPICall_t SetUserPublishedFileAction(PublishedFileId_t unPublishedFileId, EWorkshopFileAction eAction)

Parameters

Type	Name	Description
PublishedFileId_t	unPublishedFileId	Passed through to ISteamRemoteStorage::SetUserPublishedFileAction.
EWorkshopFileAction	eAction	Passed through to ISteamRemoteStorage::SetUserPublishedFileAction.

Returns

Type	Description
SteamAPICall_t	The value ISteamRemoteStorage::SetUserPublishedFileAction returns.

SetUserPublishedFileActionAsync(PublishedFileId_t, EWorkshopFileAction)

Async version of SetUserPublishedFileAction(PublishedFileId_t, EWorkshopFileAction).

Declaration

public static Task<RemoteStorageSetUserPublishedFileActionResult_t> SetUserPublishedFileActionAsync(PublishedFileId_t unPublishedFileId, EWorkshopFileAction eAction)

Parameters

Type	Name	Description
PublishedFileId_t	unPublishedFileId	Passed through to ISteamRemoteStorage::SetUserPublishedFileAction.
EWorkshopFileAction	eAction	Passed through to ISteamRemoteStorage::SetUserPublishedFileAction.

Returns

Type	Description
Task<RemoteStorageSetUserPublishedFileActionResult_t>	The RemoteStorageSetUserPublishedFileActionResult_t Steam reports once the call completes.

SubscribePublishedFile(PublishedFileId_t)

Calls the Steamworks ISteamRemoteStorage::SubscribePublishedFile method.

Declaration

public static SteamAPICall_t SubscribePublishedFile(PublishedFileId_t unPublishedFileId)

Parameters

Type	Name	Description
PublishedFileId_t	unPublishedFileId	Passed through to ISteamRemoteStorage::SubscribePublishedFile.

Returns

Type	Description
SteamAPICall_t	The value ISteamRemoteStorage::SubscribePublishedFile returns.

SubscribePublishedFileAsync(PublishedFileId_t)

Async version of SubscribePublishedFile(PublishedFileId_t).

Declaration

public static Task<RemoteStorageSubscribePublishedFileResult_t> SubscribePublishedFileAsync(PublishedFileId_t unPublishedFileId)

Parameters

Type	Name	Description
PublishedFileId_t	unPublishedFileId	Passed through to ISteamRemoteStorage::SubscribePublishedFile.

Returns

Type	Description
Task<RemoteStorageSubscribePublishedFileResult_t>	The RemoteStorageSubscribePublishedFileResult_t Steam reports once the call completes.

UGCDownload(UGCHandle_t, uint)

user generated content Downloads a UGC file. A priority value of 0 will download the file immediately, otherwise it will wait to download the file until all downloads with a lower priority value are completed. Downloads with equal priority will occur simultaneously.

Declaration

public static SteamAPICall_t UGCDownload(UGCHandle_t hContent, uint unPriority)

Parameters

Type	Name	Description
UGCHandle_t	hContent	Passed through to ISteamRemoteStorage::UGCDownload.
uint	unPriority	Passed through to ISteamRemoteStorage::UGCDownload.

Returns

Type	Description
SteamAPICall_t	The value ISteamRemoteStorage::UGCDownload returns.

UGCDownloadAsync(UGCHandle_t, uint)

Async version of UGCDownload(UGCHandle_t, uint).

Declaration

public static Task<RemoteStorageDownloadUGCResult_t> UGCDownloadAsync(UGCHandle_t hContent, uint unPriority)

Parameters

Type	Name	Description
UGCHandle_t	hContent	Passed through to ISteamRemoteStorage::UGCDownload.
uint	unPriority	Passed through to ISteamRemoteStorage::UGCDownload.

Returns

Type	Description
Task<RemoteStorageDownloadUGCResult_t>	The RemoteStorageDownloadUGCResult_t Steam reports once the call completes.

UGCDownloadToLocation(UGCHandle_t, string, uint)

Calls the Steamworks ISteamRemoteStorage::UGCDownloadToLocation method.

Declaration

public static SteamAPICall_t UGCDownloadToLocation(UGCHandle_t hContent, string pchLocation, uint unPriority)

Parameters

Type	Name	Description
UGCHandle_t	hContent	Passed through to ISteamRemoteStorage::UGCDownloadToLocation.
string	pchLocation	Passed through to ISteamRemoteStorage::UGCDownloadToLocation.
uint	unPriority	Passed through to ISteamRemoteStorage::UGCDownloadToLocation.

Returns

Type	Description
SteamAPICall_t	The value ISteamRemoteStorage::UGCDownloadToLocation returns.

UGCDownloadToLocationAsync(UGCHandle_t, string, uint)

Async version of UGCDownloadToLocation(UGCHandle_t, string, uint).

Declaration

public static Task<RemoteStorageDownloadUGCResult_t> UGCDownloadToLocationAsync(UGCHandle_t hContent, string pchLocation, uint unPriority)

Parameters

Type	Name	Description
UGCHandle_t	hContent	Passed through to ISteamRemoteStorage::UGCDownloadToLocation.
string	pchLocation	Passed through to ISteamRemoteStorage::UGCDownloadToLocation.
uint	unPriority	Passed through to ISteamRemoteStorage::UGCDownloadToLocation.

Returns

Type	Description
Task<RemoteStorageDownloadUGCResult_t>	The RemoteStorageDownloadUGCResult_t Steam reports once the call completes.

UGCRead(UGCHandle_t, byte[], int, uint, EUGCReadAction)

After download, gets the content of the file. Small files can be read all at once by calling this function with an offset of 0 and cubDataToRead equal to the size of the file. Larger files can be read in chunks to reduce memory usage (since both sides of the IPC client and the game itself must allocate enough memory for each chunk). Once the last byte is read, the file is implicitly closed and further calls to UGCRead will fail unless UGCDownload is called again. For especially large files (anything over 100MB) it is a requirement that the file is read in chunks.

Declaration

public static int UGCRead(UGCHandle_t hContent, byte[] pvData, int cubDataToRead, uint cOffset, EUGCReadAction eAction)

Parameters

Type	Name	Description
UGCHandle_t	hContent	Passed through to ISteamRemoteStorage::UGCRead.
byte[]	pvData	Passed through to ISteamRemoteStorage::UGCRead.
int	cubDataToRead	Passed through to ISteamRemoteStorage::UGCRead.
uint	cOffset	Passed through to ISteamRemoteStorage::UGCRead.
EUGCReadAction	eAction	Passed through to ISteamRemoteStorage::UGCRead.

Returns

Type	Description
int	The value ISteamRemoteStorage::UGCRead returns.

UnsubscribePublishedFile(PublishedFileId_t)

Calls the Steamworks ISteamRemoteStorage::UnsubscribePublishedFile method.

Declaration

public static SteamAPICall_t UnsubscribePublishedFile(PublishedFileId_t unPublishedFileId)

Parameters

Type	Name	Description
PublishedFileId_t	unPublishedFileId	Passed through to ISteamRemoteStorage::UnsubscribePublishedFile.

Returns

Type	Description
SteamAPICall_t	The value ISteamRemoteStorage::UnsubscribePublishedFile returns.

UnsubscribePublishedFileAsync(PublishedFileId_t)

Async version of UnsubscribePublishedFile(PublishedFileId_t).

Declaration

public static Task<RemoteStorageUnsubscribePublishedFileResult_t> UnsubscribePublishedFileAsync(PublishedFileId_t unPublishedFileId)

Parameters

Type	Name	Description
PublishedFileId_t	unPublishedFileId	Passed through to ISteamRemoteStorage::UnsubscribePublishedFile.

Returns

Type	Description
Task<RemoteStorageUnsubscribePublishedFileResult_t>	The RemoteStorageUnsubscribePublishedFileResult_t Steam reports once the call completes.

UpdatePublishedFileDescription(PublishedFileUpdateHandle_t, string)

Calls the Steamworks ISteamRemoteStorage::UpdatePublishedFileDescription method.

Declaration

public static bool UpdatePublishedFileDescription(PublishedFileUpdateHandle_t updateHandle, string pchDescription)

Parameters

Type	Name	Description
PublishedFileUpdateHandle_t	updateHandle	Passed through to ISteamRemoteStorage::UpdatePublishedFileDescription.
string	pchDescription	Passed through to ISteamRemoteStorage::UpdatePublishedFileDescription.

Returns

Type	Description
bool	The value ISteamRemoteStorage::UpdatePublishedFileDescription returns.

UpdatePublishedFileFile(PublishedFileUpdateHandle_t, string)

Calls the Steamworks ISteamRemoteStorage::UpdatePublishedFileFile method.

Declaration

public static bool UpdatePublishedFileFile(PublishedFileUpdateHandle_t updateHandle, string pchFile)

Parameters

Type	Name	Description
PublishedFileUpdateHandle_t	updateHandle	Passed through to ISteamRemoteStorage::UpdatePublishedFileFile.
string	pchFile	Passed through to ISteamRemoteStorage::UpdatePublishedFileFile.

Returns

Type	Description
bool	The value ISteamRemoteStorage::UpdatePublishedFileFile returns.

UpdatePublishedFilePreviewFile(PublishedFileUpdateHandle_t, string)

Calls the Steamworks ISteamRemoteStorage::UpdatePublishedFilePreviewFile method.

Declaration

public static bool UpdatePublishedFilePreviewFile(PublishedFileUpdateHandle_t updateHandle, string pchPreviewFile)

Parameters

Type	Name	Description
PublishedFileUpdateHandle_t	updateHandle	Passed through to ISteamRemoteStorage::UpdatePublishedFilePreviewFile.
string	pchPreviewFile	Passed through to ISteamRemoteStorage::UpdatePublishedFilePreviewFile.

Returns

Type	Description
bool	The value ISteamRemoteStorage::UpdatePublishedFilePreviewFile returns.

UpdatePublishedFileSetChangeDescription(PublishedFileUpdateHandle_t, string)

Calls the Steamworks ISteamRemoteStorage::UpdatePublishedFileSetChangeDescription method.

Declaration

public static bool UpdatePublishedFileSetChangeDescription(PublishedFileUpdateHandle_t updateHandle, string pchChangeDescription)

Parameters

Type	Name	Description
PublishedFileUpdateHandle_t	updateHandle	Passed through to ISteamRemoteStorage::UpdatePublishedFileSetChangeDescription.
string	pchChangeDescription	Passed through to ISteamRemoteStorage::UpdatePublishedFileSetChangeDescription.

Returns

Type	Description
bool	The value ISteamRemoteStorage::UpdatePublishedFileSetChangeDescription returns.

UpdatePublishedFileTags(PublishedFileUpdateHandle_t, IList<string>)

Calls the Steamworks ISteamRemoteStorage::UpdatePublishedFileTags method.

Declaration

public static bool UpdatePublishedFileTags(PublishedFileUpdateHandle_t updateHandle, IList<string> pTags)

Parameters

Type	Name	Description
PublishedFileUpdateHandle_t	updateHandle	Passed through to ISteamRemoteStorage::UpdatePublishedFileTags.
IList<string>	pTags	Passed through to ISteamRemoteStorage::UpdatePublishedFileTags.

Returns

Type	Description
bool	The value ISteamRemoteStorage::UpdatePublishedFileTags returns.

UpdatePublishedFileTitle(PublishedFileUpdateHandle_t, string)

Calls the Steamworks ISteamRemoteStorage::UpdatePublishedFileTitle method.

Declaration

public static bool UpdatePublishedFileTitle(PublishedFileUpdateHandle_t updateHandle, string pchTitle)

Parameters

Type	Name	Description
PublishedFileUpdateHandle_t	updateHandle	Passed through to ISteamRemoteStorage::UpdatePublishedFileTitle.
string	pchTitle	Passed through to ISteamRemoteStorage::UpdatePublishedFileTitle.

Returns

Type	Description
bool	The value ISteamRemoteStorage::UpdatePublishedFileTitle returns.

UpdatePublishedFileVisibility(PublishedFileUpdateHandle_t, ERemoteStoragePublishedFileVisibility)

Calls the Steamworks ISteamRemoteStorage::UpdatePublishedFileVisibility method.

Declaration

public static bool UpdatePublishedFileVisibility(PublishedFileUpdateHandle_t updateHandle, ERemoteStoragePublishedFileVisibility eVisibility)

Parameters

Type	Name	Description
PublishedFileUpdateHandle_t	updateHandle	Passed through to ISteamRemoteStorage::UpdatePublishedFileVisibility.
ERemoteStoragePublishedFileVisibility	eVisibility	Passed through to ISteamRemoteStorage::UpdatePublishedFileVisibility.

Returns

Type	Description
bool	The value ISteamRemoteStorage::UpdatePublishedFileVisibility returns.

UpdateUserPublishedItemVote(PublishedFileId_t, bool)

Calls the Steamworks ISteamRemoteStorage::UpdateUserPublishedItemVote method.

Declaration

public static SteamAPICall_t UpdateUserPublishedItemVote(PublishedFileId_t unPublishedFileId, bool bVoteUp)

Parameters

Type	Name	Description
PublishedFileId_t	unPublishedFileId	Passed through to ISteamRemoteStorage::UpdateUserPublishedItemVote.
bool	bVoteUp	Passed through to ISteamRemoteStorage::UpdateUserPublishedItemVote.

Returns

Type	Description
SteamAPICall_t	The value ISteamRemoteStorage::UpdateUserPublishedItemVote returns.

UpdateUserPublishedItemVoteAsync(PublishedFileId_t, bool)

Async version of UpdateUserPublishedItemVote(PublishedFileId_t, bool).

Declaration

public static Task<RemoteStorageUpdateUserPublishedItemVoteResult_t> UpdateUserPublishedItemVoteAsync(PublishedFileId_t unPublishedFileId, bool bVoteUp)

Parameters

Type	Name	Description
PublishedFileId_t	unPublishedFileId	Passed through to ISteamRemoteStorage::UpdateUserPublishedItemVote.
bool	bVoteUp	Passed through to ISteamRemoteStorage::UpdateUserPublishedItemVote.

Returns

Type	Description
Task<RemoteStorageUpdateUserPublishedItemVoteResult_t>	The RemoteStorageUpdateUserPublishedItemVoteResult_t Steam reports once the call completes.