Interface: SteamRemoteStorage

SteamWorksNamespace.SteamRemoteStorage

Table of contents

Properties

• BeginFileWriteBatch
• CommitPublishedFileUpdate
• CreatePublishedFileUpdateRequest
• DeletePublishedFile
• EndFileWriteBatch
• EnumeratePublishedFilesByUserAction
• EnumeratePublishedWorkshopFiles
• EnumerateUserPublishedFiles
• EnumerateUserSharedWorkshopFiles
• EnumerateUserSubscribedFiles
• FileDelete
• FileExists
• FileForget
• FilePersisted
• FileRead
• FileReadAsync
• FileReadAsyncComplete
• FileShare
• FileWrite
• FileWriteAsync
• FileWriteStreamCancel
• FileWriteStreamClose
• FileWriteStreamOpen
• FileWriteStreamWriteChunk
• GetCachedUGCCount
• GetCachedUGCHandle
• GetFileCount
• GetFileNameAndSize
• GetFileSize
• GetFileTimestamp
• GetLocalFileChange
• GetLocalFileChangeCount
• GetPublishedFileDetails
• GetPublishedItemVoteDetails
• GetQuota
• GetSyncPlatforms
• GetUGCDetails
• GetUGCDownloadProgress
• GetUserPublishedItemVoteDetails
• IsCloudEnabledForAccount
• IsCloudEnabledForApp
• PublishVideo
• PublishWorkshopFile
• SetCloudEnabledForApp
• SetSyncPlatforms
• SetUserPublishedFileAction
• SubscribePublishedFile
• UGCDownload
• UGCDownloadToLocation
• UGCRead
• UnsubscribePublishedFile
• UpdatePublishedFileDescription
• UpdatePublishedFileFile
• UpdatePublishedFilePreviewFile
• UpdatePublishedFileSetChangeDescription
• UpdatePublishedFileTags
• UpdatePublishedFileTitle
• UpdatePublishedFileVisibility
• UpdateUserPublishedItemVote

Properties

BeginFileWriteBatch

• BeginFileWriteBatch: () => boolean

Type declaration

▸ (): boolean

Returns

boolean

Defined in

index.d.ts:2537

---

CommitPublishedFileUpdate

• CommitPublishedFileUpdate: (updateHandle: bigint) => Promise<{ m_bUserNeedsToAcceptWorkshopLegalAgreement: boolean ; m_eResult: EResult ; m_nPublishedFileId: bigint }>

Type declaration

▸ (updateHandle): Promise<{ m_bUserNeedsToAcceptWorkshopLegalAgreement: boolean ; m_eResult: EResult ; m_nPublishedFileId: bigint }>

Parameters

Name	Type
updateHandle	bigint

Returns

Promise<{ m_bUserNeedsToAcceptWorkshopLegalAgreement: boolean ; m_eResult: EResult ; m_nPublishedFileId: bigint }>

Defined in

index.d.ts:2518

---

CreatePublishedFileUpdateRequest

• CreatePublishedFileUpdateRequest: (unPublishedFileId: bigint) => bigint

Type declaration

▸ (unPublishedFileId): bigint

Parameters

Name	Type
unPublishedFileId	bigint

Returns

bigint

Defined in

index.d.ts:2511

---

DeletePublishedFile

• DeletePublishedFile: (unPublishedFileId: bigint) => Promise<{ m_eResult: EResult ; m_nPublishedFileId: bigint }>

Type declaration

▸ (unPublishedFileId): Promise<{ m_eResult: EResult ; m_nPublishedFileId: bigint }>

Parameters

Name	Type
unPublishedFileId	bigint

Returns

Promise<{ m_eResult: EResult ; m_nPublishedFileId: bigint }>

Defined in

index.d.ts:2520

---

EndFileWriteBatch

• EndFileWriteBatch: () => boolean

Type declaration

▸ (): boolean

Returns

boolean

Defined in

index.d.ts:2538

---

EnumeratePublishedFilesByUserAction

• EnumeratePublishedFilesByUserAction: (eAction: EWorkshopFileAction, unStartIndex: number) => Promise<{ m_eAction: EWorkshopFileAction ; m_eResult: EResult ; m_nResultsReturned: number ; m_nTotalResultCount: number ; m_rgPublishedFileId: bigint[] ; m_rgRTimeUpdated: unknown }>

Type declaration

▸ (eAction, unStartIndex): Promise<{ m_eAction: EWorkshopFileAction ; m_eResult: EResult ; m_nResultsReturned: number ; m_nTotalResultCount: number ; m_rgPublishedFileId: bigint[] ; m_rgRTimeUpdated: unknown }>

Parameters

Name	Type
eAction	EWorkshopFileAction
unStartIndex	number

Returns

Promise<{ m_eAction: EWorkshopFileAction ; m_eResult: EResult ; m_nResultsReturned: number ; m_nTotalResultCount: number ; m_rgPublishedFileId: bigint[] ; m_rgRTimeUpdated: unknown }>

Defined in

index.d.ts:2532

---

EnumeratePublishedWorkshopFiles

• EnumeratePublishedWorkshopFiles: (eEnumerationType: EWorkshopEnumerationType, unStartIndex: number, unCount: number, unDays: number, pTags: SteamParamStringArray_t, pUserTags: SteamParamStringArray_t) => Promise<{ m_eResult: EResult ; m_nAppId: number ; m_nResultsReturned: number ; m_nTotalResultCount: number ; m_rgPublishedFileId: bigint[] ; m_rgScore: unknown ; m_unStartIndex: number }>

Type declaration

▸ (eEnumerationType, unStartIndex, unCount, unDays, pTags, pUserTags): Promise<{ m_eResult: EResult ; m_nAppId: number ; m_nResultsReturned: number ; m_nTotalResultCount: number ; m_rgPublishedFileId: bigint[] ; m_rgScore: unknown ; m_unStartIndex: number }>

Parameters

Name	Type
eEnumerationType	EWorkshopEnumerationType
unStartIndex	number
unCount	number
unDays	number
pTags	SteamParamStringArray_t
pUserTags	SteamParamStringArray_t

Returns

Promise<{ m_eResult: EResult ; m_nAppId: number ; m_nResultsReturned: number ; m_nTotalResultCount: number ; m_rgPublishedFileId: bigint[] ; m_rgScore: unknown ; m_unStartIndex: number }>

Defined in

index.d.ts:2533

---

EnumerateUserPublishedFiles

• EnumerateUserPublishedFiles: (unStartIndex: number) => Promise<{ m_eResult: EResult ; m_nResultsReturned: number ; m_nTotalResultCount: number ; m_rgPublishedFileId: bigint[] }>

Type declaration

▸ (unStartIndex): Promise<{ m_eResult: EResult ; m_nResultsReturned: number ; m_nTotalResultCount: number ; m_rgPublishedFileId: bigint[] }>

Parameters

Name	Type
unStartIndex	number

Returns

Promise<{ m_eResult: EResult ; m_nResultsReturned: number ; m_nTotalResultCount: number ; m_rgPublishedFileId: bigint[] }>

Defined in

index.d.ts:2521

---

EnumerateUserSharedWorkshopFiles

• EnumerateUserSharedWorkshopFiles: (steamId: CSteamID, unStartIndex: number, pRequiredTags: SteamParamStringArray_t, pExcludedTags: SteamParamStringArray_t) => Promise<{ m_eResult: EResult ; m_nResultsReturned: number ; m_nTotalResultCount: number ; m_rgPublishedFileId: bigint[] }>

Type declaration

▸ (steamId, unStartIndex, pRequiredTags, pExcludedTags): Promise<{ m_eResult: EResult ; m_nResultsReturned: number ; m_nTotalResultCount: number ; m_rgPublishedFileId: bigint[] }>

Parameters

Name	Type
steamId	CSteamID
unStartIndex	number
pRequiredTags	SteamParamStringArray_t
pExcludedTags	SteamParamStringArray_t

Returns

Promise<{ m_eResult: EResult ; m_nResultsReturned: number ; m_nTotalResultCount: number ; m_rgPublishedFileId: bigint[] }>

Defined in

index.d.ts:2529

---

EnumerateUserSubscribedFiles

• EnumerateUserSubscribedFiles: (unStartIndex: number) => Promise<{ m_eResult: EResult ; m_nResultsReturned: number ; m_nTotalResultCount: number ; m_rgPublishedFileId: bigint[] ; m_rgRTimeSubscribed: unknown }>

Type declaration

▸ (unStartIndex): Promise<{ m_eResult: EResult ; m_nResultsReturned: number ; m_nTotalResultCount: number ; m_rgPublishedFileId: bigint[] ; m_rgRTimeSubscribed: unknown }>

Parameters

Name	Type
unStartIndex	number

Returns

Promise<{ m_eResult: EResult ; m_nResultsReturned: number ; m_nTotalResultCount: number ; m_rgPublishedFileId: bigint[] ; m_rgRTimeSubscribed: unknown }>

Defined in

index.d.ts:2523

---

FileDelete

• FileDelete: (pchFile: string) => boolean

Type declaration

▸ (pchFile): boolean

Parameters

Name	Type
pchFile	string

Returns

boolean

Defined in

index.d.ts:2486

---

FileExists

• FileExists: (pchFile: string) => boolean

Type declaration

▸ (pchFile): boolean

Parameters

Name	Type
pchFile	string

Returns

boolean

Defined in

index.d.ts:2493

---

FileForget

• FileForget: (pchFile: string) => boolean

Type declaration

▸ (pchFile): boolean

Parameters

Name	Type
pchFile	string

Returns

boolean

Defined in

index.d.ts:2485

---

FilePersisted

• FilePersisted: (pchFile: string) => boolean

Type declaration

▸ (pchFile): boolean

Parameters

Name	Type
pchFile	string

Returns

boolean

Defined in

index.d.ts:2494

---

FileRead

• FileRead: (pchFile: string, pvData: unknown, cubDataToRead: number) => number

Type declaration

▸ (pchFile, pvData, cubDataToRead): number

Parameters

Name	Type
pchFile	string
pvData	unknown
cubDataToRead	number

Returns

number

Defined in

index.d.ts:2481

---

FileReadAsync

• FileReadAsync: (pchFile: string, nOffset: number, cubToRead: number) => Promise<{ m_cubRead: number ; m_eResult: EResult ; m_hFileReadAsync: bigint ; m_nOffset: number }>

Type declaration

▸ (pchFile, nOffset, cubToRead): Promise<{ m_cubRead: number ; m_eResult: EResult ; m_hFileReadAsync: bigint ; m_nOffset: number }>

Parameters

Name	Type
pchFile	string
nOffset	number
cubToRead	number

Returns

Promise<{ m_cubRead: number ; m_eResult: EResult ; m_hFileReadAsync: bigint ; m_nOffset: number }>

Defined in

index.d.ts:2483

---

FileReadAsyncComplete

• FileReadAsyncComplete: (hReadCall: bigint, pvBuffer: unknown, cubToRead: number) => boolean

Type declaration

▸ (hReadCall, pvBuffer, cubToRead): boolean

Parameters

Name	Type
hReadCall	bigint
pvBuffer	unknown
cubToRead	number

Returns

boolean

Defined in

index.d.ts:2484

---

FileShare

• FileShare: (pchFile: string) => Promise<{ m_eResult: EResult ; m_hFile: bigint ; m_rgchFilename: string }>

Type declaration

▸ (pchFile): Promise<{ m_eResult: EResult ; m_hFile: bigint ; m_rgchFilename: string }>

Parameters

Name	Type
pchFile	string

Returns

Promise<{ m_eResult: EResult ; m_hFile: bigint ; m_rgchFilename: string }>

Defined in

index.d.ts:2487

---

FileWrite

• FileWrite: (pchFile: string, pvData: unknown, cubData: number) => boolean

Type declaration

▸ (pchFile, pvData, cubData): boolean

Parameters

Name	Type
pchFile	string
pvData	unknown
cubData	number

Returns

boolean

Defined in

index.d.ts:2480

---

FileWriteAsync

• FileWriteAsync: (pchFile: string, pvData: unknown, cubData: number) => Promise<{ m_eResult: EResult }>

Type declaration

▸ (pchFile, pvData, cubData): Promise<{ m_eResult: EResult }>

Parameters

Name	Type
pchFile	string
pvData	unknown
cubData	number

Returns

Promise<{ m_eResult: EResult }>

Defined in

index.d.ts:2482

---

FileWriteStreamCancel

• FileWriteStreamCancel: (writeHandle: bigint) => boolean

Type declaration

▸ (writeHandle): boolean

Parameters

Name	Type
writeHandle	bigint

Returns

boolean

Defined in

index.d.ts:2492

---

FileWriteStreamClose

• FileWriteStreamClose: (writeHandle: bigint) => boolean

Type declaration

▸ (writeHandle): boolean

Parameters

Name	Type
writeHandle	bigint

Returns

boolean

Defined in

index.d.ts:2491

---

FileWriteStreamOpen

• FileWriteStreamOpen: (pchFile: string) => bigint

Type declaration

▸ (pchFile): bigint

Parameters

Name	Type
pchFile	string

Returns

bigint

Defined in

index.d.ts:2489

---

FileWriteStreamWriteChunk

• FileWriteStreamWriteChunk: (writeHandle: bigint, pvData: unknown, cubData: number) => boolean

Type declaration

▸ (writeHandle, pvData, cubData): boolean

Parameters

Name	Type
writeHandle	bigint
pvData	unknown
cubData	number

Returns

boolean

Defined in

index.d.ts:2490

---

GetCachedUGCCount

• GetCachedUGCCount: () => number

Type declaration

▸ (): number

Returns

number

Defined in

index.d.ts:2508

---

GetCachedUGCHandle

• GetCachedUGCHandle: (iCachedContent: number) => bigint

Type declaration

▸ (iCachedContent): bigint

Parameters

Name	Type
iCachedContent	number

Returns

bigint

Defined in

index.d.ts:2509

---

GetFileCount

• GetFileCount: () => number

Type declaration

▸ (): number

Returns

number

Defined in

index.d.ts:2498

---

GetFileNameAndSize

• GetFileNameAndSize: (iFile: number, pnFileSizeInBytes: number) => string

Type declaration

▸ (iFile, pnFileSizeInBytes): string

Parameters

Name	Type
iFile	number
pnFileSizeInBytes	number

Returns

string

Defined in

index.d.ts:2499

---

GetFileSize

• GetFileSize: (pchFile: string) => number

Type declaration

▸ (pchFile): number

Parameters

Name	Type
pchFile	string

Returns

number

Defined in

index.d.ts:2495

---

GetFileTimestamp

• GetFileTimestamp: (pchFile: string) => number

Type declaration

▸ (pchFile): number

Parameters

Name	Type
pchFile	string

Returns

number

Defined in

index.d.ts:2496

---

GetLocalFileChange

• GetLocalFileChange: (iFile: number, pEChangeType: unknown, pEFilePathType: unknown) => string

Type declaration

▸ (iFile, pEChangeType, pEFilePathType): string

Parameters

Name	Type
iFile	number
pEChangeType	unknown
pEFilePathType	unknown

Returns

string

Defined in

index.d.ts:2536

---

GetLocalFileChangeCount

• GetLocalFileChangeCount: () => number

Type declaration

▸ (): number

Returns

number

Defined in

index.d.ts:2535

---

GetPublishedFileDetails

• GetPublishedFileDetails: (unPublishedFileId: bigint, unMaxSecondsOld: number) => Promise<{ m_bAcceptedForUse: boolean ; m_bBanned: boolean ; m_bTagsTruncated: boolean ; m_eFileType: EWorkshopFileType ; m_eResult: EResult ; m_eVisibility: ERemoteStoragePublishedFileVisibility ; m_hFile: bigint ; m_hPreviewFile: bigint ; m_nConsumerAppID: number ; m_nCreatorAppID: number ; m_nFileSize: number ; m_nPreviewFileSize: number ; m_nPublishedFileId: bigint ; m_pchFileName: string ; m_rgchDescription: string ; m_rgchTags: string ; m_rgchTitle: string ; m_rgchURL: string ; m_rtimeCreated: number ; m_rtimeUpdated: number ; m_ulSteamIDOwner: bigint }>

Type declaration

▸ (unPublishedFileId, unMaxSecondsOld): Promise<{ m_bAcceptedForUse: boolean ; m_bBanned: boolean ; m_bTagsTruncated: boolean ; m_eFileType: EWorkshopFileType ; m_eResult: EResult ; m_eVisibility: ERemoteStoragePublishedFileVisibility ; m_hFile: bigint ; m_hPreviewFile: bigint ; m_nConsumerAppID: number ; m_nCreatorAppID: number ; m_nFileSize: number ; m_nPreviewFileSize: number ; m_nPublishedFileId: bigint ; m_pchFileName: string ; m_rgchDescription: string ; m_rgchTags: string ; m_rgchTitle: string ; m_rgchURL: string ; m_rtimeCreated: number ; m_rtimeUpdated: number ; m_ulSteamIDOwner: bigint }>

Parameters

Name	Type
unPublishedFileId	bigint
unMaxSecondsOld	number

Returns

Promise<{ m_bAcceptedForUse: boolean ; m_bBanned: boolean ; m_bTagsTruncated: boolean ; m_eFileType: EWorkshopFileType ; m_eResult: EResult ; m_eVisibility: ERemoteStoragePublishedFileVisibility ; m_hFile: bigint ; m_hPreviewFile: bigint ; m_nConsumerAppID: number ; m_nCreatorAppID: number ; m_nFileSize: number ; m_nPreviewFileSize: number ; m_nPublishedFileId: bigint ; m_pchFileName: string ; m_rgchDescription: string ; m_rgchTags: string ; m_rgchTitle: string ; m_rgchURL: string ; m_rtimeCreated: number ; m_rtimeUpdated: number ; m_ulSteamIDOwner: bigint }>

Defined in

index.d.ts:2519

---

GetPublishedItemVoteDetails

• GetPublishedItemVoteDetails: (unPublishedFileId: bigint) => Promise<{ m_eResult: EResult ; m_fScore: number ; m_nReports: number ; m_nVotesAgainst: number ; m_nVotesFor: number ; m_unPublishedFileId: bigint }>

Type declaration

▸ (unPublishedFileId): Promise<{ m_eResult: EResult ; m_fScore: number ; m_nReports: number ; m_nVotesAgainst: number ; m_nVotesFor: number ; m_unPublishedFileId: bigint }>

Parameters

Name	Type
unPublishedFileId	bigint

Returns

Promise<{ m_eResult: EResult ; m_fScore: number ; m_nReports: number ; m_nVotesAgainst: number ; m_nVotesFor: number ; m_unPublishedFileId: bigint }>

Defined in

index.d.ts:2526

---

GetQuota

• GetQuota: (pnTotalBytes: bigint, puAvailableBytes: bigint) => boolean

Type declaration

▸ (pnTotalBytes, puAvailableBytes): boolean

Parameters

Name	Type
pnTotalBytes	bigint
puAvailableBytes	bigint

Returns

boolean

Defined in

index.d.ts:2500

---

GetSyncPlatforms

• GetSyncPlatforms: (pchFile: string) => ERemoteStoragePlatform

Type declaration

▸ (pchFile): ERemoteStoragePlatform

Parameters

Name	Type
pchFile	string

Returns

ERemoteStoragePlatform

Defined in

index.d.ts:2497

---

GetUGCDetails

• GetUGCDetails: (hContent: bigint, pnAppID: unknown, ppchName: unknown, pnFileSizeInBytes: number, pSteamIDOwner: unknown) => boolean

Type declaration

▸ (hContent, pnAppID, ppchName, pnFileSizeInBytes, pSteamIDOwner): boolean

Parameters

Name	Type
hContent	bigint
pnAppID	unknown
ppchName	unknown
pnFileSizeInBytes	number
pSteamIDOwner	unknown

Returns

boolean

Defined in

index.d.ts:2506

---

GetUGCDownloadProgress

• GetUGCDownloadProgress: (hContent: bigint, pnBytesDownloaded: number, pnBytesExpected: number) => boolean

Type declaration

▸ (hContent, pnBytesDownloaded, pnBytesExpected): boolean

Parameters

Name	Type
hContent	bigint
pnBytesDownloaded	number
pnBytesExpected	number

Returns

boolean

Defined in

index.d.ts:2505

---

GetUserPublishedItemVoteDetails

• GetUserPublishedItemVoteDetails: (unPublishedFileId: bigint) => Promise<{ m_eResult: EResult ; m_fScore: number ; m_nReports: number ; m_nVotesAgainst: number ; m_nVotesFor: number ; m_unPublishedFileId: bigint }>

Type declaration

▸ (unPublishedFileId): Promise<{ m_eResult: EResult ; m_fScore: number ; m_nReports: number ; m_nVotesAgainst: number ; m_nVotesFor: number ; m_unPublishedFileId: bigint }>

Parameters

Name	Type
unPublishedFileId	bigint

Returns

Promise<{ m_eResult: EResult ; m_fScore: number ; m_nReports: number ; m_nVotesAgainst: number ; m_nVotesFor: number ; m_unPublishedFileId: bigint }>

Defined in

index.d.ts:2528

---

IsCloudEnabledForAccount

• IsCloudEnabledForAccount: () => boolean

Type declaration

▸ (): boolean

Returns

boolean

Defined in

index.d.ts:2501

---

IsCloudEnabledForApp

• IsCloudEnabledForApp: () => boolean

Type declaration

▸ (): boolean

Returns

boolean

Defined in

index.d.ts:2502

---

PublishVideo

• PublishVideo: (eVideoProvider: EWorkshopVideoProvider, pchVideoAccount: string, pchVideoIdentifier: string, pchPreviewFile: string, nConsumerAppId: number, pchTitle: string, pchDescription: string, eVisibility: ERemoteStoragePublishedFileVisibility, pTags: SteamParamStringArray_t) => Promise<{ m_bPreview: boolean ; m_dPercentFile: number }>

Type declaration

▸ (eVideoProvider, pchVideoAccount, pchVideoIdentifier, pchPreviewFile, nConsumerAppId, pchTitle, pchDescription, eVisibility, pTags): Promise<{ m_bPreview: boolean ; m_dPercentFile: number }>

Parameters

Name	Type
eVideoProvider	EWorkshopVideoProvider
pchVideoAccount	string
pchVideoIdentifier	string
pchPreviewFile	string
nConsumerAppId	number
pchTitle	string
pchDescription	string
eVisibility	ERemoteStoragePublishedFileVisibility
pTags	SteamParamStringArray_t

Returns

Promise<{ m_bPreview: boolean ; m_dPercentFile: number }>

Defined in

index.d.ts:2530

---

PublishWorkshopFile

• PublishWorkshopFile: (pchFile: string, pchPreviewFile: string, nConsumerAppId: number, pchTitle: string, pchDescription: string, eVisibility: ERemoteStoragePublishedFileVisibility, pTags: SteamParamStringArray_t, eWorkshopFileType: EWorkshopFileType) => Promise<{ m_bPreview: boolean ; m_dPercentFile: number }>

Type declaration

▸ (pchFile, pchPreviewFile, nConsumerAppId, pchTitle, pchDescription, eVisibility, pTags, eWorkshopFileType): Promise<{ m_bPreview: boolean ; m_dPercentFile: number }>

Parameters

Name	Type
pchFile	string
pchPreviewFile	string
nConsumerAppId	number
pchTitle	string
pchDescription	string
eVisibility	ERemoteStoragePublishedFileVisibility
pTags	SteamParamStringArray_t
eWorkshopFileType	EWorkshopFileType

Returns

Promise<{ m_bPreview: boolean ; m_dPercentFile: number }>

Defined in

index.d.ts:2510

---

SetCloudEnabledForApp

• SetCloudEnabledForApp: (bEnabled: boolean) => undefined

Type declaration

▸ (bEnabled): undefined

Parameters

Name	Type
bEnabled	boolean

Returns

undefined

Defined in

index.d.ts:2503

---

SetSyncPlatforms

• SetSyncPlatforms: (pchFile: string, eRemoteStoragePlatform: ERemoteStoragePlatform) => boolean

Type declaration

▸ (pchFile, eRemoteStoragePlatform): boolean

Parameters

Name	Type
pchFile	string
eRemoteStoragePlatform	ERemoteStoragePlatform

Returns

boolean

Defined in

index.d.ts:2488

---

SetUserPublishedFileAction

• SetUserPublishedFileAction: (unPublishedFileId: bigint, eAction: EWorkshopFileAction) => Promise<{ m_eAction: EWorkshopFileAction ; m_eResult: EResult ; m_nPublishedFileId: bigint }>

Type declaration

▸ (unPublishedFileId, eAction): Promise<{ m_eAction: EWorkshopFileAction ; m_eResult: EResult ; m_nPublishedFileId: bigint }>

Parameters

Name	Type
unPublishedFileId	bigint
eAction	EWorkshopFileAction

Returns

Promise<{ m_eAction: EWorkshopFileAction ; m_eResult: EResult ; m_nPublishedFileId: bigint }>

Defined in

index.d.ts:2531

---

SubscribePublishedFile

• SubscribePublishedFile: (unPublishedFileId: bigint) => Promise<{ m_eResult: EResult ; m_nPublishedFileId: bigint }>

Type declaration

▸ (unPublishedFileId): Promise<{ m_eResult: EResult ; m_nPublishedFileId: bigint }>

Parameters

Name	Type
unPublishedFileId	bigint

Returns

Promise<{ m_eResult: EResult ; m_nPublishedFileId: bigint }>

Defined in

index.d.ts:2522

---

UGCDownload

• UGCDownload: (hContent: bigint, unPriority: number) => Promise<{ m_eResult: EResult ; m_hFile: bigint ; m_nAppID: number ; m_nSizeInBytes: number ; m_pchFileName: string ; m_ulSteamIDOwner: bigint }>

Type declaration

▸ (hContent, unPriority): Promise<{ m_eResult: EResult ; m_hFile: bigint ; m_nAppID: number ; m_nSizeInBytes: number ; m_pchFileName: string ; m_ulSteamIDOwner: bigint }>

Parameters

Name	Type
hContent	bigint
unPriority	number

Returns

Promise<{ m_eResult: EResult ; m_hFile: bigint ; m_nAppID: number ; m_nSizeInBytes: number ; m_pchFileName: string ; m_ulSteamIDOwner: bigint }>

Defined in

index.d.ts:2504

---

UGCDownloadToLocation

• UGCDownloadToLocation: (hContent: bigint, pchLocation: string, unPriority: number) => Promise<{ m_eResult: EResult ; m_hFile: bigint ; m_nAppID: number ; m_nSizeInBytes: number ; m_pchFileName: string ; m_ulSteamIDOwner: bigint }>

Type declaration

▸ (hContent, pchLocation, unPriority): Promise<{ m_eResult: EResult ; m_hFile: bigint ; m_nAppID: number ; m_nSizeInBytes: number ; m_pchFileName: string ; m_ulSteamIDOwner: bigint }>

Parameters

Name	Type
hContent	bigint
pchLocation	string
unPriority	number

Returns

Promise<{ m_eResult: EResult ; m_hFile: bigint ; m_nAppID: number ; m_nSizeInBytes: number ; m_pchFileName: string ; m_ulSteamIDOwner: bigint }>

Defined in

index.d.ts:2534

---

UGCRead

• UGCRead: (hContent: bigint, pvData: unknown, cubDataToRead: number, cOffset: number, eAction: EUGCReadAction) => number

Type declaration

▸ (hContent, pvData, cubDataToRead, cOffset, eAction): number

Parameters

Name	Type
hContent	bigint
pvData	unknown
cubDataToRead	number
cOffset	number
eAction	EUGCReadAction

Returns

number

Defined in

index.d.ts:2507

---

UnsubscribePublishedFile

• UnsubscribePublishedFile: (unPublishedFileId: bigint) => Promise<{ m_eResult: EResult ; m_nPublishedFileId: bigint }>

Type declaration

▸ (unPublishedFileId): Promise<{ m_eResult: EResult ; m_nPublishedFileId: bigint }>

Parameters

Name	Type
unPublishedFileId	bigint

Returns

Promise<{ m_eResult: EResult ; m_nPublishedFileId: bigint }>

Defined in

index.d.ts:2524

---

UpdatePublishedFileDescription

• UpdatePublishedFileDescription: (updateHandle: bigint, pchDescription: string) => boolean

Type declaration

▸ (updateHandle, pchDescription): boolean

Parameters

Name	Type
updateHandle	bigint
pchDescription	string

Returns

boolean

Defined in

index.d.ts:2515

---

UpdatePublishedFileFile

• UpdatePublishedFileFile: (updateHandle: bigint, pchFile: string) => boolean

Type declaration

▸ (updateHandle, pchFile): boolean

Parameters

Name	Type
updateHandle	bigint
pchFile	string

Returns

boolean

Defined in

index.d.ts:2512

---

UpdatePublishedFilePreviewFile

• UpdatePublishedFilePreviewFile: (updateHandle: bigint, pchPreviewFile: string) => boolean

Type declaration

▸ (updateHandle, pchPreviewFile): boolean

Parameters

Name	Type
updateHandle	bigint
pchPreviewFile	string

Returns

boolean

Defined in

index.d.ts:2513

---

UpdatePublishedFileSetChangeDescription

• UpdatePublishedFileSetChangeDescription: (updateHandle: bigint, pchChangeDescription: string) => boolean

Type declaration

▸ (updateHandle, pchChangeDescription): boolean

Parameters

Name	Type
updateHandle	bigint
pchChangeDescription	string

Returns

boolean

Defined in

index.d.ts:2525

---

UpdatePublishedFileTags

• UpdatePublishedFileTags: (updateHandle: bigint, pTags: SteamParamStringArray_t) => boolean

Type declaration

▸ (updateHandle, pTags): boolean

Parameters

Name	Type
updateHandle	bigint
pTags	SteamParamStringArray_t

Returns

boolean

Defined in

index.d.ts:2517

---

UpdatePublishedFileTitle

• UpdatePublishedFileTitle: (updateHandle: bigint, pchTitle: string) => boolean

Type declaration

▸ (updateHandle, pchTitle): boolean

Parameters

Name	Type
updateHandle	bigint
pchTitle	string

Returns

boolean

Defined in

index.d.ts:2514

---

UpdatePublishedFileVisibility

• UpdatePublishedFileVisibility: (updateHandle: bigint, eVisibility: ERemoteStoragePublishedFileVisibility) => boolean

Type declaration

▸ (updateHandle, eVisibility): boolean

Parameters

Name	Type
updateHandle	bigint
eVisibility	ERemoteStoragePublishedFileVisibility

Returns

boolean

Defined in

index.d.ts:2516

---

UpdateUserPublishedItemVote

• UpdateUserPublishedItemVote: (unPublishedFileId: bigint, bVoteUp: boolean) => Promise<{ m_eResult: EResult ; m_nPublishedFileId: bigint }>

Type declaration

▸ (unPublishedFileId, bVoteUp): Promise<{ m_eResult: EResult ; m_nPublishedFileId: bigint }>

Parameters

Name	Type
unPublishedFileId	bigint
bVoteUp	boolean

Returns

Promise<{ m_eResult: EResult ; m_nPublishedFileId: bigint }>

Defined in

index.d.ts:2527