com.codedisaster.steamworks

Class SteamUGC

java.lang.Object

com.codedisaster.steamworks.SteamUGC

public class SteamUGC
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SteamUGC.ItemAdditionalPreview
static class	SteamUGC.ItemDownloadInfo
static class	SteamUGC.ItemInstallInfo
static class	SteamUGC.ItemPreviewType
static class	SteamUGC.ItemState
static class	SteamUGC.ItemStatistic
static class	SteamUGC.ItemUpdateInfo
static class	SteamUGC.ItemUpdateStatus
static class	SteamUGC.MatchingUGCType
static class	SteamUGC.UGCQueryType
static class	SteamUGC.UserUGCList
static class	SteamUGC.UserUGCListSortOrder

Field Summary

Fields

Modifier and Type	Field and Description
protected long	callback
protected long	pointer

Constructor Summary

Constructors

Constructor and Description
SteamUGC(SteamUGCCallback callback)

Method Summary

Modifier and Type	Method and Description
boolean	addExcludedTag(SteamUGCQuery query, String tagName)
boolean	addItemKeyValueTag(SteamUGCUpdateHandle update, String key, String value)
SteamAPICall	addItemToFavorites(int appID, SteamPublishedFileID publishedFileID)
boolean	addRequiredKeyValueTag(SteamUGCQuery query, String key, String value)
boolean	addRequiredTag(SteamUGCQuery query, String tagName)
SteamAPICall	createItem(int consumerAppID, SteamRemoteStorage.WorkshopFileType fileType)
SteamUGCQuery	createQueryAllUGCRequest(SteamUGC.UGCQueryType queryType, SteamUGC.MatchingUGCType matchingType, int creatorAppID, int consumerAppID, int page)
SteamUGCQuery	createQueryUGCDetailsRequest(Collection<SteamPublishedFileID> publishedFileIDs)
SteamUGCQuery	createQueryUGCDetailsRequest(SteamPublishedFileID publishedFileID)
SteamUGCQuery	createQueryUserUGCRequest(int accountID, SteamUGC.UserUGCList listType, SteamUGC.MatchingUGCType matchingType, SteamUGC.UserUGCListSortOrder sortOrder, int creatorAppID, int consumerAppID, int page)
protected static void	deleteCallback(long callback)
SteamAPICall	deleteItem(SteamPublishedFileID publishedFileID)
void	dispose()
boolean	downloadItem(SteamPublishedFileID publishedFileID, boolean highPriority)
boolean	getItemDownloadInfo(SteamPublishedFileID publishedFileID, SteamUGC.ItemDownloadInfo downloadInfo)
boolean	getItemInstallInfo(SteamPublishedFileID publishedFileID, SteamUGC.ItemInstallInfo installInfo)
Collection<SteamUGC.ItemState>	getItemState(SteamPublishedFileID publishedFileID)
SteamUGC.ItemUpdateStatus	getItemUpdateProgress(SteamUGCUpdateHandle update, SteamUGC.ItemUpdateInfo updateInfo)
int	getNumSubscribedItems()
boolean	getQueryUGCAdditionalPreview(SteamUGCQuery query, int index, int previewIndex, SteamUGC.ItemAdditionalPreview previewInfo)
boolean	getQueryUGCKeyValueTag(SteamUGCQuery query, int index, int keyValueTagIndex, String[] keyAndValue)
String	getQueryUGCMetadata(SteamUGCQuery query, int index)
int	getQueryUGCNumAdditionalPreviews(SteamUGCQuery query, int index)
int	getQueryUGCNumKeyValueTags(SteamUGCQuery query, int index)
String	getQueryUGCPreviewURL(SteamUGCQuery query, int index)
boolean	getQueryUGCResult(SteamUGCQuery query, int index, SteamUGCDetails details)
long	getQueryUGCStatistic(SteamUGCQuery query, int index, SteamUGC.ItemStatistic statType)
int	getSubscribedItems(SteamPublishedFileID[] publishedFileIds)
SteamAPICall	getUserItemVote(SteamPublishedFileID publishedFileID)
boolean	initWorkshopForGameServer(int workshopDepotID, String folder)
boolean	releaseQueryUserUGCRequest(SteamUGCQuery query)
SteamAPICall	removeItemFromFavorites(int appID, SteamPublishedFileID publishedFileID)
boolean	removeItemKeyValueTags(SteamUGCUpdateHandle update, String key)
SteamAPICall	requestUGCDetails(SteamPublishedFileID publishedFileID, int maxAgeSeconds) Deprecated.
SteamAPICall	sendQueryUGCRequest(SteamUGCQuery query)
boolean	setAllowCachedResponse(SteamUGCQuery query, int maxAgeSeconds)
boolean	setCloudFileNameFilter(SteamUGCQuery query, String matchCloudFileName)
boolean	setItemContent(SteamUGCUpdateHandle update, String contentFolder)
boolean	setItemDescription(SteamUGCUpdateHandle update, String description)
boolean	setItemMetadata(SteamUGCUpdateHandle update, String metaData)
boolean	setItemPreview(SteamUGCUpdateHandle update, String previewFile)
boolean	setItemTags(SteamUGCUpdateHandle update, String[] tags)
boolean	setItemTitle(SteamUGCUpdateHandle update, String title)
boolean	setItemUpdateLanguage(SteamUGCUpdateHandle update, String language)
boolean	setItemVisibility(SteamUGCUpdateHandle update, SteamRemoteStorage.PublishedFileVisibility visibility)
boolean	setLanguage(SteamUGCQuery query, String language)
boolean	setMatchAnyTag(SteamUGCQuery query, boolean matchAnyTag)
boolean	setRankedByTrendDays(SteamUGCQuery query, int days)
boolean	setReturnAdditionalPreviews(SteamUGCQuery query, boolean returnAdditionalPreviews)
boolean	setReturnChildren(SteamUGCQuery query, boolean returnChildren)
boolean	setReturnKeyValueTags(SteamUGCQuery query, boolean returnKeyValueTags)
boolean	setReturnLongDescription(SteamUGCQuery query, boolean returnLongDescription)
boolean	setReturnMetadata(SteamUGCQuery query, boolean returnMetadata)
boolean	setReturnOnlyIDs(SteamUGCQuery query, boolean returnOnlyIDs)
boolean	setReturnPlaytimeStats(SteamUGCQuery query, int days)
boolean	setReturnTotalOnly(SteamUGCQuery query, boolean returnTotalOnly)
boolean	setSearchText(SteamUGCQuery query, String searchText)
SteamAPICall	setUserItemVote(SteamPublishedFileID publishedFileID, boolean voteUp)
SteamUGCUpdateHandle	startItemUpdate(int consumerAppID, SteamPublishedFileID publishedFileID)
SteamAPICall	startPlaytimeTracking(SteamPublishedFileID[] publishedFileIDs)
SteamAPICall	stopPlaytimeTracking(SteamPublishedFileID[] publishedFileIDs)
SteamAPICall	stopPlaytimeTrackingForAllItems()
SteamAPICall	submitItemUpdate(SteamUGCUpdateHandle update, String changeNote)
SteamAPICall	subscribeItem(SteamPublishedFileID publishedFileID)
void	suspendDownloads(boolean suspend)
SteamAPICall	unsubscribeItem(SteamPublishedFileID publishedFileID)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

pointer

protected final long pointer

callback

protected long callback

Constructor Detail

SteamUGC

public SteamUGC(SteamUGCCallback callback)

Method Detail

createQueryUserUGCRequest

public SteamUGCQuery createQueryUserUGCRequest(int accountID,
                                               SteamUGC.UserUGCList listType,
                                               SteamUGC.MatchingUGCType matchingType,
                                               SteamUGC.UserUGCListSortOrder sortOrder,
                                               int creatorAppID,
                                               int consumerAppID,
                                               int page)

createQueryAllUGCRequest

public SteamUGCQuery createQueryAllUGCRequest(SteamUGC.UGCQueryType queryType,
                                              SteamUGC.MatchingUGCType matchingType,
                                              int creatorAppID,
                                              int consumerAppID,
                                              int page)

createQueryUGCDetailsRequest

public SteamUGCQuery createQueryUGCDetailsRequest(SteamPublishedFileID publishedFileID)

createQueryUGCDetailsRequest

public SteamUGCQuery createQueryUGCDetailsRequest(Collection<SteamPublishedFileID> publishedFileIDs)

sendQueryUGCRequest

public SteamAPICall sendQueryUGCRequest(SteamUGCQuery query)

getQueryUGCResult

public boolean getQueryUGCResult(SteamUGCQuery query,
                                 int index,
                                 SteamUGCDetails details)

getQueryUGCPreviewURL

public String getQueryUGCPreviewURL(SteamUGCQuery query,
                                    int index)

getQueryUGCMetadata

public String getQueryUGCMetadata(SteamUGCQuery query,
                                  int index)

getQueryUGCStatistic

public long getQueryUGCStatistic(SteamUGCQuery query,
                                 int index,
                                 SteamUGC.ItemStatistic statType)

getQueryUGCNumAdditionalPreviews

public int getQueryUGCNumAdditionalPreviews(SteamUGCQuery query,
                                            int index)

getQueryUGCAdditionalPreview

public boolean getQueryUGCAdditionalPreview(SteamUGCQuery query,
                                            int index,
                                            int previewIndex,
                                            SteamUGC.ItemAdditionalPreview previewInfo)

getQueryUGCNumKeyValueTags

public int getQueryUGCNumKeyValueTags(SteamUGCQuery query,
                                      int index)

getQueryUGCKeyValueTag

public boolean getQueryUGCKeyValueTag(SteamUGCQuery query,
                                      int index,
                                      int keyValueTagIndex,
                                      String[] keyAndValue)

releaseQueryUserUGCRequest

public boolean releaseQueryUserUGCRequest(SteamUGCQuery query)

addRequiredTag

public boolean addRequiredTag(SteamUGCQuery query,
                              String tagName)

addExcludedTag

public boolean addExcludedTag(SteamUGCQuery query,
                              String tagName)

setReturnOnlyIDs

public boolean setReturnOnlyIDs(SteamUGCQuery query,
                                boolean returnOnlyIDs)

setReturnKeyValueTags

public boolean setReturnKeyValueTags(SteamUGCQuery query,
                                     boolean returnKeyValueTags)

setReturnLongDescription

public boolean setReturnLongDescription(SteamUGCQuery query,
                                        boolean returnLongDescription)

setReturnMetadata

public boolean setReturnMetadata(SteamUGCQuery query,
                                 boolean returnMetadata)

setReturnChildren

public boolean setReturnChildren(SteamUGCQuery query,
                                 boolean returnChildren)

setReturnAdditionalPreviews

public boolean setReturnAdditionalPreviews(SteamUGCQuery query,
                                           boolean returnAdditionalPreviews)

setReturnTotalOnly

public boolean setReturnTotalOnly(SteamUGCQuery query,
                                  boolean returnTotalOnly)

setReturnPlaytimeStats

public boolean setReturnPlaytimeStats(SteamUGCQuery query,
                                      int days)

setLanguage

public boolean setLanguage(SteamUGCQuery query,
                           String language)

setAllowCachedResponse

public boolean setAllowCachedResponse(SteamUGCQuery query,
                                      int maxAgeSeconds)

setCloudFileNameFilter

public boolean setCloudFileNameFilter(SteamUGCQuery query,
                                      String matchCloudFileName)

setMatchAnyTag

public boolean setMatchAnyTag(SteamUGCQuery query,
                              boolean matchAnyTag)

setSearchText

public boolean setSearchText(SteamUGCQuery query,
                             String searchText)

setRankedByTrendDays

public boolean setRankedByTrendDays(SteamUGCQuery query,
                                    int days)

addRequiredKeyValueTag

public boolean addRequiredKeyValueTag(SteamUGCQuery query,
                                      String key,
                                      String value)

requestUGCDetails

@Deprecated
public SteamAPICall requestUGCDetails(SteamPublishedFileID publishedFileID,
                                                  int maxAgeSeconds)

Deprecated.

createItem

public SteamAPICall createItem(int consumerAppID,
                               SteamRemoteStorage.WorkshopFileType fileType)

startItemUpdate

public SteamUGCUpdateHandle startItemUpdate(int consumerAppID,
                                            SteamPublishedFileID publishedFileID)

setItemTitle

public boolean setItemTitle(SteamUGCUpdateHandle update,
                            String title)

setItemDescription

public boolean setItemDescription(SteamUGCUpdateHandle update,
                                  String description)

setItemUpdateLanguage

public boolean setItemUpdateLanguage(SteamUGCUpdateHandle update,
                                     String language)

setItemMetadata

public boolean setItemMetadata(SteamUGCUpdateHandle update,
                               String metaData)

setItemVisibility

public boolean setItemVisibility(SteamUGCUpdateHandle update,
                                 SteamRemoteStorage.PublishedFileVisibility visibility)

setItemTags

public boolean setItemTags(SteamUGCUpdateHandle update,
                           String[] tags)

setItemContent

public boolean setItemContent(SteamUGCUpdateHandle update,
                              String contentFolder)

setItemPreview

public boolean setItemPreview(SteamUGCUpdateHandle update,
                              String previewFile)

removeItemKeyValueTags

public boolean removeItemKeyValueTags(SteamUGCUpdateHandle update,
                                      String key)

addItemKeyValueTag

public boolean addItemKeyValueTag(SteamUGCUpdateHandle update,
                                  String key,
                                  String value)

submitItemUpdate

public SteamAPICall submitItemUpdate(SteamUGCUpdateHandle update,
                                     String changeNote)

getItemUpdateProgress

public SteamUGC.ItemUpdateStatus getItemUpdateProgress(SteamUGCUpdateHandle update,
                                                       SteamUGC.ItemUpdateInfo updateInfo)

setUserItemVote

public SteamAPICall setUserItemVote(SteamPublishedFileID publishedFileID,
                                    boolean voteUp)

getUserItemVote

public SteamAPICall getUserItemVote(SteamPublishedFileID publishedFileID)

addItemToFavorites

public SteamAPICall addItemToFavorites(int appID,
                                       SteamPublishedFileID publishedFileID)

removeItemFromFavorites

public SteamAPICall removeItemFromFavorites(int appID,
                                            SteamPublishedFileID publishedFileID)

subscribeItem

public SteamAPICall subscribeItem(SteamPublishedFileID publishedFileID)

unsubscribeItem

public SteamAPICall unsubscribeItem(SteamPublishedFileID publishedFileID)

getNumSubscribedItems

public int getNumSubscribedItems()

getSubscribedItems

public int getSubscribedItems(SteamPublishedFileID[] publishedFileIds)

getItemState

public Collection<SteamUGC.ItemState> getItemState(SteamPublishedFileID publishedFileID)

getItemInstallInfo

public boolean getItemInstallInfo(SteamPublishedFileID publishedFileID,
                                  SteamUGC.ItemInstallInfo installInfo)

getItemDownloadInfo

public boolean getItemDownloadInfo(SteamPublishedFileID publishedFileID,
                                   SteamUGC.ItemDownloadInfo downloadInfo)

deleteItem

public SteamAPICall deleteItem(SteamPublishedFileID publishedFileID)

downloadItem

public boolean downloadItem(SteamPublishedFileID publishedFileID,
                            boolean highPriority)

initWorkshopForGameServer

public boolean initWorkshopForGameServer(int workshopDepotID,
                                         String folder)

suspendDownloads

public void suspendDownloads(boolean suspend)

startPlaytimeTracking

public SteamAPICall startPlaytimeTracking(SteamPublishedFileID[] publishedFileIDs)

stopPlaytimeTracking

public SteamAPICall stopPlaytimeTracking(SteamPublishedFileID[] publishedFileIDs)

stopPlaytimeTrackingForAllItems

public SteamAPICall stopPlaytimeTrackingForAllItems()

dispose

public void dispose()

deleteCallback

protected static void deleteCallback(long callback)