Class ISteamRemoteStorage

Namespace

MarymoorStudios.Core.Steamworks

Assembly

MarymoorStudios.Core.Steamworks.dll

public sealed class ISteamRemoteStorage : SteamNativeObject

Inheritance

object

SteamNativeObject

ISteamRemoteStorage

Inherited Members

object.GetType()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Fields

INTERFACE_VERSION

public const string INTERFACE_VERSION = "STEAMREMOTESTORAGE_INTERFACE_VERSION016"

Field Value

string

Methods

BeginFileWriteBatch()

public bool BeginFileWriteBatch()

Returns

bool

CommitPublishedFileUpdate(PublishedFileUpdateHandle)

public Promise<RemoteStorageUpdatePublishedFileResult> CommitPublishedFileUpdate(PublishedFileUpdateHandle updateHandle)

Parameters

updateHandle PublishedFileUpdateHandle

Returns

Promise<RemoteStorageUpdatePublishedFileResult>

CreatePublishedFileUpdateRequest(PublishedFileId)

public PublishedFileUpdateHandle CreatePublishedFileUpdateRequest(PublishedFileId publishedFileId)

Parameters

publishedFileId PublishedFileId

Returns

PublishedFileUpdateHandle

DeletePublishedFile(PublishedFileId)

public Promise<RemoteStorageDeletePublishedFileResult> DeletePublishedFile(PublishedFileId publishedFileId)

Parameters

publishedFileId PublishedFileId

Returns

Promise<RemoteStorageDeletePublishedFileResult>

EndFileWriteBatch()

public bool EndFileWriteBatch()

Returns

bool

EnumeratePublishedFilesByUserAction(EWorkshopFileAction, uint)

public Promise<RemoteStorageEnumeratePublishedFilesByUserActionResult> EnumeratePublishedFilesByUserAction(EWorkshopFileAction action, uint startIndex)

Parameters

action EWorkshopFileAction

startIndex uint

Returns

Promise<RemoteStorageEnumeratePublishedFilesByUserActionResult>

EnumeratePublishedWorkshopFiles(EWorkshopEnumerationType, uint, uint, uint, in SteamParamStringArray, in SteamParamStringArray)

public Promise<RemoteStorageEnumerateWorkshopFilesResult> EnumeratePublishedWorkshopFiles(EWorkshopEnumerationType enumerationType, uint startIndex, uint count, uint days, in SteamParamStringArray tags, in SteamParamStringArray userTags)

Parameters

enumerationType EWorkshopEnumerationType

startIndex uint

count uint

days uint

tags SteamParamStringArray

userTags SteamParamStringArray

Returns

Promise<RemoteStorageEnumerateWorkshopFilesResult>

EnumerateUserPublishedFiles(uint)

public Promise<RemoteStorageEnumerateUserPublishedFilesResult> EnumerateUserPublishedFiles(uint startIndex)

Parameters

startIndex uint

Returns

Promise<RemoteStorageEnumerateUserPublishedFilesResult>

EnumerateUserSharedWorkshopFiles(CSteamID, uint, in SteamParamStringArray, in SteamParamStringArray)

public Promise<RemoteStorageEnumerateUserPublishedFilesResult> EnumerateUserSharedWorkshopFiles(CSteamID steamId, uint startIndex, in SteamParamStringArray requiredTags, in SteamParamStringArray excludedTags)

Parameters

steamId CSteamID

startIndex uint

requiredTags SteamParamStringArray

excludedTags SteamParamStringArray

Returns

Promise<RemoteStorageEnumerateUserPublishedFilesResult>

EnumerateUserSubscribedFiles(uint)

public Promise<RemoteStorageEnumerateUserSubscribedFilesResult> EnumerateUserSubscribedFiles(uint startIndex)

Parameters

startIndex uint

Returns

Promise<RemoteStorageEnumerateUserSubscribedFilesResult>

FileDelete(string)

public bool FileDelete(string file)

Parameters

file string

Returns

bool

FileExists(string)

public bool FileExists(string file)

Parameters

file string

Returns

bool

FileForget(string)

public bool FileForget(string file)

Parameters

file string

Returns

bool

FilePersisted(string)

public bool FilePersisted(string file)

Parameters

file string

Returns

bool

FileRead(string, Span<byte>)

public int FileRead(string file, Span<byte> data)

Parameters

file string

data Span<byte>

Returns

int

FileReadAsync(string, uint, uint)

public Promise<RemoteStorageFileReadAsyncComplete> FileReadAsync(string file, uint offset, uint toReadCount)

Parameters

file string

offset uint

toReadCount uint

Returns

Promise<RemoteStorageFileReadAsyncComplete>

FileReadAsyncComplete(SteamAPICall, Span<byte>)

public bool FileReadAsyncComplete(SteamAPICall readCall, Span<byte> buffer)

Parameters

readCall SteamAPICall

buffer Span<byte>

Returns

bool

FileShare(string)

public Promise<RemoteStorageFileShareResult> FileShare(string file)

Parameters

file string

Returns

Promise<RemoteStorageFileShareResult>

FileWrite(string, ReadOnlySpan<byte>)

public bool FileWrite(string file, ReadOnlySpan<byte> data)

Parameters

file string

data ReadOnlySpan<byte>

Returns

bool

FileWriteAsync(string, ReadOnlySpan<byte>)

public Promise<RemoteStorageFileWriteAsyncComplete> FileWriteAsync(string file, ReadOnlySpan<byte> data)

Parameters

file string

data ReadOnlySpan<byte>

Returns

Promise<RemoteStorageFileWriteAsyncComplete>

FileWriteStreamCancel(UGCFileWriteStreamHandle)

public bool FileWriteStreamCancel(UGCFileWriteStreamHandle writeHandle)

Parameters

writeHandle UGCFileWriteStreamHandle

Returns

bool

FileWriteStreamClose(UGCFileWriteStreamHandle)

public bool FileWriteStreamClose(UGCFileWriteStreamHandle writeHandle)

Parameters

writeHandle UGCFileWriteStreamHandle

Returns

bool

FileWriteStreamOpen(string)

public UGCFileWriteStreamHandle FileWriteStreamOpen(string file)

Parameters

file string

Returns

UGCFileWriteStreamHandle

FileWriteStreamWriteChunk(UGCFileWriteStreamHandle, ReadOnlySpan<byte>)

public bool FileWriteStreamWriteChunk(UGCFileWriteStreamHandle writeHandle, ReadOnlySpan<byte> data)

Parameters

writeHandle UGCFileWriteStreamHandle

data ReadOnlySpan<byte>

Returns

bool

GetCachedUGCCount()

public int GetCachedUGCCount()

Returns

int

GetCachedUGCHandle(int)

public UGCHandle GetCachedUGCHandle(int cachedContent)

Parameters

cachedContent int

Returns

UGCHandle

GetFileCount()

public int GetFileCount()

Returns

int

GetFileNameAndSize(int, out int)

public string GetFileNameAndSize(int file, out int fileSizeInBytes)

Parameters

file int

fileSizeInBytes int

Returns

string

GetFileSize(string)

public int GetFileSize(string file)

Parameters

file string

Returns

int

GetFileTimestamp(string)

public long GetFileTimestamp(string file)

Parameters

file string

Returns

long

GetLocalFileChange(int, out ERemoteStorageLocalFileChange, out ERemoteStorageFilePathType)

public string GetLocalFileChange(int file, out ERemoteStorageLocalFileChange eChangeType, out ERemoteStorageFilePathType eFilePathType)

Parameters

file int

eChangeType ERemoteStorageLocalFileChange

eFilePathType ERemoteStorageFilePathType

Returns

string

GetLocalFileChangeCount()

public int GetLocalFileChangeCount()

Returns

int

GetPublishedFileDetails(PublishedFileId, uint)

public Promise<RemoteStorageGetPublishedFileDetailsResult> GetPublishedFileDetails(PublishedFileId publishedFileId, uint maxSecondsOld)

Parameters

publishedFileId PublishedFileId

maxSecondsOld uint

Returns

Promise<RemoteStorageGetPublishedFileDetailsResult>

GetPublishedItemVoteDetails(PublishedFileId)

public Promise<RemoteStorageGetPublishedItemVoteDetailsResult> GetPublishedItemVoteDetails(PublishedFileId publishedFileId)

Parameters

publishedFileId PublishedFileId

Returns

Promise<RemoteStorageGetPublishedItemVoteDetailsResult>

GetQuota(out ulong, out ulong)

public bool GetQuota(out ulong totalBytes, out ulong puAvailableBytes)

Parameters

totalBytes ulong

puAvailableBytes ulong

Returns

bool

GetSyncPlatforms(string)

public ERemoteStoragePlatform GetSyncPlatforms(string file)

Parameters

file string

Returns

ERemoteStoragePlatform

GetUGCDetails(UGCHandle, out AppId, out string, out int, out CSteamID)

public bool GetUGCDetails(UGCHandle content, out AppId appId, out string ppchName, out int fileSizeInBytes, out CSteamID steamIDOwner)

Parameters

content UGCHandle

appId AppId

ppchName string

fileSizeInBytes int

steamIDOwner CSteamID

Returns

bool

GetUGCDownloadProgress(UGCHandle, out int, out int)

public bool GetUGCDownloadProgress(UGCHandle content, out int bytesDownloaded, out int bytesExpected)

Parameters

content UGCHandle

bytesDownloaded int

bytesExpected int

Returns

bool

GetUserPublishedItemVoteDetails(PublishedFileId)

public Promise<RemoteStorageGetPublishedItemVoteDetailsResult> GetUserPublishedItemVoteDetails(PublishedFileId publishedFileId)

Parameters

publishedFileId PublishedFileId

Returns

Promise<RemoteStorageGetPublishedItemVoteDetailsResult>

IsCloudEnabledForAccount()

public bool IsCloudEnabledForAccount()

Returns

bool

IsCloudEnabledForApp()

public bool IsCloudEnabledForApp()

Returns

bool

OnRemoteStorageEnumerateUserSharedWorkshopFilesResult(CallbackAction<RemoteStorageEnumerateUserSharedWorkshopFilesResult>)

public IDisposable OnRemoteStorageEnumerateUserSharedWorkshopFilesResult(CallbackAction<RemoteStorageEnumerateUserSharedWorkshopFilesResult> func)

Parameters

func CallbackAction<RemoteStorageEnumerateUserSharedWorkshopFilesResult>

Returns

IDisposable

OnRemoteStorageLocalFileChange(CallbackAction<RemoteStorageLocalFileChange>)

public IDisposable OnRemoteStorageLocalFileChange(CallbackAction<RemoteStorageLocalFileChange> func)

Parameters

func CallbackAction<RemoteStorageLocalFileChange>

Returns

IDisposable

OnRemoteStoragePublishFileResult(CallbackAction<RemoteStoragePublishFileResult>)

public IDisposable OnRemoteStoragePublishFileResult(CallbackAction<RemoteStoragePublishFileResult> func)

Parameters

func CallbackAction<RemoteStoragePublishFileResult>

Returns

IDisposable

OnRemoteStoragePublishedFileDeleted(CallbackAction<RemoteStoragePublishedFileDeleted>)

public IDisposable OnRemoteStoragePublishedFileDeleted(CallbackAction<RemoteStoragePublishedFileDeleted> func)

Parameters

func CallbackAction<RemoteStoragePublishedFileDeleted>

Returns

IDisposable

OnRemoteStoragePublishedFileSubscribed(CallbackAction<RemoteStoragePublishedFileSubscribed>)

public IDisposable OnRemoteStoragePublishedFileSubscribed(CallbackAction<RemoteStoragePublishedFileSubscribed> func)

Parameters

func CallbackAction<RemoteStoragePublishedFileSubscribed>

Returns

IDisposable

OnRemoteStoragePublishedFileUnsubscribed(CallbackAction<RemoteStoragePublishedFileUnsubscribed>)

public IDisposable OnRemoteStoragePublishedFileUnsubscribed(CallbackAction<RemoteStoragePublishedFileUnsubscribed> func)

Parameters

func CallbackAction<RemoteStoragePublishedFileUnsubscribed>

Returns

IDisposable

OnRemoteStoragePublishedFileUpdated(CallbackAction<RemoteStoragePublishedFileUpdated>)

public IDisposable OnRemoteStoragePublishedFileUpdated(CallbackAction<RemoteStoragePublishedFileUpdated> func)

Parameters

func CallbackAction<RemoteStoragePublishedFileUpdated>

Returns

IDisposable

OnRemoteStorageUserVoteDetails(CallbackAction<RemoteStorageUserVoteDetails>)

public IDisposable OnRemoteStorageUserVoteDetails(CallbackAction<RemoteStorageUserVoteDetails> func)

Parameters

func CallbackAction<RemoteStorageUserVoteDetails>

Returns

IDisposable

PublishVideo(EWorkshopVideoProvider, string, string, string, AppId, string, string, ERemoteStoragePublishedFileVisibility, in SteamParamStringArray)

public Promise<RemoteStoragePublishFileProgress> PublishVideo(EWorkshopVideoProvider videoProvider, string videoAccount, string videoIdentifier, string previewFile, AppId consumerAppId, string title, string description, ERemoteStoragePublishedFileVisibility visibility, in SteamParamStringArray tags)

Parameters

videoProvider EWorkshopVideoProvider

videoAccount string

videoIdentifier string

previewFile string

consumerAppId AppId

title string

description string

visibility ERemoteStoragePublishedFileVisibility

tags SteamParamStringArray

Returns

Promise<RemoteStoragePublishFileProgress>

PublishWorkshopFile(string, string, AppId, string, string, ERemoteStoragePublishedFileVisibility, in SteamParamStringArray, EWorkshopFileType)

public Promise<RemoteStoragePublishFileProgress> PublishWorkshopFile(string file, string previewFile, AppId consumerAppId, string title, string description, ERemoteStoragePublishedFileVisibility visibility, in SteamParamStringArray tags, EWorkshopFileType workshopFileType)

Parameters

file string

previewFile string

consumerAppId AppId

title string

description string

visibility ERemoteStoragePublishedFileVisibility

tags SteamParamStringArray

workshopFileType EWorkshopFileType

Returns

Promise<RemoteStoragePublishFileProgress>

SetCloudEnabledForApp(bool)

public void SetCloudEnabledForApp(bool enabled)

Parameters

enabled bool

SetSyncPlatforms(string, ERemoteStoragePlatform)

public bool SetSyncPlatforms(string file, ERemoteStoragePlatform remoteStoragePlatform)

Parameters

file string

remoteStoragePlatform ERemoteStoragePlatform

Returns

bool

SetUserPublishedFileAction(PublishedFileId, EWorkshopFileAction)

public Promise<RemoteStorageSetUserPublishedFileActionResult> SetUserPublishedFileAction(PublishedFileId publishedFileId, EWorkshopFileAction action)

Parameters

publishedFileId PublishedFileId

action EWorkshopFileAction

Returns

Promise<RemoteStorageSetUserPublishedFileActionResult>

SubscribePublishedFile(PublishedFileId)

public Promise<RemoteStorageSubscribePublishedFileResult> SubscribePublishedFile(PublishedFileId publishedFileId)

Parameters

publishedFileId PublishedFileId

Returns

Promise<RemoteStorageSubscribePublishedFileResult>

UGCDownload(UGCHandle, uint)

public Promise<RemoteStorageDownloadUGCResult> UGCDownload(UGCHandle content, uint priority)

Parameters

content UGCHandle

priority uint

Returns

Promise<RemoteStorageDownloadUGCResult>

UGCDownloadToLocation(UGCHandle, string, uint)

public Promise<RemoteStorageDownloadUGCResult> UGCDownloadToLocation(UGCHandle content, string location, uint priority)

Parameters

content UGCHandle

location string

priority uint

Returns

Promise<RemoteStorageDownloadUGCResult>

UGCRead(UGCHandle, Span<byte>, uint, EUGCReadAction)

public int UGCRead(UGCHandle content, Span<byte> data, uint offset, EUGCReadAction action)

Parameters

content UGCHandle

data Span<byte>

offset uint

action EUGCReadAction

Returns

int

UnsubscribePublishedFile(PublishedFileId)

public Promise<RemoteStorageUnsubscribePublishedFileResult> UnsubscribePublishedFile(PublishedFileId publishedFileId)

Parameters

publishedFileId PublishedFileId

Returns

Promise<RemoteStorageUnsubscribePublishedFileResult>

UpdatePublishedFileDescription(PublishedFileUpdateHandle, string)

public bool UpdatePublishedFileDescription(PublishedFileUpdateHandle updateHandle, string description)

Parameters

updateHandle PublishedFileUpdateHandle

description string

Returns

bool

UpdatePublishedFileFile(PublishedFileUpdateHandle, string)

public bool UpdatePublishedFileFile(PublishedFileUpdateHandle updateHandle, string file)

Parameters

updateHandle PublishedFileUpdateHandle

file string

Returns

bool

UpdatePublishedFilePreviewFile(PublishedFileUpdateHandle, string)

public bool UpdatePublishedFilePreviewFile(PublishedFileUpdateHandle updateHandle, string previewFile)

Parameters

updateHandle PublishedFileUpdateHandle

previewFile string

Returns

bool

UpdatePublishedFileSetChangeDescription(PublishedFileUpdateHandle, string)

public bool UpdatePublishedFileSetChangeDescription(PublishedFileUpdateHandle updateHandle, string changeDescription)

Parameters

updateHandle PublishedFileUpdateHandle

changeDescription string

Returns

bool

UpdatePublishedFileTags(PublishedFileUpdateHandle, in SteamParamStringArray)

public bool UpdatePublishedFileTags(PublishedFileUpdateHandle updateHandle, in SteamParamStringArray tags)

Parameters

updateHandle PublishedFileUpdateHandle

tags SteamParamStringArray

Returns

bool

UpdatePublishedFileTitle(PublishedFileUpdateHandle, string)

public bool UpdatePublishedFileTitle(PublishedFileUpdateHandle updateHandle, string title)

Parameters

updateHandle PublishedFileUpdateHandle

title string

Returns

bool

UpdatePublishedFileVisibility(PublishedFileUpdateHandle, ERemoteStoragePublishedFileVisibility)

public bool UpdatePublishedFileVisibility(PublishedFileUpdateHandle updateHandle, ERemoteStoragePublishedFileVisibility visibility)

Parameters

updateHandle PublishedFileUpdateHandle

visibility ERemoteStoragePublishedFileVisibility

Returns

bool

UpdateUserPublishedItemVote(PublishedFileId, bool)

public Promise<RemoteStorageUpdateUserPublishedItemVoteResult> UpdateUserPublishedItemVote(PublishedFileId publishedFileId, bool voteUp)

Parameters

publishedFileId PublishedFileId

voteUp bool

Returns

Promise<RemoteStorageUpdateUserPublishedItemVoteResult>