uk.co.thomasc.steamkit.steam3.handlers.steamworkshop

Class SteamWorkshop

java.lang.Object

uk.co.thomasc.steamkit.steam3.handlers.ClientMsgHandler

uk.co.thomasc.steamkit.steam3.handlers.steamworkshop.SteamWorkshop

public final class SteamWorkshop
extends ClientMsgHandler

This handler is used for requesting files published on the Steam Workshop.

Constructor Summary

Constructors

Constructor and Description
SteamWorkshop()

Method Summary

Methods

Modifier and Type	Method and Description
JobID	enumeratePublishedFiles(EnumerationDetails details) Enumerates the list of all published files on the Steam workshop.
JobID	enumeratePublishedFilesByUserAction(EnumerationUserDetails details) Enumerates the list of published files for the current logged in user based on user action.
JobID	enumerateUserPublishedFiles(EnumerationUserDetails details) Enumerates the list of published files for the current logged in user.
JobID	enumerateUserSubscribedFiles(EnumerationUserDetails details) Enumerates the list of subscribed files for the current logged in user.
(package private) void	handleEnumPublishedFiles(IPacketMsg packetMsg)
(package private) void	handleEnumPublishedFilesByAction(IPacketMsg packetMsg)
(package private) void	handleEnumUserPublishedFiles(IPacketMsg packetMsg)
(package private) void	handleEnumUserSubscribedFiles(IPacketMsg packetMsg)
void	handleMsg(IPacketMsg packetMsg) Handles a client message.
(package private) void	handlePublishedFileDetails(IPacketMsg packetMsg)
JobID	requestPublishedFileDetails(long publishedFileId) Requests details for a given published workshop file.

Methods inherited from class uk.co.thomasc.steamkit.steam3.handlers.ClientMsgHandler

setup

Methods inherited from class java.lang.Object

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

Constructor Detail

SteamWorkshop

public SteamWorkshop()

Method Detail

requestPublishedFileDetails

public JobID requestPublishedFileDetails(long publishedFileId)

Requests details for a given published workshop file. Requests details for a given published workshop file.

Parameters:

publishedFileId - The file ID being requested.

Returns:

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

enumerateUserPublishedFiles

public JobID enumerateUserPublishedFiles(EnumerationUserDetails details)

Enumerates the list of published files for the current logged in user. Results are returned in a UserPublishedFilesCallback from a JobCallback.

Parameters:

details - The specific details of the request.

Returns:

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

enumerateUserSubscribedFiles

public JobID enumerateUserSubscribedFiles(EnumerationUserDetails details)

Enumerates the list of subscribed files for the current logged in user. Results are returned in a UserSubscribedFilesCallback from a JobCallback.

Parameters:

details - The specific details of the request.

Returns:

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

enumeratePublishedFilesByUserAction

public JobID enumeratePublishedFilesByUserAction(EnumerationUserDetails details)

Enumerates the list of published files for the current logged in user based on user action. Results are returned in a UserActionPublishedFilesCallback from a JobCallback.

Parameters:

details - The specific details of the request.

Returns:

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

enumeratePublishedFiles

public JobID enumeratePublishedFiles(EnumerationDetails details)

Enumerates the list of all published files on the Steam workshop. Results are returned in a PublishedFilesCallback from a JobCallback.

Parameters:

details - The specific details of the request.

Returns:

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

handleMsg

public void handleMsg(IPacketMsg packetMsg)

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.

handleEnumPublishedFiles

void handleEnumPublishedFiles(IPacketMsg packetMsg)

handleEnumUserPublishedFiles

void handleEnumUserPublishedFiles(IPacketMsg packetMsg)

handleEnumUserSubscribedFiles

void handleEnumUserSubscribedFiles(IPacketMsg packetMsg)

handleEnumPublishedFilesByAction

void handleEnumPublishedFilesByAction(IPacketMsg packetMsg)

handlePublishedFileDetails

void handlePublishedFileDetails(IPacketMsg packetMsg)