C# Class Valve.Steamworks.ISteamUGC

Show file Open project: kronosaur/Transcendence

Public Methods

Method	Description
AddExcludedTag ( ulong handle, string pTagName ) : bool
AddItemKeyValueTag ( ulong handle, string pchKey, string pchValue ) : bool
AddItemToFavorites ( uint nAppId, ulong nPublishedFileID ) : ulong
AddRequiredKeyValueTag ( ulong handle, string pKey, string pValue ) : bool
AddRequiredTag ( ulong handle, string pTagName ) : bool
BInitWorkshopForGameServer ( uint unWorkshopDepotID, string pszFolder ) : bool
CreateItem ( uint nConsumerAppId, uint eFileType ) : ulong
CreateQueryAllUGCRequest ( uint eQueryType, uint eMatchingeMatchingUGCTypeFileType, uint nCreatorAppID, uint nConsumerAppID, uint unPage ) : ulong
CreateQueryUGCDetailsRequest ( ulong &pvecPublishedFileID, uint unNumPublishedFileIDs ) : ulong
CreateQueryUserUGCRequest ( uint unAccountID, uint eListType, uint eMatchingUGCType, uint eSortOrder, uint nCreatorAppID, uint nConsumerAppID, uint unPage ) : ulong
DownloadItem ( ulong nPublishedFileID, bool bHighPriority ) : bool
GetIntPtr ( ) : IntPtr
GetItemDownloadInfo ( ulong nPublishedFileID, ulong &punBytesDownloaded, ulong &punBytesTotal ) : bool
GetItemInstallInfo ( ulong nPublishedFileID, ulong &punSizeOnDisk, string &pchFolder, uint &punTimeStamp ) : bool
GetItemState ( ulong nPublishedFileID ) : uint
GetItemUpdateProgress ( ulong handle, ulong &punBytesProcessed, ulong &punBytesTotal ) : uint
GetNumSubscribedItems ( ) : uint
GetQueryUGCAdditionalPreview ( ulong handle, uint index, uint previewIndex, string &pchURLOrVideoID, bool &pbIsImage ) : bool
GetQueryUGCChildren ( ulong handle, uint index, ulong &pvecPublishedFileID, uint cMaxEntries ) : bool
GetQueryUGCKeyValueTag ( ulong handle, uint index, uint keyValueTagIndex, string &pchKey, string &pchValue ) : bool
GetQueryUGCMetadata ( ulong handle, uint index, string &pchMetadata ) : bool
GetQueryUGCNumAdditionalPreviews ( ulong handle, uint index ) : uint
GetQueryUGCNumKeyValueTags ( ulong handle, uint index ) : uint
GetQueryUGCPreviewURL ( ulong handle, uint index, string &pchURL ) : bool
GetQueryUGCResult ( ulong handle, uint index, SteamUGCDetails_t &pDetails ) : bool
GetQueryUGCStatistic ( ulong handle, uint index, uint eStatType, uint &pStatValue ) : bool
GetSubscribedItems ( ulong &pvecPublishedFileID, uint cMaxEntries ) : uint
GetUserItemVote ( ulong nPublishedFileID ) : ulong
ReleaseQueryUGCRequest ( ulong handle ) : bool
RemoveItemFromFavorites ( uint nAppId, ulong nPublishedFileID ) : ulong
RemoveItemKeyValueTags ( ulong handle, string pchKey ) : bool
RequestUGCDetails ( ulong nPublishedFileID, uint unMaxAgeSeconds ) : ulong
SendQueryUGCRequest ( ulong handle ) : ulong
SetAllowCachedResponse ( ulong handle, uint unMaxAgeSeconds ) : bool
SetCloudFileNameFilter ( ulong handle, string pMatchCloudFileName ) : bool
SetItemContent ( ulong handle, string pszContentFolder ) : bool
SetItemDescription ( ulong handle, string pchDescription ) : bool
SetItemMetadata ( ulong handle, string pchMetaData ) : bool
SetItemPreview ( ulong handle, string pszPreviewFile ) : bool
SetItemTags ( ulong updateHandle, SteamParamStringArray_t &pTags ) : bool
SetItemTitle ( ulong handle, string pchTitle ) : bool
SetItemUpdateLanguage ( ulong handle, string pchLanguage ) : bool
SetItemVisibility ( ulong handle, uint eVisibility ) : bool
SetLanguage ( ulong handle, string pchLanguage ) : bool
SetMatchAnyTag ( ulong handle, bool bMatchAnyTag ) : bool
SetRankedByTrendDays ( ulong handle, uint unDays ) : bool
SetReturnAdditionalPreviews ( ulong handle, bool bReturnAdditionalPreviews ) : bool
SetReturnChildren ( ulong handle, bool bReturnChildren ) : bool
SetReturnKeyValueTags ( ulong handle, bool bReturnKeyValueTags ) : bool
SetReturnLongDescription ( ulong handle, bool bReturnLongDescription ) : bool
SetReturnMetadata ( ulong handle, bool bReturnMetadata ) : bool
SetReturnTotalOnly ( ulong handle, bool bReturnTotalOnly ) : bool
SetSearchText ( ulong handle, string pSearchText ) : bool
SetUserItemVote ( ulong nPublishedFileID, bool bVoteUp ) : ulong
StartItemUpdate ( uint nConsumerAppId, ulong nPublishedFileID ) : ulong
SubmitItemUpdate ( ulong handle, string pchChangeNote ) : ulong
SubscribeItem ( ulong nPublishedFileID ) : ulong
SuspendDownloads ( bool bSuspend ) : void
UnsubscribeItem ( ulong nPublishedFileID ) : ulong

Method Details

AddExcludedTag() public abstract method

public abstract AddExcludedTag ( ulong handle, string pTagName ) : bool
handle	ulong
pTagName	string
return	bool

AddItemKeyValueTag() public abstract method

public abstract AddItemKeyValueTag ( ulong handle, string pchKey, string pchValue ) : bool
handle	ulong
pchKey	string
pchValue	string
return	bool

AddItemToFavorites() public abstract method

public abstract AddItemToFavorites ( uint nAppId, ulong nPublishedFileID ) : ulong
nAppId	uint
nPublishedFileID	ulong
return	ulong

AddRequiredKeyValueTag() public abstract method

public abstract AddRequiredKeyValueTag ( ulong handle, string pKey, string pValue ) : bool
handle	ulong
pKey	string
pValue	string
return	bool

AddRequiredTag() public abstract method

public abstract AddRequiredTag ( ulong handle, string pTagName ) : bool
handle	ulong
pTagName	string
return	bool

BInitWorkshopForGameServer() public abstract method

public abstract BInitWorkshopForGameServer ( uint unWorkshopDepotID, string pszFolder ) : bool
unWorkshopDepotID	uint
pszFolder	string
return	bool

CreateItem() public abstract method

public abstract CreateItem ( uint nConsumerAppId, uint eFileType ) : ulong
nConsumerAppId	uint
eFileType	uint
return	ulong

CreateQueryAllUGCRequest() public abstract method

public abstract CreateQueryAllUGCRequest ( uint eQueryType, uint eMatchingeMatchingUGCTypeFileType, uint nCreatorAppID, uint nConsumerAppID, uint unPage ) : ulong
eQueryType	uint
eMatchingeMatchingUGCTypeFileType	uint
nCreatorAppID	uint
nConsumerAppID	uint
unPage	uint
return	ulong

CreateQueryUGCDetailsRequest() public abstract method

public abstract CreateQueryUGCDetailsRequest ( ulong &pvecPublishedFileID, uint unNumPublishedFileIDs ) : ulong
pvecPublishedFileID	ulong
unNumPublishedFileIDs	uint
return	ulong

CreateQueryUserUGCRequest() public abstract method

public abstract CreateQueryUserUGCRequest ( uint unAccountID, uint eListType, uint eMatchingUGCType, uint eSortOrder, uint nCreatorAppID, uint nConsumerAppID, uint unPage ) : ulong
unAccountID	uint
eListType	uint
eMatchingUGCType	uint
eSortOrder	uint
nCreatorAppID	uint
nConsumerAppID	uint
unPage	uint
return	ulong

DownloadItem() public abstract method

public abstract DownloadItem ( ulong nPublishedFileID, bool bHighPriority ) : bool
nPublishedFileID	ulong
bHighPriority	bool
return	bool

GetIntPtr() public abstract method

public abstract GetIntPtr ( ) : IntPtr
return	System.IntPtr

GetItemDownloadInfo() public abstract method

public abstract GetItemDownloadInfo ( ulong nPublishedFileID, ulong &punBytesDownloaded, ulong &punBytesTotal ) : bool
nPublishedFileID	ulong
punBytesDownloaded	ulong
punBytesTotal	ulong
return	bool

GetItemInstallInfo() public abstract method

public abstract GetItemInstallInfo ( ulong nPublishedFileID, ulong &punSizeOnDisk, string &pchFolder, uint &punTimeStamp ) : bool
nPublishedFileID	ulong
punSizeOnDisk	ulong
pchFolder	string
punTimeStamp	uint
return	bool

GetItemState() public abstract method

public abstract GetItemState ( ulong nPublishedFileID ) : uint
nPublishedFileID	ulong
return	uint

GetItemUpdateProgress() public abstract method

public abstract GetItemUpdateProgress ( ulong handle, ulong &punBytesProcessed, ulong &punBytesTotal ) : uint
handle	ulong
punBytesProcessed	ulong
punBytesTotal	ulong
return	uint

GetNumSubscribedItems() public abstract method

public abstract GetNumSubscribedItems ( ) : uint
return	uint

GetQueryUGCAdditionalPreview() public abstract method

public abstract GetQueryUGCAdditionalPreview ( ulong handle, uint index, uint previewIndex, string &pchURLOrVideoID, bool &pbIsImage ) : bool
handle	ulong
index	uint
previewIndex	uint
pchURLOrVideoID	string
pbIsImage	bool
return	bool

GetQueryUGCChildren() public abstract method

public abstract GetQueryUGCChildren ( ulong handle, uint index, ulong &pvecPublishedFileID, uint cMaxEntries ) : bool
handle	ulong
index	uint
pvecPublishedFileID	ulong
cMaxEntries	uint
return	bool

GetQueryUGCKeyValueTag() public abstract method

public abstract GetQueryUGCKeyValueTag ( ulong handle, uint index, uint keyValueTagIndex, string &pchKey, string &pchValue ) : bool
handle	ulong
index	uint
keyValueTagIndex	uint
pchKey	string
pchValue	string
return	bool

GetQueryUGCMetadata() public abstract method

public abstract GetQueryUGCMetadata ( ulong handle, uint index, string &pchMetadata ) : bool
handle	ulong
index	uint
pchMetadata	string
return	bool

GetQueryUGCNumAdditionalPreviews() public abstract method

public abstract GetQueryUGCNumAdditionalPreviews ( ulong handle, uint index ) : uint
handle	ulong
index	uint
return	uint

GetQueryUGCNumKeyValueTags() public abstract method

public abstract GetQueryUGCNumKeyValueTags ( ulong handle, uint index ) : uint
handle	ulong
index	uint
return	uint

GetQueryUGCPreviewURL() public abstract method

public abstract GetQueryUGCPreviewURL ( ulong handle, uint index, string &pchURL ) : bool
handle	ulong
index	uint
pchURL	string
return	bool

GetQueryUGCResult() public abstract method

public abstract GetQueryUGCResult ( ulong handle, uint index, SteamUGCDetails_t &pDetails ) : bool
handle	ulong
index	uint
pDetails	SteamUGCDetails_t
return	bool

GetQueryUGCStatistic() public abstract method

public abstract GetQueryUGCStatistic ( ulong handle, uint index, uint eStatType, uint &pStatValue ) : bool
handle	ulong
index	uint
eStatType	uint
pStatValue	uint
return	bool

GetSubscribedItems() public abstract method

public abstract GetSubscribedItems ( ulong &pvecPublishedFileID, uint cMaxEntries ) : uint
pvecPublishedFileID	ulong
cMaxEntries	uint
return	uint

GetUserItemVote() public abstract method

public abstract GetUserItemVote ( ulong nPublishedFileID ) : ulong
nPublishedFileID	ulong
return	ulong

ReleaseQueryUGCRequest() public abstract method

public abstract ReleaseQueryUGCRequest ( ulong handle ) : bool
handle	ulong
return	bool

RemoveItemFromFavorites() public abstract method

public abstract RemoveItemFromFavorites ( uint nAppId, ulong nPublishedFileID ) : ulong
nAppId	uint
nPublishedFileID	ulong
return	ulong

RemoveItemKeyValueTags() public abstract method

public abstract RemoveItemKeyValueTags ( ulong handle, string pchKey ) : bool
handle	ulong
pchKey	string
return	bool

RequestUGCDetails() public abstract method

public abstract RequestUGCDetails ( ulong nPublishedFileID, uint unMaxAgeSeconds ) : ulong
nPublishedFileID	ulong
unMaxAgeSeconds	uint
return	ulong

SendQueryUGCRequest() public abstract method

public abstract SendQueryUGCRequest ( ulong handle ) : ulong
handle	ulong
return	ulong

SetAllowCachedResponse() public abstract method

public abstract SetAllowCachedResponse ( ulong handle, uint unMaxAgeSeconds ) : bool
handle	ulong
unMaxAgeSeconds	uint
return	bool

SetCloudFileNameFilter() public abstract method

public abstract SetCloudFileNameFilter ( ulong handle, string pMatchCloudFileName ) : bool
handle	ulong
pMatchCloudFileName	string
return	bool

SetItemContent() public abstract method

public abstract SetItemContent ( ulong handle, string pszContentFolder ) : bool
handle	ulong
pszContentFolder	string
return	bool

SetItemDescription() public abstract method

public abstract SetItemDescription ( ulong handle, string pchDescription ) : bool
handle	ulong
pchDescription	string
return	bool

SetItemMetadata() public abstract method

public abstract SetItemMetadata ( ulong handle, string pchMetaData ) : bool
handle	ulong
pchMetaData	string
return	bool

SetItemPreview() public abstract method

public abstract SetItemPreview ( ulong handle, string pszPreviewFile ) : bool
handle	ulong
pszPreviewFile	string
return	bool

SetItemTags() public abstract method

public abstract SetItemTags ( ulong updateHandle, SteamParamStringArray_t &pTags ) : bool
updateHandle	ulong
pTags	SteamParamStringArray_t
return	bool

SetItemTitle() public abstract method

public abstract SetItemTitle ( ulong handle, string pchTitle ) : bool
handle	ulong
pchTitle	string
return	bool

SetItemUpdateLanguage() public abstract method

public abstract SetItemUpdateLanguage ( ulong handle, string pchLanguage ) : bool
handle	ulong
pchLanguage	string
return	bool

SetItemVisibility() public abstract method

public abstract SetItemVisibility ( ulong handle, uint eVisibility ) : bool
handle	ulong
eVisibility	uint
return	bool

SetLanguage() public abstract method

public abstract SetLanguage ( ulong handle, string pchLanguage ) : bool
handle	ulong
pchLanguage	string
return	bool

SetMatchAnyTag() public abstract method

public abstract SetMatchAnyTag ( ulong handle, bool bMatchAnyTag ) : bool
handle	ulong
bMatchAnyTag	bool
return	bool

SetRankedByTrendDays() public abstract method

public abstract SetRankedByTrendDays ( ulong handle, uint unDays ) : bool
handle	ulong
unDays	uint
return	bool

SetReturnAdditionalPreviews() public abstract method

public abstract SetReturnAdditionalPreviews ( ulong handle, bool bReturnAdditionalPreviews ) : bool
handle	ulong
bReturnAdditionalPreviews	bool
return	bool

SetReturnChildren() public abstract method

public abstract SetReturnChildren ( ulong handle, bool bReturnChildren ) : bool
handle	ulong
bReturnChildren	bool
return	bool

SetReturnKeyValueTags() public abstract method

public abstract SetReturnKeyValueTags ( ulong handle, bool bReturnKeyValueTags ) : bool
handle	ulong
bReturnKeyValueTags	bool
return	bool

SetReturnLongDescription() public abstract method

public abstract SetReturnLongDescription ( ulong handle, bool bReturnLongDescription ) : bool
handle	ulong
bReturnLongDescription	bool
return	bool

SetReturnMetadata() public abstract method

public abstract SetReturnMetadata ( ulong handle, bool bReturnMetadata ) : bool
handle	ulong
bReturnMetadata	bool
return	bool

SetReturnTotalOnly() public abstract method

public abstract SetReturnTotalOnly ( ulong handle, bool bReturnTotalOnly ) : bool
handle	ulong
bReturnTotalOnly	bool
return	bool

SetSearchText() public abstract method

public abstract SetSearchText ( ulong handle, string pSearchText ) : bool
handle	ulong
pSearchText	string
return	bool

SetUserItemVote() public abstract method

public abstract SetUserItemVote ( ulong nPublishedFileID, bool bVoteUp ) : ulong
nPublishedFileID	ulong
bVoteUp	bool
return	ulong

StartItemUpdate() public abstract method

public abstract StartItemUpdate ( uint nConsumerAppId, ulong nPublishedFileID ) : ulong
nConsumerAppId	uint
nPublishedFileID	ulong
return	ulong

SubmitItemUpdate() public abstract method

public abstract SubmitItemUpdate ( ulong handle, string pchChangeNote ) : ulong
handle	ulong
pchChangeNote	string
return	ulong

SubscribeItem() public abstract method

public abstract SubscribeItem ( ulong nPublishedFileID ) : ulong
nPublishedFileID	ulong
return	ulong

SuspendDownloads() public abstract method

public abstract SuspendDownloads ( bool bSuspend ) : void
bSuspend	bool
return	void

UnsubscribeItem() public abstract method

public abstract UnsubscribeItem ( ulong nPublishedFileID ) : ulong
nPublishedFileID	ulong
return	ulong