C# Class SteamKit2.SteamWorkshop

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

Inheritance: ClientMsgHandler

Show file Open project: Top-Cat/SteamBot Class Usage Examples

Public Methods

Method	Description
EnumeratePublishedFiles ( EnumerationDetails details ) : JobID	Enumerates the list of all published files on the Steam workshop. Results are returned in a PublishedFilesCallback from a SteamClient.JobCallback<T>.
EnumeratePublishedFilesByUserAction ( EnumerationUserDetails details ) : JobID	Enumerates the list of published files for the current logged in user based on user action. Results are returned in a UserActionPublishedFilesCallback from a SteamClient.JobCallback<T>.
EnumerateUserPublishedFiles ( EnumerationUserDetails details ) : JobID	Enumerates the list of published files for the current logged in user. Results are returned in a UserPublishedFilesCallback from a SteamClient.JobCallback<T>.
EnumerateUserSubscribedFiles ( EnumerationUserDetails details ) : JobID	Enumerates the list of subscribed files for the current logged in user. Results are returned in a UserSubscribedFilesCallback from a SteamClient.JobCallback<T>.
HandleMsg ( IPacketMsg packetMsg ) : void	Handles a client message. This should not be called directly.
RequestPublishedFileDetails ( PublishedFileID publishedFileId ) : JobID	Requests details for a given published workshop file. Results are returned in a PublishedFileDetailsCallback from a SteamClient.JobCallback<T>.

Private Methods

Method	Description
HandleEnumPublishedFiles ( IPacketMsg packetMsg ) : void
HandleEnumPublishedFilesByAction ( IPacketMsg packetMsg ) : void
HandleEnumUserPublishedFiles ( IPacketMsg packetMsg ) : void
HandleEnumUserSubscribedFiles ( IPacketMsg packetMsg ) : void
HandlePublishedFileDetails ( IPacketMsg packetMsg ) : void
SteamWorkshop ( ) : System.Collections.Generic

Method Details

EnumeratePublishedFiles() public method

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

public EnumeratePublishedFiles ( EnumerationDetails details ) : JobID
details	EnumerationDetails	The specific details of the request.
return	JobID

EnumeratePublishedFilesByUserAction() public method

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

public EnumeratePublishedFilesByUserAction ( EnumerationUserDetails details ) : JobID
details	EnumerationUserDetails	The specific details of the request.
return	JobID

EnumerateUserPublishedFiles() public method

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

public EnumerateUserPublishedFiles ( EnumerationUserDetails details ) : JobID
details	EnumerationUserDetails	The specific details of the request.
return	JobID

EnumerateUserSubscribedFiles() public method

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

public EnumerateUserSubscribedFiles ( EnumerationUserDetails details ) : JobID
details	EnumerationUserDetails	The specific details of the request.
return	JobID

HandleMsg() public method

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

public HandleMsg ( IPacketMsg packetMsg ) : void
packetMsg	IPacketMsg	The packet message that contains the data.
return	void

RequestPublishedFileDetails() public method

Requests details for a given published workshop file. Results are returned in a PublishedFileDetailsCallback from a SteamClient.JobCallback<T>.

public RequestPublishedFileDetails ( PublishedFileID publishedFileId ) : JobID
publishedFileId	PublishedFileID	The file ID being requested.
return	JobID