Package in.dragonbra.javasteam.steam.handlers.steamcloud

Class SteamCloud

java.lang.Object

in.dragonbra.javasteam.handlers.ClientMsgHandler

in.dragonbra.javasteam.steam.handlers.steamcloud.SteamCloud

public class SteamCloud
extends ClientMsgHandler

This handler is used for interacting with remote storage and user generated content.

Field Summary

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

client

Constructor Summary

Constructors

Constructor	Description
SteamCloud()

Method Summary

Modifier and Type	Method	Description
JobID	getSingleFileInfo(int appId, java.lang.String filename)	Requests details for a specific file in the user's Cloud storage.
void	handleMsg(IPacketMsg packetMsg)	Handles a client message.
JobID	requestUGCDetails(UGCHandle ugcId)	Requests details for a specific item of user generated content from the Steam servers.
JobID	shareFile(int appId, java.lang.String filename)	Commit a Cloud file at the given path to make its UGC handle publicly visible.

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

SteamCloud

public SteamCloud()

Method Detail

requestUGCDetails

public JobID requestUGCDetails(UGCHandle ugcId)

Requests details for a specific item of user generated content from the Steam servers. Results are returned in a UGCDetailsCallback.

Parameters:

ugcId - The unique user generated content id.

Returns:

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

getSingleFileInfo

public JobID getSingleFileInfo(int appId,
                               java.lang.String filename)

Requests details for a specific file in the user's Cloud storage. Results are returned in a SingleFileInfoCallback.

Parameters:

appId - The app id of the game.

filename - The path to the file being requested.

Returns:

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

shareFile

public JobID shareFile(int appId,
                       java.lang.String filename)

Commit a Cloud file at the given path to make its UGC handle publicly visible. Results are returned in a ShareFileCallback.

Parameters:

appId - The app id of the game.

filename - The path to the file being requested.

Returns:

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

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.