Steamworks v1.1.0
Open on GitHub Open in Dash

SteamRemoteStorage

Swift
public struct SteamRemoteStorage: Sendable

Steamworks ISteamRemoteStorage

Access via remoteStorage.

Topics

Steamworks ISteamRemoteStorage::BeginFileWriteBatch()

Declaration
Swift
public func beginFileWriteBatch() -> Bool

Steamworks ISteamRemoteStorage::CommitPublishedFileUpdate(), callback

Declaration
Swift
public func commitPublishedFileUpdate(
    handle: PublishedFileUpdateHandle,
    completion: @Sendable @escaping (
        sending RemoteStorageUpdatePublishedFileResult?
    ) -> Void)

Steamworks ISteamRemoteStorage::CommitPublishedFileUpdate(), async

Declaration
Swift
public func commitPublishedFileUpdate(
    isolation: isolated (any Actor)? = #isolation,
    handle: PublishedFileUpdateHandle
) async -> RemoteStorageUpdatePublishedFileResult?

Steamworks ISteamRemoteStorage::CreatePublishedFileUpdateRequest()

Declaration
Swift
public func createPublishedFileUpdateRequest(publishedFileId: PublishedFileID)
    -> PublishedFileUpdateHandle

Steamworks ISteamRemoteStorage::DeletePublishedFile(), callback

Declaration
Swift
public func deletePublishedFile(
    publishedFileId: PublishedFileID,
    completion: @Sendable @escaping (
        sending RemoteStorageDeletePublishedFileResult?
    ) -> Void)

Steamworks ISteamRemoteStorage::DeletePublishedFile(), async

Declaration
Swift
public func deletePublishedFile(
    isolation: isolated (any Actor)? = #isolation,
    publishedFileId: PublishedFileID
) async -> RemoteStorageDeletePublishedFileResult?

Steamworks ISteamRemoteStorage::EndFileWriteBatch()

Declaration
Swift
public func endFileWriteBatch() -> Bool

Steamworks ISteamRemoteStorage::EnumeratePublishedFilesByUserAction(), callback

Declaration
Swift
public func enumeratePublishedFilesByUserAction(
    action: WorkshopFileAction, startIndex: Int,
    completion: @Sendable @escaping (
        sending RemoteStorageEnumeratePublishedFilesByUserActionResult?
    ) -> Void)

Steamworks ISteamRemoteStorage::EnumeratePublishedFilesByUserAction(), async

Declaration
Swift
public func enumeratePublishedFilesByUserAction(
    isolation: isolated (any Actor)? = #isolation, action: WorkshopFileAction,
    startIndex: Int
) async -> RemoteStorageEnumeratePublishedFilesByUserActionResult?

Steamworks ISteamRemoteStorage::EnumeratePublishedWorkshopFiles(), callback

Declaration
Swift
public func enumeratePublishedWorkshopFiles(
    enumerationType: WorkshopEnumerationType, startIndex: Int, count: Int,
    days: Int, tags: [String], userTags: [String],
    completion: @Sendable @escaping (
        sending RemoteStorageEnumerateWorkshopFilesResult?
    ) -> Void)

Steamworks ISteamRemoteStorage::EnumeratePublishedWorkshopFiles(), async

Declaration
Swift
public func enumeratePublishedWorkshopFiles(
    isolation: isolated (any Actor)? = #isolation,
    enumerationType: WorkshopEnumerationType, startIndex: Int, count: Int,
    days: Int, tags: [String], userTags: [String]
) async -> RemoteStorageEnumerateWorkshopFilesResult?

Steamworks ISteamRemoteStorage::EnumerateUserPublishedFiles(), callback

Declaration
Swift
public func enumerateUserPublishedFiles(
    startIndex: Int,
    completion: @Sendable @escaping (
        sending RemoteStorageEnumerateUserPublishedFilesResult?
    ) -> Void)

Steamworks ISteamRemoteStorage::EnumerateUserPublishedFiles(), async

Declaration
Swift
public func enumerateUserPublishedFiles(
    isolation: isolated (any Actor)? = #isolation, startIndex: Int
) async -> RemoteStorageEnumerateUserPublishedFilesResult?

Steamworks ISteamRemoteStorage::EnumerateUserSharedWorkshopFiles(), callback

Declaration
Swift
public func enumerateUserSharedWorkshopFiles(
    steamId: SteamID, startIndex: Int, requiredTags: [String],
    excludedTags: [String],
    completion: @Sendable @escaping (
        sending RemoteStorageEnumerateUserPublishedFilesResult?
    ) -> Void)

Steamworks ISteamRemoteStorage::EnumerateUserSharedWorkshopFiles(), async

Declaration
Swift
public func enumerateUserSharedWorkshopFiles(
    isolation: isolated (any Actor)? = #isolation, steamId: SteamID,
    startIndex: Int, requiredTags: [String], excludedTags: [String]
) async -> RemoteStorageEnumerateUserPublishedFilesResult?

Steamworks ISteamRemoteStorage::EnumerateUserSubscribedFiles(), callback

Declaration
Swift
public func enumerateUserSubscribedFiles(
    startIndex: Int,
    completion: @Sendable @escaping (
        sending RemoteStorageEnumerateUserSubscribedFilesResult?
    ) -> Void)

Steamworks ISteamRemoteStorage::EnumerateUserSubscribedFiles(), async

Declaration
Swift
public func enumerateUserSubscribedFiles(
    isolation: isolated (any Actor)? = #isolation, startIndex: Int
) async -> RemoteStorageEnumerateUserSubscribedFilesResult?

Steamworks ISteamRemoteStorage::FileDelete()

Declaration
Swift
@discardableResult
public func fileDelete(file: String) -> Bool

Steamworks ISteamRemoteStorage::FileExists()

Declaration
Swift
public func fileExists(file: String) -> Bool

Steamworks ISteamRemoteStorage::FileForget()

Declaration
Swift
@discardableResult
public func fileForget(file: String) -> Bool

Steamworks ISteamRemoteStorage::FilePersisted()

Declaration
Swift
public func filePersisted(file: String) -> Bool

Steamworks ISteamRemoteStorage::FileRead()

Declaration
Swift
public func fileRead(
    file: String, data: UnsafeMutableRawPointer, dataToReadSize: Int
) -> Int

Steamworks ISteamRemoteStorage::FileReadAsync(), callback

Declaration
Swift
public func fileReadAsync(
    file: String, offset: Int, toReadSize: Int,
    completion: @Sendable @escaping (
        sending RemoteStorageFileReadAsyncComplete?
    ) -> Void)

Steamworks ISteamRemoteStorage::FileReadAsync(), async

Declaration
Swift
public func fileReadAsync(
    isolation: isolated (any Actor)? = #isolation, file: String, offset: Int,
    toReadSize: Int
) async -> RemoteStorageFileReadAsyncComplete?

Steamworks ISteamRemoteStorage::FileReadAsyncComplete()

Declaration
Swift
public func fileReadAsyncComplete(
    readCall: SteamAPICall, buffer: UnsafeMutableRawPointer, toReadSize: Int
) -> Bool

Steamworks ISteamRemoteStorage::FileShare(), callback

Declaration
Swift
public func fileShare(
    file: String,
    completion: @Sendable @escaping (sending RemoteStorageFileShareResult?) ->
        Void)

Steamworks ISteamRemoteStorage::FileShare(), async

Declaration
Swift
public func fileShare(
    isolation: isolated (any Actor)? = #isolation, file: String
) async -> RemoteStorageFileShareResult?

Steamworks ISteamRemoteStorage::FileWrite()

Declaration
Swift
public func fileWrite(file: String, data: UnsafeRawPointer, dataSize: Int)
    -> Bool

Steamworks ISteamRemoteStorage::FileWriteAsync(), callback

Declaration
Swift
public func fileWriteAsync(
    file: String, data: UnsafeRawPointer, dataSize: Int,
    completion: @Sendable @escaping (
        sending RemoteStorageFileWriteAsyncComplete?
    ) -> Void)

Steamworks ISteamRemoteStorage::FileWriteAsync(), async

Declaration
Swift
public func fileWriteAsync(
    isolation: isolated (any Actor)? = #isolation, file: String,
    data: UnsafeRawPointer, dataSize: Int
) async -> RemoteStorageFileWriteAsyncComplete?

Steamworks ISteamRemoteStorage::FileWriteStreamCancel()

Declaration
Swift
public func fileWriteStreamCancel(handle: UGCFileWriteStreamHandle) -> Bool

Steamworks ISteamRemoteStorage::FileWriteStreamClose()

Declaration
Swift
@discardableResult
public func fileWriteStreamClose(handle: UGCFileWriteStreamHandle) -> Bool

Steamworks ISteamRemoteStorage::FileWriteStreamOpen()

Declaration
Swift
public func fileWriteStreamOpen(file: String) -> UGCFileWriteStreamHandle

Steamworks ISteamRemoteStorage::FileWriteStreamWriteChunk()

Declaration
Swift
public func fileWriteStreamWriteChunk(
    handle: UGCFileWriteStreamHandle, data: UnsafeRawPointer, dataSize: Int
) -> Bool

Steamworks ISteamRemoteStorage::GetCachedUGCCount()

Declaration
Swift
public func getCachedUGCCount() -> Int

Steamworks ISteamRemoteStorage::GetCachedUGCHandle()

Declaration
Swift
public func getCachedUGCHandle(cachedContentIndex: Int) -> UGCHandle

Steamworks ISteamRemoteStorage::GetFileCount()

Declaration
Swift
public func getFileCount() -> Int

Steamworks ISteamRemoteStorage::GetFileNameAndSize()

Declaration
Swift
public func getFileNameAndSize(fileIndex: Int) -> (
    rc: String, fileSizeInBytes: Int
)

Steamworks ISteamRemoteStorage::GetFileSize()

Declaration
Swift
public func getFileSize(file: String) -> Int

Steamworks ISteamRemoteStorage::GetFileTimestamp()

Declaration
Swift
public func getFileTimestamp(file: String) -> Int

Steamworks ISteamRemoteStorage::GetLocalFileChange()

Declaration
Swift
public func getLocalFileChange(fileIndex: Int) -> (
    rc: String, eChangeType: RemoteStorageLocalFileChangeType,
    eFilePathType: RemoteStorageFilePathType
)

Steamworks ISteamRemoteStorage::GetLocalFileChangeCount()

Declaration
Swift
public func getLocalFileChangeCount() -> Int

Steamworks ISteamRemoteStorage::GetPublishedFileDetails(), callback

Declaration
Swift
public func getPublishedFileDetails(
    publishedFileId: PublishedFileID, maxSecondsOld: Int,
    completion: @Sendable @escaping (
        sending RemoteStorageGetPublishedFileDetailsResult?
    ) -> Void)

Steamworks ISteamRemoteStorage::GetPublishedFileDetails(), async

Declaration
Swift
public func getPublishedFileDetails(
    isolation: isolated (any Actor)? = #isolation,
    publishedFileId: PublishedFileID, maxSecondsOld: Int
) async -> RemoteStorageGetPublishedFileDetailsResult?

Steamworks ISteamRemoteStorage::GetPublishedItemVoteDetails(), callback

Declaration
Swift
public func getPublishedItemVoteDetails(
    publishedFileId: PublishedFileID,
    completion: @Sendable @escaping (
        sending RemoteStorageGetPublishedItemVoteDetailsResult?
    ) -> Void)

Steamworks ISteamRemoteStorage::GetPublishedItemVoteDetails(), async

Declaration
Swift
public func getPublishedItemVoteDetails(
    isolation: isolated (any Actor)? = #isolation,
    publishedFileId: PublishedFileID
) async -> RemoteStorageGetPublishedItemVoteDetailsResult?

Steamworks ISteamRemoteStorage::GetQuota()

Declaration
Swift
public func getQuota() -> (rc: Bool, totalBytes: UInt64, availableBytes: UInt64)

Steamworks ISteamRemoteStorage::GetSyncPlatforms()

Declaration
Swift
public func getSyncPlatforms(file: String) -> RemoteStoragePlatform

Steamworks ISteamRemoteStorage::GetUGCDownloadProgress()

Declaration
Swift
public func getUGCDownloadProgress(content: UGCHandle) -> (
    rc: Bool, bytesDownloaded: Int, bytesExpected: Int
)

Steamworks ISteamRemoteStorage::GetUserPublishedItemVoteDetails(), callback

Declaration
Swift
public func getUserPublishedItemVoteDetails(
    publishedFileId: PublishedFileID,
    completion: @Sendable @escaping (
        sending RemoteStorageGetPublishedItemVoteDetailsResult?
    ) -> Void)

Steamworks ISteamRemoteStorage::GetUserPublishedItemVoteDetails(), async

Declaration
Swift
public func getUserPublishedItemVoteDetails(
    isolation: isolated (any Actor)? = #isolation,
    publishedFileId: PublishedFileID
) async -> RemoteStorageGetPublishedItemVoteDetailsResult?

Steamworks ISteamRemoteStorage::IsCloudEnabledForAccount()

Declaration
Swift
public func isCloudEnabledForAccount() -> Bool

Steamworks ISteamRemoteStorage::IsCloudEnabledForApp()

Declaration
Swift
public func isCloudEnabledForApp() -> Bool

Steamworks ISteamRemoteStorage::PublishVideo(), callback

Declaration
Swift
public func publishVideo(
    videoProvider: WorkshopVideoProvider, videoAccount: String,
    videoIdentifier: String, previewFile: String, consumerAppId: AppID,
    title: String, description: String,
    visibility: RemoteStoragePublishedFileVisibility, tags: [String],
    completion: @Sendable @escaping (sending RemoteStoragePublishFileProgress?)
        -> Void)

Steamworks ISteamRemoteStorage::PublishVideo(), async

Declaration
Swift
public func publishVideo(
    isolation: isolated (any Actor)? = #isolation,
    videoProvider: WorkshopVideoProvider, videoAccount: String,
    videoIdentifier: String, previewFile: String, consumerAppId: AppID,
    title: String, description: String,
    visibility: RemoteStoragePublishedFileVisibility, tags: [String]
) async -> RemoteStoragePublishFileProgress?

Steamworks ISteamRemoteStorage::PublishWorkshopFile(), callback

Declaration
Swift
public func publishWorkshopFile(
    file: String, previewFile: String, consumerAppId: AppID, title: String,
    description: String, visibility: RemoteStoragePublishedFileVisibility,
    tags: [String], workshopFileType: WorkshopFileType,
    completion: @Sendable @escaping (sending RemoteStoragePublishFileProgress?)
        -> Void)

Steamworks ISteamRemoteStorage::PublishWorkshopFile(), async

Declaration
Swift
public func publishWorkshopFile(
    isolation: isolated (any Actor)? = #isolation, file: String,
    previewFile: String, consumerAppId: AppID, title: String,
    description: String, visibility: RemoteStoragePublishedFileVisibility,
    tags: [String], workshopFileType: WorkshopFileType
) async -> RemoteStoragePublishFileProgress?

Steamworks ISteamRemoteStorage::SetCloudEnabledForApp()

Declaration
Swift
public func setCloudEnabledForApp(enabled: Bool)

Steamworks ISteamRemoteStorage::SetSyncPlatforms()

Declaration
Swift
public func setSyncPlatforms(
    file: String, remoteStoragePlatform: RemoteStoragePlatform
) -> Bool

Steamworks ISteamRemoteStorage::SetUserPublishedFileAction(), callback

Declaration
Swift
public func setUserPublishedFileAction(
    publishedFileId: PublishedFileID, action: WorkshopFileAction,
    completion: @Sendable @escaping (
        sending RemoteStorageSetUserPublishedFileActionResult?
    ) -> Void)

Steamworks ISteamRemoteStorage::SetUserPublishedFileAction(), async

Declaration
Swift
public func setUserPublishedFileAction(
    isolation: isolated (any Actor)? = #isolation,
    publishedFileId: PublishedFileID, action: WorkshopFileAction
) async -> RemoteStorageSetUserPublishedFileActionResult?

Steamworks ISteamRemoteStorage::SubscribePublishedFile(), callback

Declaration
Swift
public func subscribePublishedFile(
    publishedFileId: PublishedFileID,
    completion: @Sendable @escaping (
        sending RemoteStorageSubscribePublishedFileResult?
    ) -> Void)

Steamworks ISteamRemoteStorage::SubscribePublishedFile(), async

Declaration
Swift
public func subscribePublishedFile(
    isolation: isolated (any Actor)? = #isolation,
    publishedFileId: PublishedFileID
) async -> RemoteStorageSubscribePublishedFileResult?

Steamworks ISteamRemoteStorage::UGCDownload(), callback

Declaration
Swift
public func ugcDownload(
    content: UGCHandle, priority: Int,
    completion: @Sendable @escaping (sending RemoteStorageDownloadUGCResult?) ->
        Void)

Steamworks ISteamRemoteStorage::UGCDownload(), async

Declaration
Swift
public func ugcDownload(
    isolation: isolated (any Actor)? = #isolation, content: UGCHandle,
    priority: Int
) async -> RemoteStorageDownloadUGCResult?

Steamworks ISteamRemoteStorage::UGCDownloadToLocation(), callback

Declaration
Swift
public func ugcDownloadToLocation(
    content: UGCHandle, location: String, priority: Int,
    completion: @Sendable @escaping (sending RemoteStorageDownloadUGCResult?) ->
        Void)

Steamworks ISteamRemoteStorage::UGCDownloadToLocation(), async

Declaration
Swift
public func ugcDownloadToLocation(
    isolation: isolated (any Actor)? = #isolation, content: UGCHandle,
    location: String, priority: Int
) async -> RemoteStorageDownloadUGCResult?

Steamworks ISteamRemoteStorage::UGCRead()

Declaration
Swift
public func ugcRead(
    content: UGCHandle, data: UnsafeMutableRawPointer, dataToReadSize: Int,
    offset: Int, action: UGCReadAction
) -> Int

Steamworks ISteamRemoteStorage::UnsubscribePublishedFile(), callback

Declaration
Swift
public func unsubscribePublishedFile(
    publishedFileId: PublishedFileID,
    completion: @Sendable @escaping (
        sending RemoteStorageUnsubscribePublishedFileResult?
    ) -> Void)

Steamworks ISteamRemoteStorage::UnsubscribePublishedFile(), async

Declaration
Swift
public func unsubscribePublishedFile(
    isolation: isolated (any Actor)? = #isolation,
    publishedFileId: PublishedFileID
) async -> RemoteStorageUnsubscribePublishedFileResult?

Steamworks ISteamRemoteStorage::UpdatePublishedFileDescription()

Declaration
Swift
public func updatePublishedFileDescription(
    handle: PublishedFileUpdateHandle, description: String
) -> Bool

Steamworks ISteamRemoteStorage::UpdatePublishedFileFile()

Declaration
Swift
public func updatePublishedFileFile(
    handle: PublishedFileUpdateHandle, file: String
) -> Bool

Steamworks ISteamRemoteStorage::UpdatePublishedFilePreviewFile()

Declaration
Swift
public func updatePublishedFilePreviewFile(
    handle: PublishedFileUpdateHandle, previewFile: String
) -> Bool

Steamworks ISteamRemoteStorage::UpdatePublishedFileSetChangeDescription()

Declaration
Swift
public func updatePublishedFileSetChangeDescription(
    handle: PublishedFileUpdateHandle, changeDescription: String
) -> Bool

Steamworks ISteamRemoteStorage::UpdatePublishedFileTags()

Declaration
Swift
public func updatePublishedFileTags(
    handle: PublishedFileUpdateHandle, tags: [String]
) -> Bool

Steamworks ISteamRemoteStorage::UpdatePublishedFileTitle()

Declaration
Swift
public func updatePublishedFileTitle(
    handle: PublishedFileUpdateHandle, title: String
) -> Bool

Steamworks ISteamRemoteStorage::UpdatePublishedFileVisibility()

Declaration
Swift
public func updatePublishedFileVisibility(
    handle: PublishedFileUpdateHandle,
    visibility: RemoteStoragePublishedFileVisibility
) -> Bool

Steamworks ISteamRemoteStorage::UpdateUserPublishedItemVote(), callback

Declaration
Swift
public func updateUserPublishedItemVote(
    publishedFileId: PublishedFileID, voteUp: Bool,
    completion: @Sendable @escaping (
        sending RemoteStorageUpdateUserPublishedItemVoteResult?
    ) -> Void)

Steamworks ISteamRemoteStorage::UpdateUserPublishedItemVote(), async

Declaration
Swift
public func updateUserPublishedItemVote(
    isolation: isolated (any Actor)? = #isolation,
    publishedFileId: PublishedFileID, voteUp: Bool
) async -> RemoteStorageUpdateUserPublishedItemVoteResult?

Steamworks ISteamRemoteStorage::GetUGCDetails()

Declaration
Swift
public func getUGCDetails(content: UGCHandle) -> (
    rc: Bool, appID: AppID, name: String, fileSizeInBytes: Int, owner: SteamID
)