Package in.dragonbra.javasteam.steam.handlers.steamapps

Class SteamApps

java.lang.Object

in.dragonbra.javasteam.handlers.ClientMsgHandler

in.dragonbra.javasteam.steam.handlers.steamapps.SteamApps

public class SteamApps
extends ClientMsgHandler

This handler is used for interacting with apps and packages on the Steam network.

Field Summary

Fields inherited from class in.dragonbra.javasteam.handlers.ClientMsgHandler

client

Constructor Summary

Constructors

Constructor	Description
SteamApps()

Method Summary

Modifier and Type	Method	Description
JobID	checkAppBetaPassword(int app, java.lang.String password)	Submit a beta password for a given app to retrieve any betas and their encryption keys.
JobID	getAppOwnershipTicket(int appId)	Requests an app ownership ticket for the specified AppID.
JobID	getCDNAuthToken(int app, int depot, java.lang.String hostName)	Request product information for an app or package Results are returned in a CDNAuthTokenCallback callback.
JobID	getDepotDecryptionKey(int depotId, int appId)	Request the depot decryption key for a specified DepotID.
JobID	getLegacyGameKey(int appId)	Request the legacy CD game keys for the requested appid.
void	handleMsg(IPacketMsg packetMsg)	Handles a client message.
JobID	picsGetAccessTokens(java.lang.Integer app, java.lang.Integer _package)	Request PICS access tokens for an app or package.
JobID	picsGetAccessTokens(java.lang.Iterable<java.lang.Integer> appIds, java.lang.Iterable<java.lang.Integer> packageIds)	Request PICS access tokens for a list of app ids and package ids Results are returned in a PICSTokensCallback callback.
JobID	picsGetChangesSince()	Request changes for apps and packages since a given change number Results are returned in a PICSChangesCallback callback.
JobID	picsGetChangesSince(int lastChangeNumber)	Request changes for apps and packages since a given change number Results are returned in a PICSChangesCallback callback.
JobID	picsGetChangesSince(int lastChangeNumber, boolean sendAppChangeList)	Request changes for apps and packages since a given change number Results are returned in a PICSChangesCallback callback.
JobID	picsGetChangesSince(int lastChangeNumber, boolean sendAppChangeList, boolean sendPackageChangelist)	Request changes for apps and packages since a given change number Results are returned in a PICSChangesCallback callback.
JobID	picsGetProductInfo(PICSRequest app, PICSRequest _package)	Request product information for an app or package Results are returned in a PICSProductInfoCallback callback.
JobID	picsGetProductInfo(PICSRequest app, PICSRequest _package, boolean metaDataOnly)	Request product information for an app or package Results are returned in a PICSProductInfoCallback callback.
JobID	picsGetProductInfo(java.lang.Iterable<PICSRequest> apps, java.lang.Iterable<PICSRequest> packages)	Request product information for a list of apps or packages Results are returned in a PICSProductInfoCallback callback.
JobID	picsGetProductInfo(java.lang.Iterable<PICSRequest> apps, java.lang.Iterable<PICSRequest> packages, boolean metaDataOnly)	Request product information for a list of apps or packages Results are returned in a PICSProductInfoCallback callback.
JobID	requestFreeLicense(int app)	Request a free license for given appid, can be used for free on demand apps Results are returned in a FreeLicenseCallback callback.
JobID	requestFreeLicense(java.lang.Iterable<java.lang.Integer> apps)	Request a free license for given appids, can be used for free on demand apps Results are returned in a FreeLicenseCallback callback.

Methods inherited from class in.dragonbra.javasteam.handlers.ClientMsgHandler

getClient, isExpectDisconnection, setExpectDisconnection, setup

Methods inherited from class java.lang.Object

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

Constructor Detail

SteamApps

public SteamApps()

Method Detail

getAppOwnershipTicket

public JobID getAppOwnershipTicket(int appId)

Requests an app ownership ticket for the specified AppID. Results are returned in a AppOwnershipTicketCallback callback.

Parameters:

appId - The appid to request the ownership ticket of.

Returns:

The Job ID of the request. This can be used to find the appropriate AppOwnershipTicketCallback.

getDepotDecryptionKey

public JobID getDepotDecryptionKey(int depotId,
                                   int appId)

Request the depot decryption key for a specified DepotID. Results are returned in a DepotKeyCallback callback.

Parameters:

depotId - The DepotID to request a decryption key for.

appId - The AppID parent of the DepotID.

Returns:

The Job ID of the request. This can be used to find the appropriate DepotKeyCallback.

picsGetAccessTokens

public JobID picsGetAccessTokens(java.lang.Integer app,
                                 java.lang.Integer _package)

Request PICS access tokens for an app or package. Results are returned in a PICSTokensCallback callback.

Parameters:

app - App id to request access token for.

_package - Package id to request access token for.

Returns:

The Job ID of the request. This can be used to find the appropriate PICSTokensCallback.

picsGetAccessTokens

public JobID picsGetAccessTokens(java.lang.Iterable<java.lang.Integer> appIds,
                                 java.lang.Iterable<java.lang.Integer> packageIds)

Request PICS access tokens for a list of app ids and package ids Results are returned in a PICSTokensCallback callback.

Parameters:

appIds - List of app ids to request access tokens for.

packageIds - List of package ids to request access tokens for.

Returns:

The Job ID of the request. This can be used to find the appropriate PICSTokensCallback.

picsGetChangesSince

public JobID picsGetChangesSince()

Request changes for apps and packages since a given change number Results are returned in a PICSChangesCallback callback.

Returns:

The Job ID of the request. This can be used to find the appropriate PICSChangesCallback.

picsGetChangesSince

public JobID picsGetChangesSince(int lastChangeNumber)

Request changes for apps and packages since a given change number Results are returned in a PICSChangesCallback callback.

Parameters:

lastChangeNumber - Last change number seen.

Returns:

The Job ID of the request. This can be used to find the appropriate PICSChangesCallback.

picsGetChangesSince

public JobID picsGetChangesSince(int lastChangeNumber,
                                 boolean sendAppChangeList)

Request changes for apps and packages since a given change number Results are returned in a PICSChangesCallback callback.

Parameters:

lastChangeNumber - Last change number seen.

sendAppChangeList - Whether to send app changes.

Returns:

The Job ID of the request. This can be used to find the appropriate PICSChangesCallback.

picsGetChangesSince

public JobID picsGetChangesSince(int lastChangeNumber,
                                 boolean sendAppChangeList,
                                 boolean sendPackageChangelist)

Request changes for apps and packages since a given change number Results are returned in a PICSChangesCallback callback.

Parameters:

lastChangeNumber - Last change number seen.

sendAppChangeList - Whether to send app changes.

sendPackageChangelist - Whether to send package changes.

Returns:

The Job ID of the request. This can be used to find the appropriate PICSChangesCallback.

picsGetProductInfo

public JobID picsGetProductInfo(PICSRequest app,
                                PICSRequest _package)

Request product information for an app or package Results are returned in a PICSProductInfoCallback callback.

Parameters:

app - App id requested.

_package - Package id requested.

Returns:

The Job ID of the request. This can be used to find the appropriate PICSProductInfoCallback.

picsGetProductInfo

public JobID picsGetProductInfo(PICSRequest app,
                                PICSRequest _package,
                                boolean metaDataOnly)

Request product information for an app or package Results are returned in a PICSProductInfoCallback callback.

Parameters:

app - App id requested.

_package - Package id requested.

metaDataOnly - Whether to send only meta data.

Returns:

The Job ID of the request. This can be used to find the appropriate PICSProductInfoCallback.

picsGetProductInfo

public JobID picsGetProductInfo(java.lang.Iterable<PICSRequest> apps,
                                java.lang.Iterable<PICSRequest> packages)

Request product information for a list of apps or packages Results are returned in a PICSProductInfoCallback callback.

Parameters:

apps - List of app ids requested.

packages - List of package ids requested.

Returns:

The Job ID of the request. This can be used to find the appropriate PICSProductInfoCallback.

picsGetProductInfo

public JobID picsGetProductInfo(java.lang.Iterable<PICSRequest> apps,
                                java.lang.Iterable<PICSRequest> packages,
                                boolean metaDataOnly)

Request product information for a list of apps or packages Results are returned in a PICSProductInfoCallback callback.

Parameters:

apps - List of PICSRequest requests for apps.

packages - List of PICSRequest requests for packages.

metaDataOnly - Whether to send only metadata.

Returns:

The Job ID of the request. This can be used to find the appropriate PICSProductInfoCallback.

getCDNAuthToken

public JobID getCDNAuthToken(int app,
                             int depot,
                             java.lang.String hostName)

Request product information for an app or package Results are returned in a CDNAuthTokenCallback callback.

Parameters:

app - App id requested.

depot - Depot id requested.

hostName - CDN host name being requested.

Returns:

The Job ID of the request. This can be used to find the appropriate CDNAuthTokenCallback.

requestFreeLicense

public JobID requestFreeLicense(int app)

Request a free license for given appid, can be used for free on demand apps Results are returned in a FreeLicenseCallback callback.

Parameters:

app - The app to request a free license for.

Returns:

The Job ID of the request. This can be used to find the appropriate FreeLicenseCallback.

requestFreeLicense

public JobID requestFreeLicense(java.lang.Iterable<java.lang.Integer> apps)

Request a free license for given appids, can be used for free on demand apps Results are returned in a FreeLicenseCallback callback.

Parameters:

apps - The apps to request a free license for.

Returns:

The Job ID of the request. This can be used to find the appropriate FreeLicenseCallback.

checkAppBetaPassword

public JobID checkAppBetaPassword(int app,
                                  java.lang.String password)

Submit a beta password for a given app to retrieve any betas and their encryption keys. Results are returned in a CheckAppBetaPasswordCallback callback.

Parameters:

app - App id requested.

password - Password to check.

Returns:

The Job ID of the request. This can be used to find the appropriate CheckAppBetaPasswordCallback.

getLegacyGameKey

public JobID getLegacyGameKey(int appId)

Request the legacy CD game keys for the requested appid.

Parameters:

appId - The AppID to request game keys for.

Returns:

The Job ID of the request. This can be used to find the appropriate LegacyGameKeyCallback

handleMsg

public void handleMsg(IPacketMsg packetMsg)

Description copied from class: ClientMsgHandler

Handles a client message. This should not be called directly.

Specified by:

handleMsg in class ClientMsgHandler

Parameters:

packetMsg - The packet message that contains the data.