Interface: SteamUGC

SteamWorksNamespace.SteamUGC

Table of contents

Properties

• AddAppDependency
• AddDependency
• AddExcludedTag
• AddItemKeyValueTag
• AddItemPreviewFile
• AddItemPreviewVideo
• AddItemToFavorites
• AddRequiredKeyValueTag
• AddRequiredTag
• AddRequiredTagGroup
• BInitWorkshopForGameServer
• CreateItem
• CreateQueryAllUGCRequest
• CreateQueryUGCDetailsRequest
• CreateQueryUserUGCRequest
• DeleteItem
• DownloadItem
• GetAppDependencies
• GetItemDownloadInfo
• GetItemInstallInfo
• GetItemState
• GetItemUpdateProgress
• GetNumSubscribedItems
• GetQueryUGCAdditionalPreview
• GetQueryUGCChildren
• GetQueryUGCKeyValueTag
• GetQueryUGCMetadata
• GetQueryUGCNumAdditionalPreviews
• GetQueryUGCNumKeyValueTags
• GetQueryUGCNumTags
• GetQueryUGCPreviewURL
• GetQueryUGCResult
• GetQueryUGCStatistic
• GetQueryUGCTag
• GetQueryUGCTagDisplayName
• GetSubscribedItems
• GetUserItemVote
• GetWorkshopEULAStatus
• ReleaseQueryUGCRequest
• RemoveAllItemKeyValueTags
• RemoveAppDependency
• RemoveDependency
• RemoveItemFromFavorites
• RemoveItemKeyValueTags
• RemoveItemPreview
• RequestUGCDetails
• SendQueryUGCRequest
• SetAllowCachedResponse
• SetAllowLegacyUpload
• SetCloudFileNameFilter
• SetItemContent
• SetItemDescription
• SetItemMetadata
• SetItemPreview
• SetItemTags
• SetItemTitle
• SetItemUpdateLanguage
• SetItemVisibility
• SetLanguage
• SetMatchAnyTag
• SetRankedByTrendDays
• SetReturnAdditionalPreviews
• SetReturnChildren
• SetReturnKeyValueTags
• SetReturnLongDescription
• SetReturnMetadata
• SetReturnOnlyIDs
• SetReturnPlaytimeStats
• SetReturnTotalOnly
• SetSearchText
• SetTimeCreatedDateRange
• SetTimeUpdatedDateRange
• SetUserItemVote
• ShowWorkshopEULA
• StartItemUpdate
• StartPlaytimeTracking
• StopPlaytimeTracking
• StopPlaytimeTrackingForAllItems
• SubmitItemUpdate
• SubscribeItem
• SuspendDownloads
• UnsubscribeItem
• UpdateItemPreviewFile
• UpdateItemPreviewVideo

Properties

AddAppDependency

• AddAppDependency: (nPublishedFileID: bigint, nAppID: number) => Promise<{ m_eResult: EResult ; m_nAppID: number ; m_nPublishedFileId: bigint }>

Type declaration

▸ (nPublishedFileID, nAppID): Promise<{ m_eResult: EResult ; m_nAppID: number ; m_nPublishedFileId: bigint }>

Parameters

Name	Type
nPublishedFileID	bigint
nAppID	number

Returns

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

Defined in

index.d.ts:2738

---

AddDependency

• AddDependency: (nParentPublishedFileID: bigint, nChildPublishedFileID: bigint) => Promise<{ m_eResult: EResult ; m_nChildPublishedFileId: bigint ; m_nPublishedFileId: bigint }>

Type declaration

▸ (nParentPublishedFileID, nChildPublishedFileID): Promise<{ m_eResult: EResult ; m_nChildPublishedFileId: bigint ; m_nPublishedFileId: bigint }>

Parameters

Name	Type
nParentPublishedFileID	bigint
nChildPublishedFileID	bigint

Returns

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

Defined in

index.d.ts:2736

---

AddExcludedTag

• AddExcludedTag: (handle: bigint, pTagName: string) => boolean

Type declaration

▸ (handle, pTagName): boolean

Parameters

Name	Type
handle	bigint
pTagName	string

Returns

boolean

Defined in

index.d.ts:2679

---

AddItemKeyValueTag

• AddItemKeyValueTag: (handle: bigint, pchKey: string, pchValue: string) => boolean

Type declaration

▸ (handle, pchKey, pchValue): boolean

Parameters

Name	Type
handle	bigint
pchKey	string
pchValue	string

Returns

boolean

Defined in

index.d.ts:2711

---

AddItemPreviewFile

• AddItemPreviewFile: (handle: bigint, pszPreviewFile: string, type: EItemPreviewType) => boolean

Type declaration

▸ (handle, pszPreviewFile, type): boolean

Parameters

Name	Type
handle	bigint
pszPreviewFile	string
type	EItemPreviewType

Returns

boolean

Defined in

index.d.ts:2712

---

AddItemPreviewVideo

• AddItemPreviewVideo: (handle: bigint, pszVideoID: string) => boolean

Type declaration

▸ (handle, pszVideoID): boolean

Parameters

Name	Type
handle	bigint
pszVideoID	string

Returns

boolean

Defined in

index.d.ts:2713

---

AddItemToFavorites

• AddItemToFavorites: (nAppId: number, nPublishedFileID: bigint) => Promise<{ m_bWasAddRequest: boolean ; m_eResult: EResult ; m_nPublishedFileId: bigint }>

Type declaration

▸ (nAppId, nPublishedFileID): Promise<{ m_bWasAddRequest: boolean ; m_eResult: EResult ; m_nPublishedFileId: bigint }>

Parameters

Name	Type
nAppId	number
nPublishedFileID	bigint

Returns

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

Defined in

index.d.ts:2721

---

AddRequiredKeyValueTag

• AddRequiredKeyValueTag: (handle: bigint, pKey: string, pValue: string) => boolean

Type declaration

▸ (handle, pKey, pValue): boolean

Parameters

Name	Type
handle	bigint
pKey	string
pValue	string

Returns

boolean

Defined in

index.d.ts:2696

---

AddRequiredTag

• AddRequiredTag: (handle: bigint, pTagName: string) => boolean

Type declaration

▸ (handle, pTagName): boolean

Parameters

Name	Type
handle	bigint
pTagName	string

Returns

boolean

Defined in

index.d.ts:2677

---

AddRequiredTagGroup

• AddRequiredTagGroup: (handle: bigint, pTagGroups: unknown) => boolean

Type declaration

▸ (handle, pTagGroups): boolean

Parameters

Name	Type
handle	bigint
pTagGroups	unknown

Returns

boolean

Defined in

index.d.ts:2678

---

BInitWorkshopForGameServer

• BInitWorkshopForGameServer: (unWorkshopDepotID: number, pszFolder: string) => boolean

Type declaration

▸ (unWorkshopDepotID, pszFolder): boolean

Parameters

Name	Type
unWorkshopDepotID	number
pszFolder	string

Returns

boolean

Defined in

index.d.ts:2731

---

CreateItem

• CreateItem: (nConsumerAppId: number, eFileType: EWorkshopFileType) => Promise<{ m_bUserNeedsToAcceptWorkshopLegalAgreement: boolean ; m_eResult: EResult ; m_nPublishedFileId: bigint }>

Type declaration

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

Parameters

Name	Type
nConsumerAppId	number
eFileType	EWorkshopFileType

Returns

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

Defined in

index.d.ts:2698

---

CreateQueryAllUGCRequest

• CreateQueryAllUGCRequest: (eQueryType: EUGCQuery, eMatchingeMatchingUGCTypeFileType: EUGCMatchingUGCType, nCreatorAppID: number, nConsumerAppID: number, unPage: number) => bigint

Type declaration

▸ (eQueryType, eMatchingeMatchingUGCTypeFileType, nCreatorAppID, nConsumerAppID, unPage): bigint

Parameters

Name	Type
eQueryType	EUGCQuery
eMatchingeMatchingUGCTypeFileType	EUGCMatchingUGCType
nCreatorAppID	number
nConsumerAppID	number
unPage	number

Returns

bigint

Defined in

index.d.ts:2661

---

CreateQueryUGCDetailsRequest

• CreateQueryUGCDetailsRequest: (unNumPublishedFileIDs: number) => bigint

Type declaration

▸ (unNumPublishedFileIDs): bigint

Parameters

Name	Type
unNumPublishedFileIDs	number

Returns

bigint

Defined in

index.d.ts:2662

---

CreateQueryUserUGCRequest

• CreateQueryUserUGCRequest: (unAccountID: number, eListType: EUserUGCList, eMatchingUGCType: EUGCMatchingUGCType, eSortOrder: EUserUGCListSortOrder, nCreatorAppID: number, nConsumerAppID: number, unPage: number) => bigint

Type declaration

▸ (unAccountID, eListType, eMatchingUGCType, eSortOrder, nCreatorAppID, nConsumerAppID, unPage): bigint

Parameters

Name	Type
unAccountID	number
eListType	EUserUGCList
eMatchingUGCType	EUGCMatchingUGCType
eSortOrder	EUserUGCListSortOrder
nCreatorAppID	number
nConsumerAppID	number
unPage	number

Returns

bigint

Defined in

index.d.ts:2660

---

DeleteItem

• DeleteItem: (nPublishedFileID: bigint) => Promise<{ m_eResult: EResult ; m_nPublishedFileId: bigint }>

Type declaration

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

Parameters

Name	Type
nPublishedFileID	bigint

Returns

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

Defined in

index.d.ts:2741

---

DownloadItem

• DownloadItem: (nPublishedFileID: bigint, bHighPriority: boolean) => boolean

Type declaration

▸ (nPublishedFileID, bHighPriority): boolean

Parameters

Name	Type
nPublishedFileID	bigint
bHighPriority	boolean

Returns

boolean

Defined in

index.d.ts:2730

---

GetAppDependencies

• GetAppDependencies: (nPublishedFileID: bigint) => Promise<{ m_eResult: EResult ; m_nNumAppDependencies: number ; m_nPublishedFileId: bigint ; m_nTotalNumAppDependencies: number ; m_rgAppIDs: unknown }>

Type declaration

▸ (nPublishedFileID): Promise<{ m_eResult: EResult ; m_nNumAppDependencies: number ; m_nPublishedFileId: bigint ; m_nTotalNumAppDependencies: number ; m_rgAppIDs: unknown }>

Parameters

Name	Type
nPublishedFileID	bigint

Returns

Promise<{ m_eResult: EResult ; m_nNumAppDependencies: number ; m_nPublishedFileId: bigint ; m_nTotalNumAppDependencies: number ; m_rgAppIDs: unknown }>

Defined in

index.d.ts:2740

---

GetItemDownloadInfo

• GetItemDownloadInfo: (nPublishedFileID: bigint, punBytesDownloaded: bigint, punBytesTotal: bigint) => boolean

Type declaration

▸ (nPublishedFileID, punBytesDownloaded, punBytesTotal): boolean

Parameters

Name	Type
nPublishedFileID	bigint
punBytesDownloaded	bigint
punBytesTotal	bigint

Returns

boolean

Defined in

index.d.ts:2729

---

GetItemInstallInfo

• GetItemInstallInfo: (nPublishedFileID: bigint, punSizeOnDisk: bigint, pchFolder: string, cchFolderSize: number, punTimeStamp: number) => boolean

Type declaration

▸ (nPublishedFileID, punSizeOnDisk, pchFolder, cchFolderSize, punTimeStamp): boolean

Parameters

Name	Type
nPublishedFileID	bigint
punSizeOnDisk	bigint
pchFolder	string
cchFolderSize	number
punTimeStamp	number

Returns

boolean

Defined in

index.d.ts:2728

---

GetItemState

• GetItemState: (nPublishedFileID: bigint) => number

Type declaration

▸ (nPublishedFileID): number

Parameters

Name	Type
nPublishedFileID	bigint

Returns

number

Defined in

index.d.ts:2727

---

GetItemUpdateProgress

• GetItemUpdateProgress: (handle: bigint, punBytesProcessed: bigint, punBytesTotal: bigint) => EItemUpdateStatus

Type declaration

▸ (handle, punBytesProcessed, punBytesTotal): EItemUpdateStatus

Parameters

Name	Type
handle	bigint
punBytesProcessed	bigint
punBytesTotal	bigint

Returns

EItemUpdateStatus

Defined in

index.d.ts:2718

---

GetNumSubscribedItems

• GetNumSubscribedItems: () => number

Type declaration

▸ (): number

Returns

number

Defined in

index.d.ts:2725

---

GetQueryUGCAdditionalPreview

• GetQueryUGCAdditionalPreview: (handle: bigint, index: number, previewIndex: number, pchURLOrVideoID: string, cchURLSize: number, pchOriginalFileName: string, cchOriginalFileNameSize: number, pPreviewType: unknown) => boolean

Type declaration

▸ (handle, index, previewIndex, pchURLOrVideoID, cchURLSize, pchOriginalFileName, cchOriginalFileNameSize, pPreviewType): boolean

Parameters

Name	Type
handle	bigint
index	number
previewIndex	number
pchURLOrVideoID	string
cchURLSize	number
pchOriginalFileName	string
cchOriginalFileNameSize	number
pPreviewType	unknown

Returns

boolean

Defined in

index.d.ts:2673

---

GetQueryUGCChildren

• GetQueryUGCChildren: (handle: bigint, index: number, cMaxEntries: number) => boolean

Type declaration

▸ (handle, index, cMaxEntries): boolean

Parameters

Name	Type
handle	bigint
index	number
cMaxEntries	number

Returns

boolean

Defined in

index.d.ts:2670

---

GetQueryUGCKeyValueTag

• GetQueryUGCKeyValueTag: (handle: bigint, index: number, keyValueTagIndex: number, pchKey: string, cchKeySize: number, pchValue: string, cchValueSize: number) => boolean

Type declaration

▸ (handle, index, keyValueTagIndex, pchKey, cchKeySize, pchValue, cchValueSize): boolean

Parameters

Name	Type
handle	bigint
index	number
keyValueTagIndex	number
pchKey	string
cchKeySize	number
pchValue	string
cchValueSize	number

Returns

boolean

Defined in

index.d.ts:2675

---

GetQueryUGCMetadata

• GetQueryUGCMetadata: (handle: bigint, index: number, pchMetadata: string, cchMetadatasize: number) => boolean

Type declaration

▸ (handle, index, pchMetadata, cchMetadatasize): boolean

Parameters

Name	Type
handle	bigint
index	number
pchMetadata	string
cchMetadatasize	number

Returns

boolean

Defined in

index.d.ts:2669

---

GetQueryUGCNumAdditionalPreviews

• GetQueryUGCNumAdditionalPreviews: (handle: bigint, index: number) => number

Type declaration

▸ (handle, index): number

Parameters

Name	Type
handle	bigint
index	number

Returns

number

Defined in

index.d.ts:2672

---

GetQueryUGCNumKeyValueTags

• GetQueryUGCNumKeyValueTags: (handle: bigint, index: number) => number

Type declaration

▸ (handle, index): number

Parameters

Name	Type
handle	bigint
index	number

Returns

number

Defined in

index.d.ts:2674

---

GetQueryUGCNumTags

• GetQueryUGCNumTags: (handle: bigint, index: number) => number

Type declaration

▸ (handle, index): number

Parameters

Name	Type
handle	bigint
index	number

Returns

number

Defined in

index.d.ts:2665

---

GetQueryUGCPreviewURL

• GetQueryUGCPreviewURL: (handle: bigint, index: number, pchURL: string, cchURLSize: number) => boolean

Type declaration

▸ (handle, index, pchURL, cchURLSize): boolean

Parameters

Name	Type
handle	bigint
index	number
pchURL	string
cchURLSize	number

Returns

boolean

Defined in

index.d.ts:2668

---

GetQueryUGCResult

• GetQueryUGCResult: (handle: bigint, index: number, pDetails: SteamUGCDetails_t) => boolean

Type declaration

▸ (handle, index, pDetails): boolean

Parameters

Name	Type
handle	bigint
index	number
pDetails	SteamUGCDetails_t

Returns

boolean

Defined in

index.d.ts:2664

---

GetQueryUGCStatistic

• GetQueryUGCStatistic: (handle: bigint, index: number, eStatType: EItemStatistic, pStatValue: bigint) => boolean

Type declaration

▸ (handle, index, eStatType, pStatValue): boolean

Parameters

Name	Type
handle	bigint
index	number
eStatType	EItemStatistic
pStatValue	bigint

Returns

boolean

Defined in

index.d.ts:2671

---

GetQueryUGCTag

• GetQueryUGCTag: (handle: bigint, index: number, indexTag: number, pchValue: string, cchValueSize: number) => boolean

Type declaration

▸ (handle, index, indexTag, pchValue, cchValueSize): boolean

Parameters

Name	Type
handle	bigint
index	number
indexTag	number
pchValue	string
cchValueSize	number

Returns

boolean

Defined in

index.d.ts:2666

---

GetQueryUGCTagDisplayName

• GetQueryUGCTagDisplayName: (handle: bigint, index: number, indexTag: number, pchValue: string, cchValueSize: number) => boolean

Type declaration

▸ (handle, index, indexTag, pchValue, cchValueSize): boolean

Parameters

Name	Type
handle	bigint
index	number
indexTag	number
pchValue	string
cchValueSize	number

Returns

boolean

Defined in

index.d.ts:2667

---

GetSubscribedItems

• GetSubscribedItems: (cMaxEntries: number) => number

Type declaration

▸ (cMaxEntries): number

Parameters

Name	Type
cMaxEntries	number

Returns

number

Defined in

index.d.ts:2726

---

GetUserItemVote

• GetUserItemVote: (nPublishedFileID: bigint) => Promise<{ m_bVoteSkipped: boolean ; m_bVotedDown: boolean ; m_bVotedUp: boolean ; m_eResult: EResult ; m_nPublishedFileId: bigint }>

Type declaration

▸ (nPublishedFileID): Promise<{ m_bVoteSkipped: boolean ; m_bVotedDown: boolean ; m_bVotedUp: boolean ; m_eResult: EResult ; m_nPublishedFileId: bigint }>

Parameters

Name	Type
nPublishedFileID	bigint

Returns

Promise<{ m_bVoteSkipped: boolean ; m_bVotedDown: boolean ; m_bVotedUp: boolean ; m_eResult: EResult ; m_nPublishedFileId: bigint }>

Defined in

index.d.ts:2720

---

GetWorkshopEULAStatus

• GetWorkshopEULAStatus: () => Promise<{ m_bAccepted: boolean ; m_bNeedsAction: boolean ; m_eResult: EResult ; m_nAppID: number ; m_rtAction: number ; m_unVersion: number }>

Type declaration

▸ (): Promise<{ m_bAccepted: boolean ; m_bNeedsAction: boolean ; m_eResult: EResult ; m_nAppID: number ; m_rtAction: number ; m_unVersion: number }>

Returns

Promise<{ m_bAccepted: boolean ; m_bNeedsAction: boolean ; m_eResult: EResult ; m_nAppID: number ; m_rtAction: number ; m_unVersion: number }>

Defined in

index.d.ts:2743

---

ReleaseQueryUGCRequest

• ReleaseQueryUGCRequest: (handle: bigint) => boolean

Type declaration

▸ (handle): boolean

Parameters

Name	Type
handle	bigint

Returns

boolean

Defined in

index.d.ts:2676

---

RemoveAllItemKeyValueTags

• RemoveAllItemKeyValueTags: (handle: bigint) => boolean

Type declaration

▸ (handle): boolean

Parameters

Name	Type
handle	bigint

Returns

boolean

Defined in

index.d.ts:2709

---

RemoveAppDependency

• RemoveAppDependency: (nPublishedFileID: bigint, nAppID: number) => Promise<{ m_eResult: EResult ; m_nAppID: number ; m_nPublishedFileId: bigint }>

Type declaration

▸ (nPublishedFileID, nAppID): Promise<{ m_eResult: EResult ; m_nAppID: number ; m_nPublishedFileId: bigint }>

Parameters

Name	Type
nPublishedFileID	bigint
nAppID	number

Returns

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

Defined in

index.d.ts:2739

---

RemoveDependency

• RemoveDependency: (nParentPublishedFileID: bigint, nChildPublishedFileID: bigint) => Promise<{ m_eResult: EResult ; m_nChildPublishedFileId: bigint ; m_nPublishedFileId: bigint }>

Type declaration

▸ (nParentPublishedFileID, nChildPublishedFileID): Promise<{ m_eResult: EResult ; m_nChildPublishedFileId: bigint ; m_nPublishedFileId: bigint }>

Parameters

Name	Type
nParentPublishedFileID	bigint
nChildPublishedFileID	bigint

Returns

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

Defined in

index.d.ts:2737

---

RemoveItemFromFavorites

• RemoveItemFromFavorites: (nAppId: number, nPublishedFileID: bigint) => Promise<{ m_bWasAddRequest: boolean ; m_eResult: EResult ; m_nPublishedFileId: bigint }>

Type declaration

▸ (nAppId, nPublishedFileID): Promise<{ m_bWasAddRequest: boolean ; m_eResult: EResult ; m_nPublishedFileId: bigint }>

Parameters

Name	Type
nAppId	number
nPublishedFileID	bigint

Returns

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

Defined in

index.d.ts:2722

---

RemoveItemKeyValueTags

• RemoveItemKeyValueTags: (handle: bigint, pchKey: string) => boolean

Type declaration

▸ (handle, pchKey): boolean

Parameters

Name	Type
handle	bigint
pchKey	string

Returns

boolean

Defined in

index.d.ts:2710

---

RemoveItemPreview

• RemoveItemPreview: (handle: bigint, index: number) => boolean

Type declaration

▸ (handle, index): boolean

Parameters

Name	Type
handle	bigint
index	number

Returns

boolean

Defined in

index.d.ts:2716

---

RequestUGCDetails

• RequestUGCDetails: (nPublishedFileID: bigint, unMaxAgeSeconds: number) => Promise<{ m_bCachedData: boolean ; m_details: SteamUGCDetails_t }>

Type declaration

▸ (nPublishedFileID, unMaxAgeSeconds): Promise<{ m_bCachedData: boolean ; m_details: SteamUGCDetails_t }>

Parameters

Name	Type
nPublishedFileID	bigint
unMaxAgeSeconds	number

Returns

Promise<{ m_bCachedData: boolean ; m_details: SteamUGCDetails_t }>

Defined in

index.d.ts:2697

---

SendQueryUGCRequest

• SendQueryUGCRequest: (handle: bigint) => Promise<{ m_bCachedData: boolean ; m_eResult: EResult ; m_handle: bigint ; m_rgchNextCursor: string ; m_unNumResultsReturned: number ; m_unTotalMatchingResults: number }>

Type declaration

▸ (handle): Promise<{ m_bCachedData: boolean ; m_eResult: EResult ; m_handle: bigint ; m_rgchNextCursor: string ; m_unNumResultsReturned: number ; m_unTotalMatchingResults: number }>

Parameters

Name	Type
handle	bigint

Returns

Promise<{ m_bCachedData: boolean ; m_eResult: EResult ; m_handle: bigint ; m_rgchNextCursor: string ; m_unNumResultsReturned: number ; m_unTotalMatchingResults: number }>

Defined in

index.d.ts:2663

---

SetAllowCachedResponse

• SetAllowCachedResponse: (handle: bigint, unMaxAgeSeconds: number) => boolean

Type declaration

▸ (handle, unMaxAgeSeconds): boolean

Parameters

Name	Type
handle	bigint
unMaxAgeSeconds	number

Returns

boolean

Defined in

index.d.ts:2689

---

SetAllowLegacyUpload

• SetAllowLegacyUpload: (handle: bigint, bAllowLegacyUpload: boolean) => boolean

Type declaration

▸ (handle, bAllowLegacyUpload): boolean

Parameters

Name	Type
handle	bigint
bAllowLegacyUpload	boolean

Returns

boolean

Defined in

index.d.ts:2708

---

SetCloudFileNameFilter

• SetCloudFileNameFilter: (handle: bigint, pMatchCloudFileName: string) => boolean

Type declaration

▸ (handle, pMatchCloudFileName): boolean

Parameters

Name	Type
handle	bigint
pMatchCloudFileName	string

Returns

boolean

Defined in

index.d.ts:2690

---

SetItemContent

• SetItemContent: (handle: bigint, pszContentFolder: string) => boolean

Type declaration

▸ (handle, pszContentFolder): boolean

Parameters

Name	Type
handle	bigint
pszContentFolder	string

Returns

boolean

Defined in

index.d.ts:2706

---

SetItemDescription

• SetItemDescription: (handle: bigint, pchDescription: string) => boolean

Type declaration

▸ (handle, pchDescription): boolean

Parameters

Name	Type
handle	bigint
pchDescription	string

Returns

boolean

Defined in

index.d.ts:2701

---

SetItemMetadata

• SetItemMetadata: (handle: bigint, pchMetaData: string) => boolean

Type declaration

▸ (handle, pchMetaData): boolean

Parameters

Name	Type
handle	bigint
pchMetaData	string

Returns

boolean

Defined in

index.d.ts:2703

---

SetItemPreview

• SetItemPreview: (handle: bigint, pszPreviewFile: string) => boolean

Type declaration

▸ (handle, pszPreviewFile): boolean

Parameters

Name	Type
handle	bigint
pszPreviewFile	string

Returns

boolean

Defined in

index.d.ts:2707

---

SetItemTags

• SetItemTags: (updateHandle: bigint, pTags: unknown) => boolean

Type declaration

▸ (updateHandle, pTags): boolean

Parameters

Name	Type
updateHandle	bigint
pTags	unknown

Returns

boolean

Defined in

index.d.ts:2705

---

SetItemTitle

• SetItemTitle: (handle: bigint, pchTitle: string) => boolean

Type declaration

▸ (handle, pchTitle): boolean

Parameters

Name	Type
handle	bigint
pchTitle	string

Returns

boolean

Defined in

index.d.ts:2700

---

SetItemUpdateLanguage

• SetItemUpdateLanguage: (handle: bigint, pchLanguage: string) => boolean

Type declaration

▸ (handle, pchLanguage): boolean

Parameters

Name	Type
handle	bigint
pchLanguage	string

Returns

boolean

Defined in

index.d.ts:2702

---

SetItemVisibility

• SetItemVisibility: (handle: bigint, eVisibility: ERemoteStoragePublishedFileVisibility) => boolean

Type declaration

▸ (handle, eVisibility): boolean

Parameters

Name	Type
handle	bigint
eVisibility	ERemoteStoragePublishedFileVisibility

Returns

boolean

Defined in

index.d.ts:2704

---

SetLanguage

• SetLanguage: (handle: bigint, pchLanguage: string) => boolean

Type declaration

▸ (handle, pchLanguage): boolean

Parameters

Name	Type
handle	bigint
pchLanguage	string

Returns

boolean

Defined in

index.d.ts:2688

---

SetMatchAnyTag

• SetMatchAnyTag: (handle: bigint, bMatchAnyTag: boolean) => boolean

Type declaration

▸ (handle, bMatchAnyTag): boolean

Parameters

Name	Type
handle	bigint
bMatchAnyTag	boolean

Returns

boolean

Defined in

index.d.ts:2691

---

SetRankedByTrendDays

• SetRankedByTrendDays: (handle: bigint, unDays: number) => boolean

Type declaration

▸ (handle, unDays): boolean

Parameters

Name	Type
handle	bigint
unDays	number

Returns

boolean

Defined in

index.d.ts:2693

---

SetReturnAdditionalPreviews

• SetReturnAdditionalPreviews: (handle: bigint, bReturnAdditionalPreviews: boolean) => boolean

Type declaration

▸ (handle, bReturnAdditionalPreviews): boolean

Parameters

Name	Type
handle	bigint
bReturnAdditionalPreviews	boolean

Returns

boolean

Defined in

index.d.ts:2685

---

SetReturnChildren

• SetReturnChildren: (handle: bigint, bReturnChildren: boolean) => boolean

Type declaration

▸ (handle, bReturnChildren): boolean

Parameters

Name	Type
handle	bigint
bReturnChildren	boolean

Returns

boolean

Defined in

index.d.ts:2684

---

SetReturnKeyValueTags

• SetReturnKeyValueTags: (handle: bigint, bReturnKeyValueTags: boolean) => boolean

Type declaration

▸ (handle, bReturnKeyValueTags): boolean

Parameters

Name	Type
handle	bigint
bReturnKeyValueTags	boolean

Returns

boolean

Defined in

index.d.ts:2681

---

SetReturnLongDescription

• SetReturnLongDescription: (handle: bigint, bReturnLongDescription: boolean) => boolean

Type declaration

▸ (handle, bReturnLongDescription): boolean

Parameters

Name	Type
handle	bigint
bReturnLongDescription	boolean

Returns

boolean

Defined in

index.d.ts:2682

---

SetReturnMetadata

• SetReturnMetadata: (handle: bigint, bReturnMetadata: boolean) => boolean

Type declaration

▸ (handle, bReturnMetadata): boolean

Parameters

Name	Type
handle	bigint
bReturnMetadata	boolean

Returns

boolean

Defined in

index.d.ts:2683

---

SetReturnOnlyIDs

• SetReturnOnlyIDs: (handle: bigint, bReturnOnlyIDs: boolean) => boolean

Type declaration

▸ (handle, bReturnOnlyIDs): boolean

Parameters

Name	Type
handle	bigint
bReturnOnlyIDs	boolean

Returns

boolean

Defined in

index.d.ts:2680

---

SetReturnPlaytimeStats

• SetReturnPlaytimeStats: (handle: bigint, unDays: number) => boolean

Type declaration

▸ (handle, unDays): boolean

Parameters

Name	Type
handle	bigint
unDays	number

Returns

boolean

Defined in

index.d.ts:2687

---

SetReturnTotalOnly

• SetReturnTotalOnly: (handle: bigint, bReturnTotalOnly: boolean) => boolean

Type declaration

▸ (handle, bReturnTotalOnly): boolean

Parameters

Name	Type
handle	bigint
bReturnTotalOnly	boolean

Returns

boolean

Defined in

index.d.ts:2686

---

SetSearchText

• SetSearchText: (handle: bigint, pSearchText: string) => boolean

Type declaration

▸ (handle, pSearchText): boolean

Parameters

Name	Type
handle	bigint
pSearchText	string

Returns

boolean

Defined in

index.d.ts:2692

---

SetTimeCreatedDateRange

• SetTimeCreatedDateRange: (handle: bigint, rtStart: number, rtEnd: number) => boolean

Type declaration

▸ (handle, rtStart, rtEnd): boolean

Parameters

Name	Type
handle	bigint
rtStart	number
rtEnd	number

Returns

boolean

Defined in

index.d.ts:2694

---

SetTimeUpdatedDateRange

• SetTimeUpdatedDateRange: (handle: bigint, rtStart: number, rtEnd: number) => boolean

Type declaration

▸ (handle, rtStart, rtEnd): boolean

Parameters

Name	Type
handle	bigint
rtStart	number
rtEnd	number

Returns

boolean

Defined in

index.d.ts:2695

---

SetUserItemVote

• SetUserItemVote: (nPublishedFileID: bigint, bVoteUp: boolean) => Promise<{ m_bVoteUp: boolean ; m_eResult: EResult ; m_nPublishedFileId: bigint }>

Type declaration

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

Parameters

Name	Type
nPublishedFileID	bigint
bVoteUp	boolean

Returns

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

Defined in

index.d.ts:2719

---

ShowWorkshopEULA

• ShowWorkshopEULA: () => boolean

Type declaration

▸ (): boolean

Returns

boolean

Defined in

index.d.ts:2742

---

StartItemUpdate

• StartItemUpdate: (nConsumerAppId: number, nPublishedFileID: bigint) => bigint

Type declaration

▸ (nConsumerAppId, nPublishedFileID): bigint

Parameters

Name	Type
nConsumerAppId	number
nPublishedFileID	bigint

Returns

bigint

Defined in

index.d.ts:2699

---

StartPlaytimeTracking

• StartPlaytimeTracking: (unNumPublishedFileIDs: number) => Promise<{ m_eResult: EResult }>

Type declaration

▸ (unNumPublishedFileIDs): Promise<{ m_eResult: EResult }>

Parameters

Name	Type
unNumPublishedFileIDs	number

Returns

Promise<{ m_eResult: EResult }>

Defined in

index.d.ts:2733

---

StopPlaytimeTracking

• StopPlaytimeTracking: (unNumPublishedFileIDs: number) => Promise<{ m_eResult: EResult }>

Type declaration

▸ (unNumPublishedFileIDs): Promise<{ m_eResult: EResult }>

Parameters

Name	Type
unNumPublishedFileIDs	number

Returns

Promise<{ m_eResult: EResult }>

Defined in

index.d.ts:2734

---

StopPlaytimeTrackingForAllItems

• StopPlaytimeTrackingForAllItems: () => Promise<{ m_eResult: EResult }>

Type declaration

▸ (): Promise<{ m_eResult: EResult }>

Returns

Promise<{ m_eResult: EResult }>

Defined in

index.d.ts:2735

---

SubmitItemUpdate

• SubmitItemUpdate: (handle: bigint, pchChangeNote: string) => Promise<{ m_bUserNeedsToAcceptWorkshopLegalAgreement: boolean ; m_eResult: EResult ; m_nPublishedFileId: bigint }>

Type declaration

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

Parameters

Name	Type
handle	bigint
pchChangeNote	string

Returns

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

Defined in

index.d.ts:2717

---

SubscribeItem

• SubscribeItem: (nPublishedFileID: bigint) => Promise<{ m_eResult: EResult ; m_nPublishedFileId: bigint }>

Type declaration

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

Parameters

Name	Type
nPublishedFileID	bigint

Returns

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

Defined in

index.d.ts:2723

---

SuspendDownloads

• SuspendDownloads: (bSuspend: boolean) => undefined

Type declaration

▸ (bSuspend): undefined

Parameters

Name	Type
bSuspend	boolean

Returns

undefined

Defined in

index.d.ts:2732

---

UnsubscribeItem

• UnsubscribeItem: (nPublishedFileID: bigint) => Promise<{ m_eResult: EResult ; m_nPublishedFileId: bigint }>

Type declaration

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

Parameters

Name	Type
nPublishedFileID	bigint

Returns

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

Defined in

index.d.ts:2724

---

UpdateItemPreviewFile

• UpdateItemPreviewFile: (handle: bigint, index: number, pszPreviewFile: string) => boolean

Type declaration

▸ (handle, index, pszPreviewFile): boolean

Parameters

Name	Type
handle	bigint
index	number
pszPreviewFile	string

Returns

boolean

Defined in

index.d.ts:2714

---

UpdateItemPreviewVideo

• UpdateItemPreviewVideo: (handle: bigint, index: number, pszVideoID: string) => boolean

Type declaration

▸ (handle, index, pszVideoID): boolean

Parameters

Name	Type
handle	bigint
index	number
pszVideoID	string

Returns

boolean

Defined in

index.d.ts:2715