steamutils 1.4.36 → 1.4.38

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (243) hide show
  1. package/.idea/codeStyles/Project.xml +1 -0
  2. package/.idea/deployment.xml +14 -0
  3. package/.prettierrc.json +3 -3
  4. package/SteamClient.js +24 -22
  5. package/_steamproto.js +29 -29
  6. package/axios.js +84 -84
  7. package/bufferHelpers.js +115 -115
  8. package/cheerio.js +103 -103
  9. package/const.js +451 -451
  10. package/create_proto.js +47 -47
  11. package/create_remote_file.js +66 -66
  12. package/helpers/protos.js +52 -52
  13. package/package.json +1 -1
  14. package/protos/csgo/base_gcmessages.proto +553 -553
  15. package/protos/csgo/base_gcmessages_csgo.proto +547 -547
  16. package/protos/csgo/c_peer2peer_netmessages.proto +55 -55
  17. package/protos/csgo/clientmessages.proto +48 -48
  18. package/protos/csgo/connectionless_netmessages.proto +17 -17
  19. package/protos/csgo/cs_gameevents.proto +35 -35
  20. package/protos/csgo/cs_usercmd.proto +34 -34
  21. package/protos/csgo/cstrike15_gcmessages.proto +1431 -1431
  22. package/protos/csgo/cstrike15_usermessages.proto +592 -592
  23. package/protos/csgo/demo.proto +165 -165
  24. package/protos/csgo/econ_gcmessages.proto +219 -219
  25. package/protos/csgo/engine_gcmessages.proto +1 -1
  26. package/protos/csgo/enums_clientserver.proto +1529 -1529
  27. package/protos/csgo/fatdemo.proto +125 -125
  28. package/protos/csgo/gameevents.proto +120 -120
  29. package/protos/csgo/gcsdk_gcmessages.proto +323 -323
  30. package/protos/csgo/gcsystemmsgs.proto +243 -243
  31. package/protos/csgo/netmessages.proto +618 -618
  32. package/protos/csgo/network_connection.proto +1 -1
  33. package/protos/csgo/networkbasetypes.proto +246 -246
  34. package/protos/csgo/networksystem_protomessages.proto +17 -17
  35. package/protos/csgo/steamdatagram_messages_auth.proto +65 -65
  36. package/protos/csgo/steamdatagram_messages_sdr.proto +534 -534
  37. package/protos/csgo/steammessages.proto +1 -1
  38. package/protos/csgo/steammessages_base.proto +1 -1
  39. package/protos/csgo/steammessages_cloud.steamworkssdk.proto +68 -68
  40. package/protos/csgo/steammessages_gamenetworkingui.proto +61 -61
  41. package/protos/csgo/steammessages_helprequest.steamworkssdk.proto +22 -22
  42. package/protos/csgo/steammessages_oauth.steamworkssdk.proto +18 -18
  43. package/protos/csgo/steammessages_player.steamworkssdk.proto +254 -254
  44. package/protos/csgo/steammessages_publishedfile.steamworkssdk.proto +233 -233
  45. package/protos/csgo/steammessages_unified_base.steamworkssdk.proto +1 -1
  46. package/protos/csgo/steamnetworkingsockets_messages.proto +205 -205
  47. package/protos/csgo/steamnetworkingsockets_messages_certs.proto +39 -39
  48. package/protos/csgo/steamnetworkingsockets_messages_udp.proto +75 -75
  49. package/protos/csgo/te.proto +259 -259
  50. package/protos/csgo/uifontfile_format.proto +13 -13
  51. package/protos/csgo/usercmd.proto +39 -39
  52. package/protos/csgo/usermessages.proto +752 -752
  53. package/protos/csgo/valveextensions.proto +1 -1
  54. package/protos/google/protobuf/descriptor.proto +281 -281
  55. package/protos/steam/clientmetrics.proto +45 -45
  56. package/protos/steam/content_manifest.proto +62 -62
  57. package/protos/steam/contenthubs.proto +41 -41
  58. package/protos/steam/encrypted_app_ticket.proto +10 -10
  59. package/protos/steam/enums.proto +501 -501
  60. package/protos/steam/enums_clientserver.proto +1508 -1508
  61. package/protos/steam/enums_productinfo.proto +14 -14
  62. package/protos/steam/htmlmessages.proto +1039 -1039
  63. package/protos/steam/offline_ticket.proto +8 -8
  64. package/protos/steam/steamdatagram_messages_auth.proto +65 -65
  65. package/protos/steam/steamdatagram_messages_sdr.proto +533 -533
  66. package/protos/steam/steammessages_accounthardware.steamclient.proto +167 -167
  67. package/protos/steam/steammessages_appoverview.proto +204 -204
  68. package/protos/steam/steammessages_auth.steamclient.proto +375 -375
  69. package/protos/steam/steammessages_base.proto +1 -1
  70. package/protos/steam/steammessages_broadcast.steamclient.proto +618 -618
  71. package/protos/steam/steammessages_chat.steamclient.proto +1070 -1070
  72. package/protos/steam/steammessages_client_objects.proto +649 -649
  73. package/protos/steam/steammessages_clientlanp2p.proto +43 -43
  74. package/protos/steam/steammessages_clientmetrics.steamclient.proto +192 -192
  75. package/protos/steam/steammessages_clientnotificationtypes.proto +250 -250
  76. package/protos/steam/steammessages_clientserver.proto +392 -392
  77. package/protos/steam/steammessages_clientserver_2.proto +771 -771
  78. package/protos/steam/steammessages_clientserver_appinfo.proto +131 -131
  79. package/protos/steam/steammessages_clientserver_friends.proto +260 -260
  80. package/protos/steam/steammessages_clientserver_gameservers.proto +159 -159
  81. package/protos/steam/steammessages_clientserver_lbs.proto +70 -70
  82. package/protos/steam/steammessages_clientserver_login.proto +167 -167
  83. package/protos/steam/steammessages_clientserver_mms.proto +233 -233
  84. package/protos/steam/steammessages_clientserver_ucm.proto +207 -207
  85. package/protos/steam/steammessages_clientserver_uds.proto +125 -125
  86. package/protos/steam/steammessages_clientserver_ufs.proto +45 -45
  87. package/protos/steam/steammessages_clientserver_userstats.proto +80 -80
  88. package/protos/steam/steammessages_clientsettings.proto +1 -1
  89. package/protos/steam/steammessages_cloud.steamclient.proto +422 -422
  90. package/protos/steam/steammessages_contentsystem.steamclient.proto +123 -123
  91. package/protos/steam/steammessages_credentials.steamclient.proto +96 -96
  92. package/protos/steam/steammessages_datapublisher.steamclient.proto +102 -102
  93. package/protos/steam/steammessages_depotbuilder.steamclient.proto +99 -99
  94. package/protos/steam/steammessages_deviceauth.steamclient.proto +169 -169
  95. package/protos/steam/steammessages_econ.steamclient.proto +137 -137
  96. package/protos/steam/steammessages_familygroups.steamclient.proto +441 -441
  97. package/protos/steam/steammessages_friendmessages.steamclient.proto +141 -141
  98. package/protos/steam/steammessages_gamenetworking.steamclient.proto +25 -25
  99. package/protos/steam/steammessages_gamenetworkingui.proto +61 -61
  100. package/protos/steam/steammessages_gamenotifications.steamclient.proto +131 -131
  101. package/protos/steam/steammessages_gameservers.steamclient.proto +136 -136
  102. package/protos/steam/steammessages_hiddevices.proto +157 -157
  103. package/protos/steam/steammessages_inventory.steamclient.proto +172 -172
  104. package/protos/steam/steammessages_linkfilter.steamclient.proto +39 -39
  105. package/protos/steam/steammessages_lobbymatchmaking.steamclient.proto +29 -29
  106. package/protos/steam/steammessages_market.steamclient.proto +22 -22
  107. package/protos/steam/steammessages_marketingmessages.steamclient.proto +273 -273
  108. package/protos/steam/steammessages_offline.steamclient.proto +33 -33
  109. package/protos/steam/steammessages_parental.steamclient.proto +262 -262
  110. package/protos/steam/steammessages_parties.steamclient.proto +75 -75
  111. package/protos/steam/steammessages_partnerapps.steamclient.proto +106 -106
  112. package/protos/steam/steammessages_player.steamclient.proto +915 -915
  113. package/protos/steam/steammessages_publishedfile.steamclient.proto +737 -737
  114. package/protos/steam/steammessages_qms.steamclient.proto +111 -111
  115. package/protos/steam/steammessages_remoteclient.proto +100 -100
  116. package/protos/steam/steammessages_remoteclient_discovery.proto +244 -244
  117. package/protos/steam/steammessages_remoteclient_service.steamclient.proto +31 -31
  118. package/protos/steam/steammessages_remoteclient_service_messages.proto +217 -217
  119. package/protos/steam/steammessages_remoteplay.proto +975 -975
  120. package/protos/steam/steammessages_secrets.steamclient.proto +35 -35
  121. package/protos/steam/steammessages_shader.steamclient.proto +89 -89
  122. package/protos/steam/steammessages_site_license.steamclient.proto +103 -103
  123. package/protos/steam/steammessages_sitelicenseclient.proto +38 -38
  124. package/protos/steam/steammessages_siteserverui.proto +130 -130
  125. package/protos/steam/steammessages_steamtv.steamclient.proto +533 -533
  126. package/protos/steam/steammessages_store.steamclient.proto +404 -404
  127. package/protos/steam/steammessages_storebrowse.steamclient.proto +457 -457
  128. package/protos/steam/steammessages_timedtrial.steamclient.proto +40 -40
  129. package/protos/steam/steammessages_twofactor.steamclient.proto +157 -157
  130. package/protos/steam/steammessages_unified_base.steamclient.proto +1 -1
  131. package/protos/steam/steammessages_unified_test.steamclient.proto +51 -51
  132. package/protos/steam/steammessages_useraccount.steamclient.proto +211 -211
  133. package/protos/steam/steammessages_vac.steamclient.proto +37 -37
  134. package/protos/steam/steammessages_video.steamclient.proto +68 -68
  135. package/protos/steam/steammessages_virtualcontroller.proto +138 -138
  136. package/protos/steam/steammessages_workshop.steamclient.proto +19 -19
  137. package/protos/steam/steamnetworkingsockets_messages.proto +205 -205
  138. package/protos/steam/steamnetworkingsockets_messages_certs.proto +39 -39
  139. package/protos/steam/steamnetworkingsockets_messages_udp.proto +75 -75
  140. package/protos/steam/webuimessages_achievements.proto +29 -29
  141. package/protos/steam/webuimessages_base.proto +1 -1
  142. package/protos/steam/webuimessages_gamenotes.proto +21 -21
  143. package/protos/steam/webuimessages_gamescope.proto +57 -57
  144. package/protos/steam/webuimessages_steamengine.proto +41 -41
  145. package/protos/steam/webuimessages_steamos.proto +114 -114
  146. package/protos/steam/webuimessages_storagedevicemanager.proto +110 -110
  147. package/protos/steam/webuimessages_systemmanager.proto +17 -17
  148. package/protos/steam/webuimessages_transport.proto +22 -22
  149. package/protos/steam/webuimessages_transportvalidation.proto +111 -111
  150. package/protos/webui/common.proto +4024 -4024
  151. package/protos/webui/common_base.proto +1 -1
  152. package/protos/webui/service_accountcart.proto +153 -153
  153. package/protos/webui/service_accountlinking.proto +27 -27
  154. package/protos/webui/service_accountprivacy.proto +42 -42
  155. package/protos/webui/service_accountprivateapps.proto +34 -34
  156. package/protos/webui/service_auction.proto +97 -97
  157. package/protos/webui/service_authentication.proto +222 -222
  158. package/protos/webui/service_authenticationsupport.proto +74 -74
  159. package/protos/webui/service_broadcast.proto +562 -562
  160. package/protos/webui/service_chat.proto +11 -11
  161. package/protos/webui/service_chatroom.proto +810 -810
  162. package/protos/webui/service_chatusability.proto +107 -107
  163. package/protos/webui/service_checkout.proto +84 -84
  164. package/protos/webui/service_clan.proto +41 -41
  165. package/protos/webui/service_clanchatrooms.proto +25 -25
  166. package/protos/webui/service_clanfaqs.proto +202 -202
  167. package/protos/webui/service_clientcomm.proto +151 -151
  168. package/protos/webui/service_clientmetrics.proto +22 -22
  169. package/protos/webui/service_cloud.proto +222 -222
  170. package/protos/webui/service_cloudconfigstore.proto +51 -51
  171. package/protos/webui/service_cloudgaming.proto +30 -30
  172. package/protos/webui/service_community.proto +365 -365
  173. package/protos/webui/service_dailydeal.proto +89 -89
  174. package/protos/webui/service_econ.proto +134 -134
  175. package/protos/webui/service_embedded.proto +24 -24
  176. package/protos/webui/service_experimentservice.proto +6 -6
  177. package/protos/webui/service_familygroups.proto +355 -355
  178. package/protos/webui/service_fovasvideo.proto +15 -15
  179. package/protos/webui/service_friendmessages.proto +133 -133
  180. package/protos/webui/service_friendslist.proto +70 -70
  181. package/protos/webui/service_gamenotes.proto +15 -15
  182. package/protos/webui/service_gamerecording.proto +265 -265
  183. package/protos/webui/service_gamerecordingclip.proto +85 -85
  184. package/protos/webui/service_gamerecordingdebug.proto +52 -52
  185. package/protos/webui/service_helprequestlogs.proto +16 -16
  186. package/protos/webui/service_loyaltyrewards.proto +252 -252
  187. package/protos/webui/service_marketingmessages.proto +215 -215
  188. package/protos/webui/service_mobileapp.proto +18 -18
  189. package/protos/webui/service_mobileauth.proto +24 -24
  190. package/protos/webui/service_mobiledevice.proto +26 -26
  191. package/protos/webui/service_mobileperaccount.proto +31 -31
  192. package/protos/webui/service_news.proto +110 -110
  193. package/protos/webui/service_parental.proto +258 -258
  194. package/protos/webui/service_partnermembershipinvite.proto +34 -34
  195. package/protos/webui/service_partnerstorebrowse.proto +28 -28
  196. package/protos/webui/service_phone.proto +51 -51
  197. package/protos/webui/service_physicalgoods.proto +15 -15
  198. package/protos/webui/service_player.proto +918 -918
  199. package/protos/webui/service_promotioneventinvites.proto +109 -109
  200. package/protos/webui/service_promotionplanning.proto +186 -186
  201. package/protos/webui/service_promotionstats.proto +23 -23
  202. package/protos/webui/service_publishedfile.proto +714 -714
  203. package/protos/webui/service_publishing.proto +200 -200
  204. package/protos/webui/service_quest.proto +127 -127
  205. package/protos/webui/service_salefeature.proto +373 -373
  206. package/protos/webui/service_saleitemrewards.proto +54 -54
  207. package/protos/webui/service_shoppingcart.proto +152 -152
  208. package/protos/webui/service_steamawards.proto +76 -76
  209. package/protos/webui/service_steamcharts.proto +75 -75
  210. package/protos/webui/service_steamengine.proto +36 -36
  211. package/protos/webui/service_steamlearn.proto +876 -876
  212. package/protos/webui/service_steamnotification.proto +73 -73
  213. package/protos/webui/service_steamtv.proto +495 -495
  214. package/protos/webui/service_steamvrvoicechat.proto +67 -67
  215. package/protos/webui/service_steamvrwebrtc.proto +48 -48
  216. package/protos/webui/service_storagedevicemanager.proto +104 -104
  217. package/protos/webui/service_store.proto +359 -359
  218. package/protos/webui/service_storeappsimilarity.proto +76 -76
  219. package/protos/webui/service_storebrowse.proto +103 -103
  220. package/protos/webui/service_storemarketing.proto +44 -44
  221. package/protos/webui/service_storequery.proto +103 -103
  222. package/protos/webui/service_storesales.proto +87 -87
  223. package/protos/webui/service_storetopsellers.proto +44 -44
  224. package/protos/webui/service_systemmanager.proto +11 -11
  225. package/protos/webui/service_test_transporterror.proto +6 -6
  226. package/protos/webui/service_transportauth.proto +17 -17
  227. package/protos/webui/service_transportvalidation.proto +69 -69
  228. package/protos/webui/service_twofactor.proto +170 -170
  229. package/protos/webui/service_useraccount.proto +142 -142
  230. package/protos/webui/service_usergameactivity.proto +34 -34
  231. package/protos/webui/service_usergamenotes.proto +70 -70
  232. package/protos/webui/service_usernews.proto +68 -68
  233. package/protos/webui/service_userreviews.proto +97 -97
  234. package/protos/webui/service_video.proto +50 -50
  235. package/protos/webui/service_videoclip.proto +62 -62
  236. package/protos/webui/service_voicechat.proto +139 -139
  237. package/protos/webui/service_webrtc.proto +52 -52
  238. package/remote.js +6784 -6784
  239. package/steamproto.js +6159 -6159
  240. package/utils.js +872 -872
  241. package/.idea/gbrowser_project.xml +0 -11
  242. package/.idea/git_toolbox_blame.xml +0 -6
  243. package/.idea/git_toolbox_prj.xml +0 -15
@@ -1,233 +1,233 @@
1
- import "steammessages_unified_base.steamworkssdk.proto";
2
-
3
- message CPublishedFile_Subscribe_Request {
4
- optional uint64 publishedfileid = 1;
5
- optional uint32 list_type = 2;
6
- optional int32 appid = 3;
7
- optional bool notify_client = 4;
8
- }
9
-
10
- message CPublishedFile_Subscribe_Response {
11
- }
12
-
13
- message CPublishedFile_Unsubscribe_Request {
14
- optional uint64 publishedfileid = 1;
15
- optional uint32 list_type = 2;
16
- optional int32 appid = 3;
17
- optional bool notify_client = 4;
18
- }
19
-
20
- message CPublishedFile_Unsubscribe_Response {
21
- }
22
-
23
- message CPublishedFile_Publish_Request {
24
- optional uint32 appid = 1 [(description) = "App Id this file is being published FROM."];
25
- optional uint32 consumer_appid = 2 [(description) = "App Id this file is being published TO."];
26
- optional string cloudfilename = 3 [(description) = "Name of the file to publish in the user's cloud."];
27
- optional string preview_cloudfilename = 4 [(description) = "Name of the file to use as the published file's preview."];
28
- optional string title = 5 [(description) = "Text title for the published file."];
29
- optional string file_description = 6 [(description) = "Text description for the published file."];
30
- optional uint32 file_type = 7 [(description) = "(EWorkshopFileType) Type of Workshop file to publish."];
31
- optional string consumer_shortcut_name = 8 [(description) = "Shortcut name for the published file."];
32
- optional string youtube_username = 9 [(description) = "(Optional) User's YouTube account username."];
33
- optional string youtube_videoid = 10 [(description) = "(Optional) Video Id of a YouTube video for this published file."];
34
- optional uint32 visibility = 11 [(description) = "(ERemoteStoragePublishedFileVisibility) Visibility of the published file (private, friends, public, etc.)"];
35
- optional string redirect_uri = 12 [(description) = "(Optional) If supplied, the resulting published file's Id is appended to the URI."];
36
- repeated string tags = 13 [(description) = "Array of text tags to apply to the published file."];
37
- optional string collection_type = 14 [(description) = "(Optional) Type of collection the published file represents."];
38
- optional string game_type = 15 [(description) = "(Optional) Type of game the published file represents."];
39
- optional string url = 16 [(description) = "(Optional) If this represents a game, this is the URL to that game's page."];
40
- }
41
-
42
- message CPublishedFile_Publish_Response {
43
- optional uint64 publishedfileid = 1;
44
- optional string redirect_uri = 2;
45
- }
46
-
47
- message CPublishedFile_GetDetails_Request {
48
- repeated fixed64 publishedfileids = 1 [(description) = "Set of published file Ids to retrieve details for."];
49
- optional bool includetags = 2 [(description) = "If true, return tag information in the returned details."];
50
- optional bool includeadditionalpreviews = 3 [(description) = "If true, return preview information in the returned details."];
51
- optional bool includechildren = 4 [(description) = "If true, return children in the returned details."];
52
- optional bool includekvtags = 5 [(description) = "If true, return key value tags in the returned details."];
53
- optional bool includevotes = 6 [(description) = "If true, return vote data in the returned details."];
54
- optional bool short_description = 8 [(description) = "If true, return a short description instead of the full description."];
55
- }
56
-
57
- message PublishedFileDetails {
58
- message Tag {
59
- optional string tag = 1;
60
- optional bool adminonly = 2;
61
- }
62
-
63
- message Preview {
64
- optional uint64 previewid = 1;
65
- optional uint32 sortorder = 2;
66
- optional string url = 3;
67
- optional uint32 size = 4;
68
- optional string filename = 5;
69
- optional string youtubevideoid = 6;
70
- }
71
-
72
- message Child {
73
- optional uint64 publishedfileid = 1;
74
- optional uint32 sortorder = 2;
75
- optional uint32 file_type = 3;
76
- }
77
-
78
- message KVTag {
79
- optional string key = 1;
80
- optional string value = 2;
81
- }
82
-
83
- message VoteData {
84
- optional float score = 1;
85
- optional uint32 votes_up = 2;
86
- optional uint32 votes_down = 3;
87
- }
88
-
89
- optional uint32 result = 1;
90
- optional uint64 publishedfileid = 2;
91
- optional fixed64 creator = 3;
92
- optional uint32 creator_appid = 4;
93
- optional uint32 consumer_appid = 5;
94
- optional uint32 consumer_shortcutid = 6;
95
- optional string filename = 7;
96
- optional uint64 file_size = 8;
97
- optional uint64 preview_file_size = 9;
98
- optional string file_url = 10;
99
- optional string preview_url = 11;
100
- optional string youtubevideoid = 12;
101
- optional string url = 13;
102
- optional fixed64 hcontent_file = 14;
103
- optional fixed64 hcontent_preview = 15;
104
- optional string title = 16;
105
- optional string file_description = 17;
106
- optional string short_description = 18;
107
- optional uint32 time_created = 19;
108
- optional uint32 time_updated = 20;
109
- optional uint32 visibility = 21;
110
- optional uint32 flags = 22;
111
- optional bool workshop_file = 23;
112
- optional bool workshop_accepted = 24;
113
- optional bool show_subscribe_all = 25;
114
- optional int32 num_comments_developer = 26;
115
- optional int32 num_comments_public = 27;
116
- optional bool banned = 28;
117
- optional string ban_reason = 29;
118
- optional fixed64 banner = 30;
119
- optional bool can_be_deleted = 31;
120
- optional bool incompatible = 32;
121
- optional string app_name = 33;
122
- optional uint32 file_type = 34;
123
- optional bool can_subscribe = 35;
124
- optional uint32 subscriptions = 36;
125
- optional uint32 favorited = 37;
126
- optional uint32 followers = 38;
127
- optional uint32 lifetime_subscriptions = 39;
128
- optional uint32 lifetime_favorited = 40;
129
- optional uint32 lifetime_followers = 41;
130
- optional uint32 views = 42;
131
- optional uint32 image_width = 43;
132
- optional uint32 image_height = 44;
133
- optional string image_url = 45;
134
- optional bool spoiler_tag = 46;
135
- optional uint32 shortcutid = 47;
136
- optional string shortcutname = 48;
137
- optional uint32 num_children = 49;
138
- optional uint32 num_reports = 50;
139
- repeated .PublishedFileDetails.Preview previews = 51;
140
- repeated .PublishedFileDetails.Tag tags = 52;
141
- repeated .PublishedFileDetails.Child children = 53;
142
- repeated .PublishedFileDetails.KVTag kvtags = 54;
143
- optional .PublishedFileDetails.VoteData vote_data = 55;
144
- optional uint32 time_subscribed = 56 [(description) = "Only valid in PublishedFile.GetUserFiles and not normal PublishedFile.GetDetail calls"];
145
- }
146
-
147
- message CPublishedFile_GetDetails_Response {
148
- repeated .PublishedFileDetails publishedfiledetails = 1;
149
- }
150
-
151
- message CPublishedFile_GetUserFiles_Request {
152
- optional uint32 appid = 1 [(description) = "App Id to retrieve published files from."];
153
- optional uint32 page = 3 [default = 1, (description) = "(Optional) Starting page for results."];
154
- optional uint32 numperpage = 4 [default = 1, (description) = "(Optional) The number of results, per page to return."];
155
- optional string sortmethod = 6 [default = "lastupdated", (description) = "(Optional) Sorting method to use on returned values."];
156
- optional bool totalonly = 7 [(description) = "(Optional) If true, only return the total number of files that satisfy this query."];
157
- optional uint32 privacy = 9 [(description) = "(optional) Filter by privacy settings."];
158
- optional bool ids_only = 10 [(description) = "(Optional) If true, only return the published file ids of files that satisfy this query."];
159
- repeated string requiredtags = 11 [(description) = "(Optional) Tags that must be present on a published file to satisfy the query."];
160
- repeated string excludedtags = 12 [(description) = "(Optional) Tags that must NOT be present on a published file to satisfy the query."];
161
- }
162
-
163
- message CPublishedFile_GetUserFiles_Response {
164
- message App {
165
- optional uint32 appid = 1;
166
- optional string name = 2;
167
- optional uint32 shortcutid = 3;
168
- optional bool private = 4;
169
- }
170
-
171
- optional uint32 total = 1;
172
- optional uint32 startindex = 2;
173
- repeated .PublishedFileDetails publishedfiledetails = 3;
174
- repeated .CPublishedFile_GetUserFiles_Response.App apps = 4;
175
- }
176
-
177
- message CPublishedFile_Update_Request {
178
- optional uint32 appid = 1 [(description) = "App Id this published file belongs to."];
179
- optional fixed64 publishedfileid = 2 [(description) = "Published file id of the file we'd like update."];
180
- optional string title = 3 [(description) = "(Optional) Title of the published file."];
181
- optional string file_description = 4 [(description) = "(Optional) Description of the published file."];
182
- optional uint32 visibility = 5 [(description) = "(Optional) Visibility of the published file."];
183
- repeated string tags = 6 [(description) = "(Optional) Set of tags for the published file."];
184
- optional string filename = 7 [(description) = "(Optional) Filename for the published file."];
185
- optional string preview_filename = 8 [(description) = "(Optional) Preview filename for the published file."];
186
- }
187
-
188
- message CPublishedFile_Update_Response {
189
- }
190
-
191
- message CPublishedFile_RefreshVotingQueue_Request {
192
- optional uint32 appid = 1;
193
- optional uint32 matching_file_type = 2 [(description) = "EPublishedFileInfoMatchingFileType"];
194
- repeated string tags = 3 [(description) = "Include files that have all the tags or any of the tags if match_all_tags is set to false."];
195
- optional bool match_all_tags = 4 [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."];
196
- repeated string excluded_tags = 5 [(description) = "Exclude any files that have any of these tags."];
197
- optional uint32 desired_queue_size = 6 [(description) = "Desired number of items in the voting queue. May be clamped by the server"];
198
- }
199
-
200
- message CPublishedFile_RefreshVotingQueue_Response {
201
- }
202
-
203
- service PublishedFile {
204
- option (service_description) = "A service to access published file data";
205
-
206
- rpc Subscribe (.CPublishedFile_Subscribe_Request) returns (.CPublishedFile_Subscribe_Response) {
207
- option (method_description) = "Subscribes the user to the published file";
208
- }
209
-
210
- rpc Unsubscribe (.CPublishedFile_Unsubscribe_Request) returns (.CPublishedFile_Unsubscribe_Response) {
211
- option (method_description) = "Unsubscribes the user from the published file";
212
- }
213
-
214
- rpc Publish (.CPublishedFile_Publish_Request) returns (.CPublishedFile_Publish_Response) {
215
- option (method_description) = "Publishes a clouded user file to the Workshop.";
216
- }
217
-
218
- rpc GetDetails (.CPublishedFile_GetDetails_Request) returns (.CPublishedFile_GetDetails_Response) {
219
- option (method_description) = "Retrieves information about a set of published files.";
220
- }
221
-
222
- rpc GetUserFiles (.CPublishedFile_GetUserFiles_Request) returns (.CPublishedFile_GetUserFiles_Response) {
223
- option (method_description) = "Retrieves files published by a user.";
224
- }
225
-
226
- rpc Update (.CPublishedFile_Update_Request) returns (.CPublishedFile_Update_Response) {
227
- option (method_description) = "Updates information about a published file.";
228
- }
229
-
230
- rpc RefreshVotingQueue (.CPublishedFile_RefreshVotingQueue_Request) returns (.CPublishedFile_RefreshVotingQueue_Response) {
231
- option (method_description) = "Refresh the voting queue for the user";
232
- }
233
- }
1
+ import "steammessages_unified_base.steamworkssdk.proto";
2
+
3
+ message CPublishedFile_Subscribe_Request {
4
+ optional uint64 publishedfileid = 1;
5
+ optional uint32 list_type = 2;
6
+ optional int32 appid = 3;
7
+ optional bool notify_client = 4;
8
+ }
9
+
10
+ message CPublishedFile_Subscribe_Response {
11
+ }
12
+
13
+ message CPublishedFile_Unsubscribe_Request {
14
+ optional uint64 publishedfileid = 1;
15
+ optional uint32 list_type = 2;
16
+ optional int32 appid = 3;
17
+ optional bool notify_client = 4;
18
+ }
19
+
20
+ message CPublishedFile_Unsubscribe_Response {
21
+ }
22
+
23
+ message CPublishedFile_Publish_Request {
24
+ optional uint32 appid = 1 [(description) = "App Id this file is being published FROM."];
25
+ optional uint32 consumer_appid = 2 [(description) = "App Id this file is being published TO."];
26
+ optional string cloudfilename = 3 [(description) = "Name of the file to publish in the user's cloud."];
27
+ optional string preview_cloudfilename = 4 [(description) = "Name of the file to use as the published file's preview."];
28
+ optional string title = 5 [(description) = "Text title for the published file."];
29
+ optional string file_description = 6 [(description) = "Text description for the published file."];
30
+ optional uint32 file_type = 7 [(description) = "(EWorkshopFileType) Type of Workshop file to publish."];
31
+ optional string consumer_shortcut_name = 8 [(description) = "Shortcut name for the published file."];
32
+ optional string youtube_username = 9 [(description) = "(Optional) User's YouTube account username."];
33
+ optional string youtube_videoid = 10 [(description) = "(Optional) Video Id of a YouTube video for this published file."];
34
+ optional uint32 visibility = 11 [(description) = "(ERemoteStoragePublishedFileVisibility) Visibility of the published file (private, friends, public, etc.)"];
35
+ optional string redirect_uri = 12 [(description) = "(Optional) If supplied, the resulting published file's Id is appended to the URI."];
36
+ repeated string tags = 13 [(description) = "Array of text tags to apply to the published file."];
37
+ optional string collection_type = 14 [(description) = "(Optional) Type of collection the published file represents."];
38
+ optional string game_type = 15 [(description) = "(Optional) Type of game the published file represents."];
39
+ optional string url = 16 [(description) = "(Optional) If this represents a game, this is the URL to that game's page."];
40
+ }
41
+
42
+ message CPublishedFile_Publish_Response {
43
+ optional uint64 publishedfileid = 1;
44
+ optional string redirect_uri = 2;
45
+ }
46
+
47
+ message CPublishedFile_GetDetails_Request {
48
+ repeated fixed64 publishedfileids = 1 [(description) = "Set of published file Ids to retrieve details for."];
49
+ optional bool includetags = 2 [(description) = "If true, return tag information in the returned details."];
50
+ optional bool includeadditionalpreviews = 3 [(description) = "If true, return preview information in the returned details."];
51
+ optional bool includechildren = 4 [(description) = "If true, return children in the returned details."];
52
+ optional bool includekvtags = 5 [(description) = "If true, return key value tags in the returned details."];
53
+ optional bool includevotes = 6 [(description) = "If true, return vote data in the returned details."];
54
+ optional bool short_description = 8 [(description) = "If true, return a short description instead of the full description."];
55
+ }
56
+
57
+ message PublishedFileDetails {
58
+ message Tag {
59
+ optional string tag = 1;
60
+ optional bool adminonly = 2;
61
+ }
62
+
63
+ message Preview {
64
+ optional uint64 previewid = 1;
65
+ optional uint32 sortorder = 2;
66
+ optional string url = 3;
67
+ optional uint32 size = 4;
68
+ optional string filename = 5;
69
+ optional string youtubevideoid = 6;
70
+ }
71
+
72
+ message Child {
73
+ optional uint64 publishedfileid = 1;
74
+ optional uint32 sortorder = 2;
75
+ optional uint32 file_type = 3;
76
+ }
77
+
78
+ message KVTag {
79
+ optional string key = 1;
80
+ optional string value = 2;
81
+ }
82
+
83
+ message VoteData {
84
+ optional float score = 1;
85
+ optional uint32 votes_up = 2;
86
+ optional uint32 votes_down = 3;
87
+ }
88
+
89
+ optional uint32 result = 1;
90
+ optional uint64 publishedfileid = 2;
91
+ optional fixed64 creator = 3;
92
+ optional uint32 creator_appid = 4;
93
+ optional uint32 consumer_appid = 5;
94
+ optional uint32 consumer_shortcutid = 6;
95
+ optional string filename = 7;
96
+ optional uint64 file_size = 8;
97
+ optional uint64 preview_file_size = 9;
98
+ optional string file_url = 10;
99
+ optional string preview_url = 11;
100
+ optional string youtubevideoid = 12;
101
+ optional string url = 13;
102
+ optional fixed64 hcontent_file = 14;
103
+ optional fixed64 hcontent_preview = 15;
104
+ optional string title = 16;
105
+ optional string file_description = 17;
106
+ optional string short_description = 18;
107
+ optional uint32 time_created = 19;
108
+ optional uint32 time_updated = 20;
109
+ optional uint32 visibility = 21;
110
+ optional uint32 flags = 22;
111
+ optional bool workshop_file = 23;
112
+ optional bool workshop_accepted = 24;
113
+ optional bool show_subscribe_all = 25;
114
+ optional int32 num_comments_developer = 26;
115
+ optional int32 num_comments_public = 27;
116
+ optional bool banned = 28;
117
+ optional string ban_reason = 29;
118
+ optional fixed64 banner = 30;
119
+ optional bool can_be_deleted = 31;
120
+ optional bool incompatible = 32;
121
+ optional string app_name = 33;
122
+ optional uint32 file_type = 34;
123
+ optional bool can_subscribe = 35;
124
+ optional uint32 subscriptions = 36;
125
+ optional uint32 favorited = 37;
126
+ optional uint32 followers = 38;
127
+ optional uint32 lifetime_subscriptions = 39;
128
+ optional uint32 lifetime_favorited = 40;
129
+ optional uint32 lifetime_followers = 41;
130
+ optional uint32 views = 42;
131
+ optional uint32 image_width = 43;
132
+ optional uint32 image_height = 44;
133
+ optional string image_url = 45;
134
+ optional bool spoiler_tag = 46;
135
+ optional uint32 shortcutid = 47;
136
+ optional string shortcutname = 48;
137
+ optional uint32 num_children = 49;
138
+ optional uint32 num_reports = 50;
139
+ repeated .PublishedFileDetails.Preview previews = 51;
140
+ repeated .PublishedFileDetails.Tag tags = 52;
141
+ repeated .PublishedFileDetails.Child children = 53;
142
+ repeated .PublishedFileDetails.KVTag kvtags = 54;
143
+ optional .PublishedFileDetails.VoteData vote_data = 55;
144
+ optional uint32 time_subscribed = 56 [(description) = "Only valid in PublishedFile.GetUserFiles and not normal PublishedFile.GetDetail calls"];
145
+ }
146
+
147
+ message CPublishedFile_GetDetails_Response {
148
+ repeated .PublishedFileDetails publishedfiledetails = 1;
149
+ }
150
+
151
+ message CPublishedFile_GetUserFiles_Request {
152
+ optional uint32 appid = 1 [(description) = "App Id to retrieve published files from."];
153
+ optional uint32 page = 3 [default = 1, (description) = "(Optional) Starting page for results."];
154
+ optional uint32 numperpage = 4 [default = 1, (description) = "(Optional) The number of results, per page to return."];
155
+ optional string sortmethod = 6 [default = "lastupdated", (description) = "(Optional) Sorting method to use on returned values."];
156
+ optional bool totalonly = 7 [(description) = "(Optional) If true, only return the total number of files that satisfy this query."];
157
+ optional uint32 privacy = 9 [(description) = "(optional) Filter by privacy settings."];
158
+ optional bool ids_only = 10 [(description) = "(Optional) If true, only return the published file ids of files that satisfy this query."];
159
+ repeated string requiredtags = 11 [(description) = "(Optional) Tags that must be present on a published file to satisfy the query."];
160
+ repeated string excludedtags = 12 [(description) = "(Optional) Tags that must NOT be present on a published file to satisfy the query."];
161
+ }
162
+
163
+ message CPublishedFile_GetUserFiles_Response {
164
+ message App {
165
+ optional uint32 appid = 1;
166
+ optional string name = 2;
167
+ optional uint32 shortcutid = 3;
168
+ optional bool private = 4;
169
+ }
170
+
171
+ optional uint32 total = 1;
172
+ optional uint32 startindex = 2;
173
+ repeated .PublishedFileDetails publishedfiledetails = 3;
174
+ repeated .CPublishedFile_GetUserFiles_Response.App apps = 4;
175
+ }
176
+
177
+ message CPublishedFile_Update_Request {
178
+ optional uint32 appid = 1 [(description) = "App Id this published file belongs to."];
179
+ optional fixed64 publishedfileid = 2 [(description) = "Published file id of the file we'd like update."];
180
+ optional string title = 3 [(description) = "(Optional) Title of the published file."];
181
+ optional string file_description = 4 [(description) = "(Optional) Description of the published file."];
182
+ optional uint32 visibility = 5 [(description) = "(Optional) Visibility of the published file."];
183
+ repeated string tags = 6 [(description) = "(Optional) Set of tags for the published file."];
184
+ optional string filename = 7 [(description) = "(Optional) Filename for the published file."];
185
+ optional string preview_filename = 8 [(description) = "(Optional) Preview filename for the published file."];
186
+ }
187
+
188
+ message CPublishedFile_Update_Response {
189
+ }
190
+
191
+ message CPublishedFile_RefreshVotingQueue_Request {
192
+ optional uint32 appid = 1;
193
+ optional uint32 matching_file_type = 2 [(description) = "EPublishedFileInfoMatchingFileType"];
194
+ repeated string tags = 3 [(description) = "Include files that have all the tags or any of the tags if match_all_tags is set to false."];
195
+ optional bool match_all_tags = 4 [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."];
196
+ repeated string excluded_tags = 5 [(description) = "Exclude any files that have any of these tags."];
197
+ optional uint32 desired_queue_size = 6 [(description) = "Desired number of items in the voting queue. May be clamped by the server"];
198
+ }
199
+
200
+ message CPublishedFile_RefreshVotingQueue_Response {
201
+ }
202
+
203
+ service PublishedFile {
204
+ option (service_description) = "A service to access published file data";
205
+
206
+ rpc Subscribe (.CPublishedFile_Subscribe_Request) returns (.CPublishedFile_Subscribe_Response) {
207
+ option (method_description) = "Subscribes the user to the published file";
208
+ }
209
+
210
+ rpc Unsubscribe (.CPublishedFile_Unsubscribe_Request) returns (.CPublishedFile_Unsubscribe_Response) {
211
+ option (method_description) = "Unsubscribes the user from the published file";
212
+ }
213
+
214
+ rpc Publish (.CPublishedFile_Publish_Request) returns (.CPublishedFile_Publish_Response) {
215
+ option (method_description) = "Publishes a clouded user file to the Workshop.";
216
+ }
217
+
218
+ rpc GetDetails (.CPublishedFile_GetDetails_Request) returns (.CPublishedFile_GetDetails_Response) {
219
+ option (method_description) = "Retrieves information about a set of published files.";
220
+ }
221
+
222
+ rpc GetUserFiles (.CPublishedFile_GetUserFiles_Request) returns (.CPublishedFile_GetUserFiles_Response) {
223
+ option (method_description) = "Retrieves files published by a user.";
224
+ }
225
+
226
+ rpc Update (.CPublishedFile_Update_Request) returns (.CPublishedFile_Update_Response) {
227
+ option (method_description) = "Updates information about a published file.";
228
+ }
229
+
230
+ rpc RefreshVotingQueue (.CPublishedFile_RefreshVotingQueue_Request) returns (.CPublishedFile_RefreshVotingQueue_Response) {
231
+ option (method_description) = "Refresh the voting queue for the user";
232
+ }
233
+ }
@@ -1,4 +1,4 @@
1
- import "google/protobuf/descriptor.proto";
1
+
2
2
 
3
3
  option optimize_for = SPEED;
4
4
  option cc_generic_services = false;