Skip to content

steammessages_publishedfile.steamworkssdk.proto

  • Module: steammessages_publishedfile.steamworkssdk_pb2
  • Syntax: unknown
  • Package: (none)
  • Imports: 1
  • Messages: 21 (top-level: 15)
  • Enums: 0 (top-level: 0)

Imports

  • steammessages_unified_base.steamworkssdk.proto

Messages

Expand any message to inspect all fields.

CPublishedFile_Subscribe_Request — fields: 4; oneofs: 0; nested messages: 0; nested enums: 0
  • Parent: (top-level)
  • Oneofs: (none)
TagFieldTypeLabelOneofNotes
1publishedfileiduint64optional``
2list_typeuint32optional``
3appidint32optional``
4notify_clientbooloptional``
CPublishedFile_Subscribe_Response — fields: 0; oneofs: 0; nested messages: 0; nested enums: 0
  • Parent: (top-level)
  • Oneofs: (none)
TagFieldTypeLabelOneofNotes
-(none)
CPublishedFile_Unsubscribe_Request — fields: 4; oneofs: 0; nested messages: 0; nested enums: 0
  • Parent: (top-level)
  • Oneofs: (none)
TagFieldTypeLabelOneofNotes
1publishedfileiduint64optional``
2list_typeuint32optional``
3appidint32optional``
4notify_clientbooloptional``
CPublishedFile_Unsubscribe_Response — fields: 0; oneofs: 0; nested messages: 0; nested enums: 0
  • Parent: (top-level)
  • Oneofs: (none)
TagFieldTypeLabelOneofNotes
-(none)
CPublishedFile_Publish_Request — fields: 16; oneofs: 0; nested messages: 0; nested enums: 0
  • Parent: (top-level)
  • Oneofs: (none)
TagFieldTypeLabelOneofNotes
1appiduint32optional``(description) = "App Id this file is being published FROM."
2consumer_appiduint32optional``(description) = "App Id this file is being published TO."
3cloudfilenamestringoptional``(description) = "Name of the file to publish in the user's cloud."
4preview_cloudfilenamestringoptional``(description) = "Name of the file to use as the published file's preview."
5titlestringoptional``(description) = "Text title for the published file."
6file_descriptionstringoptional``(description) = "Text description for the published file."
7file_typeuint32optional``(description) = "(EWorkshopFileType) Type of Workshop file to publish."
8consumer_shortcut_namestringoptional``(description) = "Shortcut name for the published file."
9youtube_usernamestringoptional``(description) = "(Optional) User's YouTube account username."
10youtube_videoidstringoptional``(description) = "(Optional) Video Id of a YouTube video for this published file."
11visibilityuint32optional``(description) = "(ERemoteStoragePublishedFileVisibility) Visibility of the published file (private, friends, public, etc.)"
12redirect_uristringoptional``(description) = "(Optional) If supplied, the resulting published file's Id is appended to the URI."
13tagsstringrepeated``(description) = "Array of text tags to apply to the published file."
14collection_typestringoptional``(description) = "(Optional) Type of collection the published file represents."
15game_typestringoptional``(description) = "(Optional) Type of game the published file represents."
16urlstringoptional``(description) = "(Optional) If this represents a game, this is the URL to that game's page."
CPublishedFile_Publish_Response — fields: 2; oneofs: 0; nested messages: 0; nested enums: 0
  • Parent: (top-level)
  • Oneofs: (none)
TagFieldTypeLabelOneofNotes
1publishedfileiduint64optional``
2redirect_uristringoptional``
CPublishedFile_GetDetails_Request — fields: 7; oneofs: 0; nested messages: 0; nested enums: 0
  • Parent: (top-level)
  • Oneofs: (none)
TagFieldTypeLabelOneofNotes
1publishedfileidsfixed64repeated``(description) = "Set of published file Ids to retrieve details for."
2includetagsbooloptional``(description) = "If true, return tag information in the returned details."
3includeadditionalpreviewsbooloptional``(description) = "If true, return preview information in the returned details."
4includechildrenbooloptional``(description) = "If true, return children in the returned details."
5includekvtagsbooloptional``(description) = "If true, return key value tags in the returned details."
6includevotesbooloptional``(description) = "If true, return vote data in the returned details."
8short_descriptionbooloptional``(description) = "If true, return a short description instead of the full description."
PublishedFileDetails — fields: 56; oneofs: 0; nested messages: 5; nested enums: 0
  • Parent: (top-level)
  • Oneofs: (none)
TagFieldTypeLabelOneofNotes
1resultuint32optional``
2publishedfileiduint64optional``
3creatorfixed64optional``
4creator_appiduint32optional``
5consumer_appiduint32optional``
6consumer_shortcutiduint32optional``
7filenamestringoptional``
8file_sizeuint64optional``
9preview_file_sizeuint64optional``
10file_urlstringoptional``
11preview_urlstringoptional``
12youtubevideoidstringoptional``
13urlstringoptional``
14hcontent_filefixed64optional``
15hcontent_previewfixed64optional``
16titlestringoptional``
17file_descriptionstringoptional``
18short_descriptionstringoptional``
19time_createduint32optional``
20time_updateduint32optional``
21visibilityuint32optional``
22flagsuint32optional``
23workshop_filebooloptional``
24workshop_acceptedbooloptional``
25show_subscribe_allbooloptional``
26num_comments_developerint32optional``
27num_comments_publicint32optional``
28bannedbooloptional``
29ban_reasonstringoptional``
30bannerfixed64optional``
31can_be_deletedbooloptional``
32incompatiblebooloptional``
33app_namestringoptional``
34file_typeuint32optional``
35can_subscribebooloptional``
36subscriptionsuint32optional``
37favoriteduint32optional``
38followersuint32optional``
39lifetime_subscriptionsuint32optional``
40lifetime_favoriteduint32optional``
41lifetime_followersuint32optional``
42viewsuint32optional``
43image_widthuint32optional``
44image_heightuint32optional``
45image_urlstringoptional``
46spoiler_tagbooloptional``
47shortcutiduint32optional``
48shortcutnamestringoptional``
49num_childrenuint32optional``
50num_reportsuint32optional``
51previews.PublishedFileDetails.Previewrepeated``
52tags.PublishedFileDetails.Tagrepeated``
53children.PublishedFileDetails.Childrepeated``
54kvtags.PublishedFileDetails.KVTagrepeated``
55vote_data.PublishedFileDetails.VoteDataoptional``
56time_subscribeduint32optional``(description) = "Only valid in PublishedFile.GetUserFiles and not normal PublishedFile.GetDetail calls"
PublishedFileDetails.Tag — fields: 2; oneofs: 0; nested messages: 0; nested enums: 0
  • Parent: PublishedFileDetails
  • Oneofs: (none)
TagFieldTypeLabelOneofNotes
1tagstringoptional``
2adminonlybooloptional``
PublishedFileDetails.Preview — fields: 6; oneofs: 0; nested messages: 0; nested enums: 0
  • Parent: PublishedFileDetails
  • Oneofs: (none)
TagFieldTypeLabelOneofNotes
1previewiduint64optional``
2sortorderuint32optional``
3urlstringoptional``
4sizeuint32optional``
5filenamestringoptional``
6youtubevideoidstringoptional``
PublishedFileDetails.Child — fields: 3; oneofs: 0; nested messages: 0; nested enums: 0
  • Parent: PublishedFileDetails
  • Oneofs: (none)
TagFieldTypeLabelOneofNotes
1publishedfileiduint64optional``
2sortorderuint32optional``
3file_typeuint32optional``
PublishedFileDetails.KVTag — fields: 2; oneofs: 0; nested messages: 0; nested enums: 0
  • Parent: PublishedFileDetails
  • Oneofs: (none)
TagFieldTypeLabelOneofNotes
1keystringoptional``
2valuestringoptional``
PublishedFileDetails.VoteData — fields: 3; oneofs: 0; nested messages: 0; nested enums: 0
  • Parent: PublishedFileDetails
  • Oneofs: (none)
TagFieldTypeLabelOneofNotes
1scorefloatoptional``
2votes_upuint32optional``
3votes_downuint32optional``
CPublishedFile_GetDetails_Response — fields: 1; oneofs: 0; nested messages: 0; nested enums: 0
  • Parent: (top-level)
  • Oneofs: (none)
TagFieldTypeLabelOneofNotes
1publishedfiledetails.PublishedFileDetailsrepeated``
CPublishedFile_GetUserFiles_Request — fields: 9; oneofs: 0; nested messages: 0; nested enums: 0
  • Parent: (top-level)
  • Oneofs: (none)
TagFieldTypeLabelOneofNotes
1appiduint32optional``(description) = "App Id to retrieve published files from."
3pageuint32optional``default = 1, (description) = "(Optional) Starting page for results."
4numperpageuint32optional``default = 1, (description) = "(Optional) The number of results, per page to return."
6sortmethodstringoptional``default = "lastupdated", (description) = "(Optional) Sorting method to use on returned values."
7totalonlybooloptional``(description) = "(Optional) If true, only return the total number of files that satisfy this query."
9privacyuint32optional``(description) = "(optional) Filter by privacy settings."
10ids_onlybooloptional``(description) = "(Optional) If true, only return the published file ids of files that satisfy this query."
11requiredtagsstringrepeated``(description) = "(Optional) Tags that must be present on a published file to satisfy the query."
12excludedtagsstringrepeated``(description) = "(Optional) Tags that must NOT be present on a published file to satisfy the query."
CPublishedFile_GetUserFiles_Response — fields: 4; oneofs: 0; nested messages: 1; nested enums: 0
  • Parent: (top-level)
  • Oneofs: (none)
TagFieldTypeLabelOneofNotes
1totaluint32optional``
2startindexuint32optional``
3publishedfiledetails.PublishedFileDetailsrepeated``
4apps.CPublishedFile_GetUserFiles_Response.Apprepeated``
CPublishedFile_GetUserFiles_Response.App — fields: 4; oneofs: 0; nested messages: 0; nested enums: 0
  • Parent: CPublishedFile_GetUserFiles_Response
  • Oneofs: (none)
TagFieldTypeLabelOneofNotes
1appiduint32optional``
2namestringoptional``
3shortcutiduint32optional``
4privatebooloptional``
CPublishedFile_Update_Request — fields: 8; oneofs: 0; nested messages: 0; nested enums: 0
  • Parent: (top-level)
  • Oneofs: (none)
TagFieldTypeLabelOneofNotes
1appiduint32optional``(description) = "App Id this published file belongs to."
2publishedfileidfixed64optional``(description) = "Published file id of the file we'd like update."
3titlestringoptional``(description) = "(Optional) Title of the published file."
4file_descriptionstringoptional``(description) = "(Optional) Description of the published file."
5visibilityuint32optional``(description) = "(Optional) Visibility of the published file."
6tagsstringrepeated``(description) = "(Optional) Set of tags for the published file."
7filenamestringoptional``(description) = "(Optional) Filename for the published file."
8preview_filenamestringoptional``(description) = "(Optional) Preview filename for the published file."
CPublishedFile_Update_Response — fields: 0; oneofs: 0; nested messages: 0; nested enums: 0
  • Parent: (top-level)
  • Oneofs: (none)
TagFieldTypeLabelOneofNotes
-(none)
CPublishedFile_RefreshVotingQueue_Request — fields: 6; oneofs: 0; nested messages: 0; nested enums: 0
  • Parent: (top-level)
  • Oneofs: (none)
TagFieldTypeLabelOneofNotes
1appiduint32optional``
2matching_file_typeuint32optional``(description) = "EPublishedFileInfoMatchingFileType"
3tagsstringrepeated``(description) = "Include files that have all the tags or any of the tags if match_all_tags is set to false."
4match_all_tagsbooloptional``default = true, (description) = "If true, then files must have all the tags specified. If false, then must have at least one of the tags specified."
5excluded_tagsstringrepeated``(description) = "Exclude any files that have any of these tags."
6desired_queue_sizeuint32optional``(description) = "Desired number of items in the voting queue. May be clamped by the server"
CPublishedFile_RefreshVotingQueue_Response — fields: 0; oneofs: 0; nested messages: 0; nested enums: 0
  • Parent: (top-level)
  • Oneofs: (none)
TagFieldTypeLabelOneofNotes
-(none)

Enums

Expand any enum to inspect all values.

(No enums in this proto file.)