steamutils 1.2.83 → 1.2.84
Sign up to get free protection for your applications and to get access to all the features.
- package/.idea/codeStyles/codeStyleConfig.xml +5 -0
- package/.idea/steamutils.iml +1 -1
- package/.idea/vcs.xml +1 -1
- package/SteamClient.js +2 -0
- package/free_packages.json +10048 -10048
- package/package.json +1 -1
- package/protos/csgo/base_gcmessages_csgo.proto +547 -547
- package/protos/csgo/c_peer2peer_netmessages.proto +55 -55
- package/protos/csgo/clientmessages.proto +48 -48
- package/protos/csgo/connectionless_netmessages.proto +19 -19
- package/protos/csgo/cs_gameevents.proto +34 -34
- package/protos/csgo/cs_usercmd.proto +34 -34
- package/protos/csgo/cstrike15_gcmessages.proto +1402 -1402
- package/protos/csgo/cstrike15_usermessages.proto +596 -596
- package/protos/csgo/demo.proto +160 -160
- package/protos/csgo/econ_gcmessages.proto +228 -228
- package/protos/csgo/engine_gcmessages.proto +14 -14
- package/protos/csgo/enums_clientserver.proto +1529 -1529
- package/protos/csgo/fatdemo.proto +125 -125
- package/protos/csgo/gameevents.proto +120 -120
- package/protos/csgo/gcsdk_gcmessages.proto +323 -323
- package/protos/csgo/gcsystemmsgs.proto +242 -242
- package/protos/csgo/netmessages.proto +604 -604
- package/protos/csgo/network_connection.proto +126 -126
- package/protos/csgo/networkbasetypes.proto +244 -244
- package/protos/csgo/networksystem_protomessages.proto +17 -17
- package/protos/csgo/steamdatagram_messages_auth.proto +65 -65
- package/protos/csgo/steamdatagram_messages_sdr.proto +534 -534
- package/protos/csgo/steammessages.proto +597 -597
- package/protos/csgo/steammessages_base.proto +301 -301
- package/protos/csgo/steammessages_cloud.steamworkssdk.proto +68 -68
- package/protos/csgo/steammessages_gamenetworkingui.proto +61 -61
- package/protos/csgo/steammessages_helprequest.steamworkssdk.proto +22 -22
- package/protos/csgo/steammessages_oauth.steamworkssdk.proto +18 -18
- package/protos/csgo/steammessages_player.steamworkssdk.proto +254 -254
- package/protos/csgo/steammessages_publishedfile.steamworkssdk.proto +233 -233
- package/protos/csgo/steammessages_steamlearn.steamworkssdk.proto +357 -357
- package/protos/csgo/steammessages_unified_base.steamworkssdk.proto +30 -30
- package/protos/csgo/steamnetworkingsockets_messages.proto +205 -205
- package/protos/csgo/steamnetworkingsockets_messages_certs.proto +39 -39
- package/protos/csgo/steamnetworkingsockets_messages_udp.proto +75 -75
- package/protos/csgo/te.proto +259 -259
- package/protos/csgo/uifontfile_format.proto +13 -13
- package/protos/csgo/usercmd.proto +38 -38
- package/protos/csgo/usermessages.proto +721 -721
- package/protos/csgo/valveextensions.proto +17 -17
- package/protos/google/protobuf/descriptor.proto +281 -281
- package/protos/steam/clientmetrics.proto +45 -45
- package/protos/steam/content_manifest.proto +62 -62
- package/protos/steam/contenthubs.proto +41 -41
- package/protos/steam/encrypted_app_ticket.proto +10 -10
- package/protos/steam/enums.proto +444 -444
- package/protos/steam/enums_clientserver.proto +1539 -1539
- package/protos/steam/enums_productinfo.proto +13 -13
- package/protos/steam/htmlmessages.proto +1027 -1027
- package/protos/steam/offline_ticket.proto +8 -8
- package/protos/steam/renderer/rendermessages.proto +893 -893
- package/protos/steam/steamdatagram_messages_auth.proto +65 -65
- package/protos/steam/steamdatagram_messages_sdr.proto +533 -533
- package/protos/steam/steammessages_accounthardware.steamclient.proto +201 -201
- package/protos/steam/steammessages_appoverview.proto +187 -187
- package/protos/steam/steammessages_auth.steamclient.proto +435 -435
- package/protos/steam/steammessages_base.proto +332 -332
- package/protos/steam/steammessages_broadcast.steamclient.proto +759 -759
- package/protos/steam/steammessages_chat.steamclient.proto +1281 -1281
- package/protos/steam/steammessages_client_objects.proto +645 -645
- package/protos/steam/steammessages_clientlanp2p.proto +42 -42
- package/protos/steam/steammessages_clientmetrics.steamclient.proto +194 -194
- package/protos/steam/steammessages_clientnotificationtypes.proto +231 -231
- package/protos/steam/steammessages_clientserver.proto +392 -392
- package/protos/steam/steammessages_clientserver_2.proto +760 -760
- package/protos/steam/steammessages_clientserver_appinfo.proto +131 -131
- package/protos/steam/steammessages_clientserver_friends.proto +260 -260
- package/protos/steam/steammessages_clientserver_gameservers.proto +159 -159
- package/protos/steam/steammessages_clientserver_lbs.proto +70 -70
- package/protos/steam/steammessages_clientserver_login.proto +167 -167
- package/protos/steam/steammessages_clientserver_ucm.proto +205 -205
- package/protos/steam/steammessages_clientserver_uds.proto +124 -124
- package/protos/steam/steammessages_clientserver_ufs.proto +172 -172
- package/protos/steam/steammessages_clientserver_userstats.proto +80 -80
- package/protos/steam/steammessages_clientsettings.proto +168 -168
- package/protos/steam/steammessages_cloud.steamclient.proto +513 -513
- package/protos/steam/steammessages_contentsystem.steamclient.proto +115 -115
- package/protos/steam/steammessages_credentials.steamclient.proto +115 -115
- package/protos/steam/steammessages_datapublisher.steamclient.proto +116 -116
- package/protos/steam/steammessages_depotbuilder.steamclient.proto +118 -118
- package/protos/steam/steammessages_deviceauth.steamclient.proto +203 -203
- package/protos/steam/steammessages_econ.steamclient.proto +150 -150
- package/protos/steam/steammessages_friendmessages.steamclient.proto +168 -168
- package/protos/steam/steammessages_gamenetworking.steamclient.proto +32 -32
- package/protos/steam/steammessages_gamenetworkingui.proto +61 -61
- package/protos/steam/steammessages_gamenotifications.steamclient.proto +156 -156
- package/protos/steam/steammessages_gameservers.steamclient.proto +152 -152
- package/protos/steam/steammessages_hiddevices.proto +157 -157
- package/protos/steam/steammessages_inventory.steamclient.proto +224 -224
- package/protos/steam/steammessages_linkfilter.steamclient.proto +49 -49
- package/protos/steam/steammessages_lobbymatchmaking.steamclient.proto +33 -33
- package/protos/steam/steammessages_market.steamclient.proto +26 -26
- package/protos/steam/steammessages_marketingmessages.steamclient.proto +274 -274
- package/protos/steam/steammessages_offline.steamclient.proto +40 -40
- package/protos/steam/steammessages_parental.steamclient.proto +228 -228
- package/protos/steam/steammessages_parties.steamclient.proto +94 -94
- package/protos/steam/steammessages_partnerapps.steamclient.proto +138 -138
- package/protos/steam/steammessages_player.steamclient.proto +1060 -1060
- package/protos/steam/steammessages_publishedfile.steamclient.proto +813 -813
- package/protos/steam/steammessages_qms.steamclient.proto +125 -125
- package/protos/steam/steammessages_remoteclient.proto +99 -99
- package/protos/steam/steammessages_remoteclient_discovery.proto +235 -235
- package/protos/steam/steammessages_remoteclient_service.steamclient.proto +86 -86
- package/protos/steam/steammessages_remoteclient_service_messages.proto +217 -217
- package/protos/steam/steammessages_remoteplay.proto +976 -976
- package/protos/steam/steammessages_secrets.steamclient.proto +39 -39
- package/protos/steam/steammessages_shader.steamclient.proto +108 -108
- package/protos/steam/steammessages_site_license.steamclient.proto +128 -128
- package/protos/steam/steammessages_sitelicenseclient.proto +38 -38
- package/protos/steam/steammessages_siteserverui.proto +130 -130
- package/protos/steam/steammessages_star.steamclient.proto +64 -64
- package/protos/steam/steammessages_steamtv.steamclient.proto +630 -630
- package/protos/steam/steammessages_store.steamclient.proto +371 -371
- package/protos/steam/steammessages_storebrowse.steamclient.proto +402 -402
- package/protos/steam/steammessages_timedtrial.steamclient.proto +50 -50
- package/protos/steam/steammessages_twofactor.steamclient.proto +186 -186
- package/protos/steam/steammessages_unified_base.steamclient.proto +33 -33
- package/protos/steam/steammessages_unified_test.steamclient.proto +61 -61
- package/protos/steam/steammessages_useraccount.steamclient.proto +249 -249
- package/protos/steam/steammessages_vac.steamclient.proto +44 -44
- package/protos/steam/steammessages_video.steamclient.proto +171 -171
- package/protos/steam/steammessages_virtualcontroller.proto +138 -138
- package/protos/steam/steammessages_workshop.steamclient.proto +23 -23
- package/protos/steam/steamnetworkingsockets_messages.proto +205 -205
- package/protos/steam/steamnetworkingsockets_messages_certs.proto +39 -39
- package/protos/steam/steamnetworkingsockets_messages_udp.proto +75 -75
- package/protos/steam/webuimessages_base.proto +24 -24
- package/protos/steam/webuimessages_gamenotes.proto +21 -21
- package/protos/steam/webuimessages_steamengine.proto +32 -32
- package/protos/steam/webuimessages_storagedevicemanager.proto +110 -110
- package/protos/steam/webuimessages_systemmanager.proto +17 -17
- package/protos/steam/webuimessages_transport.proto +18 -18
- package/protos/steam/webuimessages_transportvalidation.proto +97 -97
- package/protos/webui/common.proto +5508 -5508
- package/protos/webui/common_base.proto +27 -27
- package/protos/webui/service_accountlinking.proto +27 -27
- package/protos/webui/service_accountprivacy.proto +42 -42
- package/protos/webui/service_auction.proto +97 -97
- package/protos/webui/service_authentication.proto +222 -222
- package/protos/webui/service_authenticationsupport.proto +74 -74
- package/protos/webui/service_broadcast.proto +562 -562
- package/protos/webui/service_chat.proto +11 -11
- package/protos/webui/service_chatroom.proto +810 -810
- package/protos/webui/service_chatusability.proto +107 -107
- package/protos/webui/service_clan.proto +41 -41
- package/protos/webui/service_clanchatrooms.proto +25 -25
- package/protos/webui/service_clanfaqs.proto +202 -202
- package/protos/webui/service_clientcomm.proto +150 -150
- package/protos/webui/service_clientmetrics.proto +63 -63
- package/protos/webui/service_cloud.proto +222 -222
- package/protos/webui/service_cloudconfigstore.proto +51 -51
- package/protos/webui/service_cloudgaming.proto +30 -30
- package/protos/webui/service_community.proto +365 -365
- package/protos/webui/service_econ.proto +134 -134
- package/protos/webui/service_embedded.proto +24 -24
- package/protos/webui/service_experimentservice.proto +6 -6
- package/protos/webui/service_fovasvideo.proto +15 -15
- package/protos/webui/service_friendmessages.proto +133 -133
- package/protos/webui/service_friendslist.proto +70 -70
- package/protos/webui/service_gamenotes.proto +15 -15
- package/protos/webui/service_helprequestlogs.proto +26 -26
- package/protos/webui/service_loyaltyrewards.proto +252 -252
- package/protos/webui/service_marketingmessages.proto +184 -184
- package/protos/webui/service_mobileapp.proto +18 -18
- package/protos/webui/service_mobileauth.proto +24 -24
- package/protos/webui/service_mobiledevice.proto +26 -26
- package/protos/webui/service_mobileperaccount.proto +31 -31
- package/protos/webui/service_news.proto +101 -101
- package/protos/webui/service_parental.proto +178 -178
- package/protos/webui/service_partnermembershipinvite.proto +29 -29
- package/protos/webui/service_partnerstorebrowse.proto +6 -6
- package/protos/webui/service_phone.proto +51 -51
- package/protos/webui/service_physicalgoods.proto +15 -15
- package/protos/webui/service_player.proto +885 -885
- package/protos/webui/service_promotioneventinvites.proto +50 -50
- package/protos/webui/service_promotionplanning.proto +72 -72
- package/protos/webui/service_publishedfile.proto +687 -687
- package/protos/webui/service_publishing.proto +119 -119
- package/protos/webui/service_quest.proto +127 -127
- package/protos/webui/service_salefeature.proto +315 -315
- package/protos/webui/service_saleitemrewards.proto +54 -54
- package/protos/webui/service_shoppingcart.proto +108 -108
- package/protos/webui/service_steamawards.proto +19 -19
- package/protos/webui/service_steamcharts.proto +75 -75
- package/protos/webui/service_steamengine.proto +36 -36
- package/protos/webui/service_steamlearn.proto +727 -727
- package/protos/webui/service_steamnotification.proto +84 -84
- package/protos/webui/service_steamtv.proto +495 -495
- package/protos/webui/service_steamvrvoicechat.proto +67 -67
- package/protos/webui/service_steamvrwebrtc.proto +48 -48
- package/protos/webui/service_storagedevicemanager.proto +104 -104
- package/protos/webui/service_store.proto +289 -289
- package/protos/webui/service_storeappsimilarity.proto +76 -76
- package/protos/webui/service_storebrowse.proto +73 -73
- package/protos/webui/service_storequery.proto +97 -97
- package/protos/webui/service_storesales.proto +15 -15
- package/protos/webui/service_storetopsellers.proto +44 -44
- package/protos/webui/service_systemmanager.proto +11 -11
- package/protos/webui/service_test_transporterror.proto +6 -6
- package/protos/webui/service_transportauth.proto +12 -12
- package/protos/webui/service_transportvalidation.proto +69 -69
- package/protos/webui/service_twofactor.proto +181 -181
- package/protos/webui/service_useraccount.proto +138 -138
- package/protos/webui/service_usergameactivity.proto +34 -34
- package/protos/webui/service_usergamenotes.proto +53 -53
- package/protos/webui/service_usernews.proto +68 -68
- package/protos/webui/service_userreviews.proto +96 -96
- package/protos/webui/service_video.proto +128 -128
- package/protos/webui/service_voicechat.proto +139 -139
- package/protos/webui/service_webrtc.proto +52 -52
- package/.idea/deployment.xml +0 -21
@@ -1,813 +1,813 @@
|
|
1
|
-
import "steammessages_base.proto";
|
2
|
-
import "steammessages_unified_base.steamclient.proto";
|
3
|
-
import "enums_productinfo.proto";
|
4
|
-
|
5
|
-
option cc_generic_services = true;
|
6
|
-
|
7
|
-
enum EPublishedFileRevision {
|
8
|
-
k_EPublishedFileRevision_Default = 0;
|
9
|
-
k_EPublishedFileRevision_Latest = 1;
|
10
|
-
k_EPublishedFileRevision_ApprovedSnapshot = 2;
|
11
|
-
k_EPublishedFileRevision_ApprovedSnapshot_China = 3;
|
12
|
-
k_EPublishedFileRevision_RejectedSnapshot = 4;
|
13
|
-
k_EPublishedFileRevision_RejectedSnapshot_China = 5;
|
14
|
-
}
|
15
|
-
|
16
|
-
enum EPublishedFileForSaleStatus {
|
17
|
-
k_PFFSS_NotForSale = 0;
|
18
|
-
k_PFFSS_PendingApproval = 1;
|
19
|
-
k_PFFSS_ApprovedForSale = 2;
|
20
|
-
k_PFFSS_RejectedForSale = 3;
|
21
|
-
k_PFFSS_NoLongerForSale = 4;
|
22
|
-
k_PFFSS_TentativeApproval = 5;
|
23
|
-
}
|
24
|
-
|
25
|
-
message CPublishedFile_Vote_Request {
|
26
|
-
optional uint64 publishedfileid = 1;
|
27
|
-
optional bool vote_up = 2;
|
28
|
-
}
|
29
|
-
|
30
|
-
message CPublishedFile_Vote_Response {
|
31
|
-
}
|
32
|
-
|
33
|
-
message CPublishedFile_Subscribe_Request {
|
34
|
-
optional uint64 publishedfileid = 1;
|
35
|
-
optional uint32 list_type = 2;
|
36
|
-
optional int32 appid = 3;
|
37
|
-
optional bool notify_client = 4;
|
38
|
-
}
|
39
|
-
|
40
|
-
message CPublishedFile_Subscribe_Response {
|
41
|
-
}
|
42
|
-
|
43
|
-
message CPublishedFile_Unsubscribe_Request {
|
44
|
-
optional uint64 publishedfileid = 1;
|
45
|
-
optional uint32 list_type = 2;
|
46
|
-
optional int32 appid = 3;
|
47
|
-
optional bool notify_client = 4;
|
48
|
-
}
|
49
|
-
|
50
|
-
message CPublishedFile_Unsubscribe_Response {
|
51
|
-
}
|
52
|
-
|
53
|
-
message CPublishedFile_CanSubscribe_Request {
|
54
|
-
optional uint64 publishedfileid = 1;
|
55
|
-
}
|
56
|
-
|
57
|
-
message CPublishedFile_CanSubscribe_Response {
|
58
|
-
optional bool can_subscribe = 1;
|
59
|
-
}
|
60
|
-
|
61
|
-
message CPublishedFile_GetSubSectionData_Request {
|
62
|
-
optional uint64 publishedfileid = 1;
|
63
|
-
optional bool for_table_of_contents = 2;
|
64
|
-
optional uint64 specific_sectionid = 3;
|
65
|
-
optional .EPublishedFileRevision desired_revision = 4 [default = k_EPublishedFileRevision_Default, (description) = "Return the data for the specified revision."];
|
66
|
-
}
|
67
|
-
|
68
|
-
message PublishedFileSubSection {
|
69
|
-
optional uint64 sectionid = 1;
|
70
|
-
optional string title = 2;
|
71
|
-
optional string description_text = 3;
|
72
|
-
optional uint32 sort_order = 4;
|
73
|
-
}
|
74
|
-
|
75
|
-
message CPublishedFile_GetSubSectionData_Response {
|
76
|
-
repeated .PublishedFileSubSection sub_sections = 1;
|
77
|
-
}
|
78
|
-
|
79
|
-
message CPublishedFile_Publish_Request {
|
80
|
-
optional uint32 appid = 1 [(description) = "App Id this file is being published FROM."];
|
81
|
-
optional uint32 consumer_appid = 2 [(description) = "App Id this file is being published TO."];
|
82
|
-
optional string cloudfilename = 3 [(description) = "Name of the file to publish in the user's cloud."];
|
83
|
-
optional string preview_cloudfilename = 4 [(description) = "Name of the file to use as the published file's preview."];
|
84
|
-
optional string title = 5 [(description) = "Text title for the published file."];
|
85
|
-
optional string file_description = 6 [(description) = "Text description for the published file."];
|
86
|
-
optional uint32 file_type = 7 [(description) = "(EWorkshopFileType) Type of Workshop file to publish."];
|
87
|
-
optional string consumer_shortcut_name = 8 [(description) = "Shortcut name for the published file."];
|
88
|
-
optional string youtube_username = 9 [(description) = "(Optional) User's YouTube account username."];
|
89
|
-
optional string youtube_videoid = 10 [(description) = "(Optional) Video Id of a YouTube video for this published file."];
|
90
|
-
optional uint32 visibility = 11 [(description) = "(ERemoteStoragePublishedFileVisibility) Visibility of the published file (private, friends, public, etc.)"];
|
91
|
-
optional string redirect_uri = 12 [(description) = "(Optional) If supplied, the resulting published file's Id is appended to the URI."];
|
92
|
-
repeated string tags = 13 [(description) = "Array of text tags to apply to the published file."];
|
93
|
-
optional string collection_type = 14 [(description) = "(Optional) Type of collection the published file represents."];
|
94
|
-
optional string game_type = 15 [(description) = "(Optional) Type of game the published file represents."];
|
95
|
-
optional string url = 16 [(description) = "(Optional) If this represents a game, this is the URL to that game's page."];
|
96
|
-
}
|
97
|
-
|
98
|
-
message CPublishedFile_Publish_Response {
|
99
|
-
optional uint64 publishedfileid = 1;
|
100
|
-
optional string redirect_uri = 2;
|
101
|
-
}
|
102
|
-
|
103
|
-
message CPublishedFile_GetDetails_Request {
|
104
|
-
repeated fixed64 publishedfileids = 1 [(description) = "Set of published file Ids to retrieve details for."];
|
105
|
-
optional bool includetags = 2 [(description) = "If true, return tag information in the returned details."];
|
106
|
-
optional bool includeadditionalpreviews = 3 [(description) = "If true, return preview information in the returned details."];
|
107
|
-
optional bool includechildren = 4 [(description) = "If true, return children in the returned details."];
|
108
|
-
optional bool includekvtags = 5 [(description) = "If true, return key value tags in the returned details."];
|
109
|
-
optional bool includevotes = 6 [(description) = "If true, return vote data in the returned details."];
|
110
|
-
optional bool short_description = 8 [(description) = "If true, return a short description instead of the full description."];
|
111
|
-
optional bool includeforsaledata = 10 [(description) = "If true, return pricing data, if applicable."];
|
112
|
-
optional bool includemetadata = 11 [(description) = "If true, populate the metadata field."];
|
113
|
-
optional int32 language = 12 [default = 0, (description) = "Specifies the localized text to return. Defaults to English."];
|
114
|
-
optional uint32 return_playtime_stats = 13 [(description) = "Return playtime stats for the specified number of days before today."];
|
115
|
-
optional uint32 appid = 14;
|
116
|
-
optional bool strip_description_bbcode = 15 [(description) = "Strips BBCode from descriptions."];
|
117
|
-
optional .EPublishedFileRevision desired_revision = 16 [default = k_EPublishedFileRevision_Default, (description) = "Return the data for the specified revision."];
|
118
|
-
optional bool includereactions = 17 [default = false, (description) = "If true, then reactions to items will be returned."];
|
119
|
-
}
|
120
|
-
|
121
|
-
message PublishedFileDetails {
|
122
|
-
message Tag {
|
123
|
-
optional string tag = 1;
|
124
|
-
optional bool adminonly = 2;
|
125
|
-
optional string display_name = 3;
|
126
|
-
}
|
127
|
-
|
128
|
-
message Preview {
|
129
|
-
optional uint64 previewid = 1;
|
130
|
-
optional uint32 sortorder = 2;
|
131
|
-
optional string url = 3;
|
132
|
-
optional uint32 size = 4;
|
133
|
-
optional string filename = 5;
|
134
|
-
optional string youtubevideoid = 6;
|
135
|
-
optional uint32 preview_type = 7;
|
136
|
-
optional string external_reference = 8;
|
137
|
-
}
|
138
|
-
|
139
|
-
message Child {
|
140
|
-
optional uint64 publishedfileid = 1;
|
141
|
-
optional uint32 sortorder = 2;
|
142
|
-
optional uint32 file_type = 3;
|
143
|
-
}
|
144
|
-
|
145
|
-
message KVTag {
|
146
|
-
optional string key = 1;
|
147
|
-
optional string value = 2;
|
148
|
-
}
|
149
|
-
|
150
|
-
message VoteData {
|
151
|
-
optional float score = 1;
|
152
|
-
optional uint32 votes_up = 2;
|
153
|
-
optional uint32 votes_down = 3;
|
154
|
-
}
|
155
|
-
|
156
|
-
message ForSaleData {
|
157
|
-
optional bool is_for_sale = 1;
|
158
|
-
optional uint32 price_category = 2;
|
159
|
-
optional .EPublishedFileForSaleStatus estatus = 3 [default = k_PFFSS_NotForSale];
|
160
|
-
optional uint32 price_category_floor = 4;
|
161
|
-
optional bool price_is_pay_what_you_want = 5;
|
162
|
-
optional uint32 discount_percentage = 6;
|
163
|
-
}
|
164
|
-
|
165
|
-
message PlaytimeStats {
|
166
|
-
optional uint64 playtime_seconds = 1;
|
167
|
-
optional uint64 num_sessions = 2;
|
168
|
-
}
|
169
|
-
|
170
|
-
message Reaction {
|
171
|
-
optional uint32 reactionid = 1;
|
172
|
-
optional uint32 count = 2;
|
173
|
-
}
|
174
|
-
|
175
|
-
optional uint32 result = 1;
|
176
|
-
optional uint64 publishedfileid = 2;
|
177
|
-
optional fixed64 creator = 3;
|
178
|
-
optional uint32 creator_appid = 4;
|
179
|
-
optional uint32 consumer_appid = 5;
|
180
|
-
optional uint32 consumer_shortcutid = 6;
|
181
|
-
optional string filename = 7;
|
182
|
-
optional uint64 file_size = 8;
|
183
|
-
optional uint64 preview_file_size = 9;
|
184
|
-
optional string file_url = 10;
|
185
|
-
optional string preview_url = 11;
|
186
|
-
optional string youtubevideoid = 12;
|
187
|
-
optional string url = 13;
|
188
|
-
optional fixed64 hcontent_file = 14;
|
189
|
-
optional fixed64 hcontent_preview = 15;
|
190
|
-
optional string title = 16;
|
191
|
-
optional string file_description = 17;
|
192
|
-
optional string short_description = 18;
|
193
|
-
optional uint32 time_created = 19;
|
194
|
-
optional uint32 time_updated = 20;
|
195
|
-
optional uint32 visibility = 21;
|
196
|
-
optional uint32 flags = 22;
|
197
|
-
optional bool workshop_file = 23;
|
198
|
-
optional bool workshop_accepted = 24;
|
199
|
-
optional bool show_subscribe_all = 25;
|
200
|
-
optional int32 num_comments_developer = 26;
|
201
|
-
optional int32 num_comments_public = 27;
|
202
|
-
optional bool banned = 28;
|
203
|
-
optional string ban_reason = 29;
|
204
|
-
optional fixed64 banner = 30;
|
205
|
-
optional bool can_be_deleted = 31;
|
206
|
-
optional bool incompatible = 32;
|
207
|
-
optional string app_name = 33;
|
208
|
-
optional uint32 file_type = 34;
|
209
|
-
optional bool can_subscribe = 35;
|
210
|
-
optional uint32 subscriptions = 36;
|
211
|
-
optional uint32 favorited = 37;
|
212
|
-
optional uint32 followers = 38;
|
213
|
-
optional uint32 lifetime_subscriptions = 39;
|
214
|
-
optional uint32 lifetime_favorited = 40;
|
215
|
-
optional uint32 lifetime_followers = 41;
|
216
|
-
optional uint64 lifetime_playtime = 62;
|
217
|
-
optional uint64 lifetime_playtime_sessions = 63;
|
218
|
-
optional uint32 views = 42;
|
219
|
-
optional uint32 image_width = 43;
|
220
|
-
optional uint32 image_height = 44;
|
221
|
-
optional string image_url = 45;
|
222
|
-
optional bool spoiler_tag = 46;
|
223
|
-
optional uint32 shortcutid = 47;
|
224
|
-
optional string shortcutname = 48;
|
225
|
-
optional uint32 num_children = 49;
|
226
|
-
optional uint32 num_reports = 50;
|
227
|
-
repeated .PublishedFileDetails.Preview previews = 51;
|
228
|
-
repeated .PublishedFileDetails.Tag tags = 52;
|
229
|
-
repeated .PublishedFileDetails.Child children = 53;
|
230
|
-
repeated .PublishedFileDetails.KVTag kvtags = 54;
|
231
|
-
optional .PublishedFileDetails.VoteData vote_data = 55;
|
232
|
-
optional .PublishedFileDetails.PlaytimeStats playtime_stats = 64;
|
233
|
-
optional uint32 time_subscribed = 56 [(description) = "Only valid in PublishedFile.GetUserFiles and not normal PublishedFile.GetDetail calls"];
|
234
|
-
optional .PublishedFileDetails.ForSaleData for_sale_data = 57 [(description) = "Pricing information, if applicable."];
|
235
|
-
optional string metadata = 58 [(description) = "Metadata associated with the item"];
|
236
|
-
optional int32 language = 61 [default = 0, (description) = "The language of the title and description."];
|
237
|
-
optional bool maybe_inappropriate_sex = 65;
|
238
|
-
optional bool maybe_inappropriate_violence = 66;
|
239
|
-
repeated .EContentDescriptorID content_descriptorids = 72;
|
240
|
-
optional uint64 revision_change_number = 67 [(description) = "The change number for the specified revision."];
|
241
|
-
optional .EPublishedFileRevision revision = 68 [default = k_EPublishedFileRevision_Default, (description) = "The revision of the data returned, usually k_EPublishedFileRevision_Latest, but can be another revision/snapshot depending on the caller."];
|
242
|
-
repeated .EPublishedFileRevision available_revisions = 69 [(description) = "Available revisions"];
|
243
|
-
repeated .PublishedFileDetails.Reaction reactions = 70 [(description) = "Reactions to this item"];
|
244
|
-
optional .EBanContentCheckResult ban_text_check_result = 71 [default = k_EBanContentCheckResult_NotScanned];
|
245
|
-
optional float search_score = 73 [(description) = "Search score, admin only"];
|
246
|
-
}
|
247
|
-
|
248
|
-
message CPublishedFile_GetDetails_Response {
|
249
|
-
repeated .PublishedFileDetails publishedfiledetails = 1;
|
250
|
-
}
|
251
|
-
|
252
|
-
message CPublishedFile_GetItemInfo_Request {
|
253
|
-
message WorkshopItem {
|
254
|
-
optional fixed64 published_file_id = 1;
|
255
|
-
optional uint32 time_updated = 2;
|
256
|
-
optional .EPublishedFileRevision desired_revision = 3 [default = k_EPublishedFileRevision_Default, (description) = "Return the data for the specified revision."];
|
257
|
-
}
|
258
|
-
|
259
|
-
optional uint32 appid = 1;
|
260
|
-
optional uint32 last_time_updated = 2;
|
261
|
-
repeated .CPublishedFile_GetItemInfo_Request.WorkshopItem workshop_items = 3;
|
262
|
-
}
|
263
|
-
|
264
|
-
message CPublishedFile_GetItemInfo_Response {
|
265
|
-
message WorkshopItemInfo {
|
266
|
-
optional fixed64 published_file_id = 1;
|
267
|
-
optional uint32 time_updated = 2;
|
268
|
-
optional fixed64 manifest_id = 3;
|
269
|
-
optional uint32 flags = 4;
|
270
|
-
}
|
271
|
-
|
272
|
-
optional uint32 update_time = 1;
|
273
|
-
repeated .CPublishedFile_GetItemInfo_Response.WorkshopItemInfo workshop_items = 2;
|
274
|
-
repeated fixed64 private_items = 3;
|
275
|
-
}
|
276
|
-
|
277
|
-
message CPublishedFile_GetUserFiles_Request {
|
278
|
-
message KVTag {
|
279
|
-
optional string key = 1;
|
280
|
-
optional string value = 2;
|
281
|
-
}
|
282
|
-
|
283
|
-
message TagGroup {
|
284
|
-
repeated string tags = 1;
|
285
|
-
}
|
286
|
-
|
287
|
-
optional fixed64 steamid = 1 [(description) = "Steam ID of the user whose files are being requested."];
|
288
|
-
optional uint32 appid = 2 [(description) = "App Id of the app that the files were published to."];
|
289
|
-
optional uint32 shortcutid = 3 [(description) = "(Optional) Shortcut Id to retrieve published files from."];
|
290
|
-
optional uint32 page = 4 [default = 1, (description) = "(Optional) Starting page for results."];
|
291
|
-
optional uint32 numperpage = 5 [default = 1, (description) = "(Optional) The number of results, per page to return."];
|
292
|
-
optional string type = 6 [default = "myfiles", (description) = "(Optional) Type of files to be returned."];
|
293
|
-
optional string sortmethod = 7 [default = "lastupdated", (description) = "(Optional) Sorting method to use on returned values."];
|
294
|
-
optional uint32 privacy = 9 [(description) = "(optional) Filter by privacy settings."];
|
295
|
-
repeated string requiredtags = 10 [(description) = "(Optional) Tags that must be present on a published file to satisfy the query."];
|
296
|
-
repeated string excludedtags = 11 [(description) = "(Optional) Tags that must NOT be present on a published file to satisfy the query."];
|
297
|
-
repeated .CPublishedFile_GetUserFiles_Request.KVTag required_kv_tags = 30 [(description) = "Required key-value tags to match on."];
|
298
|
-
optional uint32 filetype = 14 [(description) = "(Optional) File type to match files to."];
|
299
|
-
optional uint32 creator_appid = 15 [(description) = "App Id of the app that published the files, only matched if specified."];
|
300
|
-
optional string match_cloud_filename = 16 [(description) = "Match this cloud filename if specified."];
|
301
|
-
optional uint32 cache_max_age_seconds = 27 [default = 0, (description) = "Allow stale data to be returned for the specified number of seconds."];
|
302
|
-
optional int32 language = 29 [default = 0, (description) = "Specifies the localized text to return. Defaults to English."];
|
303
|
-
repeated .CPublishedFile_GetUserFiles_Request.TagGroup taggroups = 34 [(description) = "(Optional) At least one of the tags must be present on a published file to satisfy the query."];
|
304
|
-
repeated .EContentDescriptorID excluded_content_descriptors = 37 [(description) = "(Optional) Filter out items that have these content descriptors."];
|
305
|
-
optional bool totalonly = 17 [(description) = "(Optional) If true, only return the total number of files that satisfy this query."];
|
306
|
-
optional bool ids_only = 18 [(description) = "(Optional) If true, only return the published file ids of files that satisfy this query."];
|
307
|
-
optional bool return_vote_data = 19 [default = true, (description) = "Return vote data"];
|
308
|
-
optional bool return_tags = 20 [(description) = "Return tags in the file details"];
|
309
|
-
optional bool return_kv_tags = 21 [default = true, (description) = "Return key-value tags in the file details"];
|
310
|
-
optional bool return_previews = 22 [(description) = "Return preview image and video details in the file details"];
|
311
|
-
optional bool return_children = 23 [(description) = "Return child item ids in the file details"];
|
312
|
-
optional bool return_short_description = 24 [default = true, (description) = "Populate the short_description field instead of file_description"];
|
313
|
-
optional bool return_for_sale_data = 26 [(description) = "Return pricing information, if applicable"];
|
314
|
-
optional bool return_metadata = 28 [default = false, (description) = "Populate the metadata field"];
|
315
|
-
optional uint32 return_playtime_stats = 31 [(description) = "Return playtime stats for the specified number of days before today."];
|
316
|
-
optional bool strip_description_bbcode = 32 [(description) = "Strips BBCode from descriptions."];
|
317
|
-
optional bool return_reactions = 35 [default = false, (description) = "If true, then reactions to items will be returned."];
|
318
|
-
optional uint32 startindex_override = 25 [(description) = "Backwards compatible for the client."];
|
319
|
-
optional .EPublishedFileRevision desired_revision = 33 [default = k_EPublishedFileRevision_Default, (description) = "Return the data for the specified revision."];
|
320
|
-
optional bool return_apps = 36 [(description) = "Return list of apps the items belong to"];
|
321
|
-
}
|
322
|
-
|
323
|
-
message CPublishedFile_GetUserFiles_Response {
|
324
|
-
message App {
|
325
|
-
optional uint32 appid = 1;
|
326
|
-
optional string name = 2;
|
327
|
-
optional uint32 shortcutid = 3;
|
328
|
-
optional bool private = 4;
|
329
|
-
}
|
330
|
-
|
331
|
-
optional uint32 total = 1;
|
332
|
-
optional uint32 startindex = 2;
|
333
|
-
repeated .PublishedFileDetails publishedfiledetails = 3;
|
334
|
-
repeated .CPublishedFile_GetUserFiles_Response.App apps = 4;
|
335
|
-
}
|
336
|
-
|
337
|
-
message CPublishedFile_AreFilesInSubscriptionList_Request {
|
338
|
-
optional uint32 appid = 1;
|
339
|
-
repeated fixed64 publishedfileids = 2;
|
340
|
-
optional uint32 listtype = 3 [(description) = "See EUCMListType"];
|
341
|
-
optional uint32 filetype = 4 [(description) = "See EPublishedFileInfoMatchingFileType"];
|
342
|
-
optional uint32 workshopfiletype = 5 [(description) = "See EWorkshopFileType. If specified, overrides filetype"];
|
343
|
-
}
|
344
|
-
|
345
|
-
message CPublishedFile_AreFilesInSubscriptionList_Response {
|
346
|
-
message InList {
|
347
|
-
optional fixed64 publishedfileid = 1;
|
348
|
-
optional bool inlist = 2;
|
349
|
-
}
|
350
|
-
|
351
|
-
repeated .CPublishedFile_AreFilesInSubscriptionList_Response.InList files = 1;
|
352
|
-
}
|
353
|
-
|
354
|
-
message CPublishedFile_Update_Request {
|
355
|
-
optional uint32 appid = 1 [(description) = "App Id this published file belongs to."];
|
356
|
-
optional fixed64 publishedfileid = 2 [(description) = "Published file id of the file we'd like to update."];
|
357
|
-
optional string title = 3 [(description) = "(Optional) Title of the published file."];
|
358
|
-
optional string file_description = 4 [(description) = "(Optional) Description of the published file."];
|
359
|
-
optional uint32 visibility = 5 [(description) = "(Optional) Visibility of the published file."];
|
360
|
-
repeated string tags = 6 [(description) = "(Optional) Set of tags for the published file."];
|
361
|
-
optional string filename = 7 [(description) = "(Optional) Filename for the published file."];
|
362
|
-
optional string preview_filename = 8 [(description) = "(Optional) Preview filename for the published file."];
|
363
|
-
optional bool spoiler_tag = 10 [(description) = "(Optional) Whether this published file should have a spoiler tag attached to it."];
|
364
|
-
optional uint32 image_width = 15 [(description) = "(Optional) If this is an image file, you can specify the image width."];
|
365
|
-
optional uint32 image_height = 16 [(description) = "(Optional) If this is an image file, you can specify the image height."];
|
366
|
-
}
|
367
|
-
|
368
|
-
message CPublishedFile_Update_Response {
|
369
|
-
}
|
370
|
-
|
371
|
-
message CPublishedFile_Delete_Request {
|
372
|
-
optional fixed64 publishedfileid = 1 [(description) = "Published file id of the file we'd like to delete."];
|
373
|
-
optional uint32 appid = 5;
|
374
|
-
}
|
375
|
-
|
376
|
-
message CPublishedFile_Delete_Response {
|
377
|
-
}
|
378
|
-
|
379
|
-
message CPublishedFile_GetChangeHistoryEntry_Request {
|
380
|
-
optional fixed64 publishedfileid = 1 [(description) = "Published file id of the file we'd like to get the change history for."];
|
381
|
-
optional uint32 timestamp = 2;
|
382
|
-
optional int32 language = 3;
|
383
|
-
}
|
384
|
-
|
385
|
-
message CPublishedFile_GetChangeHistoryEntry_Response {
|
386
|
-
optional string change_description = 1;
|
387
|
-
optional int32 language = 2;
|
388
|
-
}
|
389
|
-
|
390
|
-
message CPublishedFile_GetChangeHistory_Request {
|
391
|
-
optional fixed64 publishedfileid = 1 [(description) = "Published file id of the file we'd like to get the change history for."];
|
392
|
-
optional bool total_only = 2 [(description) = "Return the total number of changes only."];
|
393
|
-
optional uint32 startindex = 3;
|
394
|
-
optional uint32 count = 4;
|
395
|
-
optional int32 language = 5 [default = 0, (description) = "Desired language"];
|
396
|
-
}
|
397
|
-
|
398
|
-
message CPublishedFile_GetChangeHistory_Response {
|
399
|
-
message ChangeLog {
|
400
|
-
optional uint32 timestamp = 1;
|
401
|
-
optional string change_description = 2;
|
402
|
-
optional int32 language = 3;
|
403
|
-
}
|
404
|
-
|
405
|
-
repeated .CPublishedFile_GetChangeHistory_Response.ChangeLog changes = 1;
|
406
|
-
optional uint32 total = 2;
|
407
|
-
}
|
408
|
-
|
409
|
-
message CPublishedFile_RefreshVotingQueue_Request {
|
410
|
-
optional uint32 appid = 1;
|
411
|
-
optional uint32 matching_file_type = 2 [(description) = "EPublishedFileInfoMatchingFileType"];
|
412
|
-
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."];
|
413
|
-
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."];
|
414
|
-
repeated string excluded_tags = 5 [(description) = "Exclude any files that have any of these tags."];
|
415
|
-
optional uint32 desired_queue_size = 6 [(description) = "Desired number of items in the voting queue. May be clamped by the server"];
|
416
|
-
optional .EPublishedFileRevision desired_revision = 8 [default = k_EPublishedFileRevision_Default, (description) = "Filter to items that have data for the specified revision."];
|
417
|
-
}
|
418
|
-
|
419
|
-
message CPublishedFile_RefreshVotingQueue_Response {
|
420
|
-
}
|
421
|
-
|
422
|
-
message CPublishedFile_QueryFiles_Request {
|
423
|
-
message KVTag {
|
424
|
-
optional string key = 1;
|
425
|
-
optional string value = 2;
|
426
|
-
}
|
427
|
-
|
428
|
-
message TagGroup {
|
429
|
-
repeated string tags = 1;
|
430
|
-
}
|
431
|
-
|
432
|
-
message DateRange {
|
433
|
-
optional uint32 timestamp_start = 1 [(description) = "(Optional) Include items with the relevant date field after this value."];
|
434
|
-
optional uint32 timestamp_end = 2 [(description) = "(Optional) Include items with the relevant date field before this value."];
|
435
|
-
}
|
436
|
-
|
437
|
-
optional uint32 query_type = 1 [(description) = "enumeration EPublishedFileQueryType in clientenums.h"];
|
438
|
-
optional uint32 page = 2 [(description) = "Current page"];
|
439
|
-
optional string cursor = 39 [(description) = "Cursor to paginate through the results (set to '*' for the first request). Prefer this over using the page parameter, as it will allow you to do deep pagination. When used, the page parameter will be ignored."];
|
440
|
-
optional uint32 numperpage = 3 [default = 1, (description) = "(Optional) The number of results, per page to return."];
|
441
|
-
optional uint32 creator_appid = 4 [(description) = "App that created the files"];
|
442
|
-
optional uint32 appid = 5 [(description) = "App that consumes the files"];
|
443
|
-
repeated string requiredtags = 6 [(description) = "Tags to match on. See match_all_tags parameter below"];
|
444
|
-
repeated string excludedtags = 7 [(description) = "(Optional) Tags that must NOT be present on a published file to satisfy the query."];
|
445
|
-
optional bool match_all_tags = 8 [default = true, (description) = "If true, then items must have all the tags specified, otherwise they must have at least one of the tags."];
|
446
|
-
repeated string required_flags = 9 [(description) = "Required flags that must be set on any returned items"];
|
447
|
-
repeated string omitted_flags = 10 [(description) = "Flags that must not be set on any returned items"];
|
448
|
-
optional string search_text = 11 [(description) = "Text to match in the item's title or description"];
|
449
|
-
optional uint32 filetype = 12 [(description) = "EPublishedFileInfoMatchingFileType"];
|
450
|
-
optional fixed64 child_publishedfileid = 13 [(description) = "Find all items that reference the given item."];
|
451
|
-
optional uint32 days = 14 [(description) = "If query_type is k_PublishedFileQueryType_RankedByTrend, then this is the number of days to get votes for [1,7]."];
|
452
|
-
optional bool include_recent_votes_only = 15 [(description) = "If query_type is k_PublishedFileQueryType_RankedByTrend, then limit result set just to items that have votes within the day range given"];
|
453
|
-
optional uint32 cache_max_age_seconds = 31 [default = 0, (description) = "Allow stale data to be returned for the specified number of seconds."];
|
454
|
-
optional int32 language = 33 [default = 0, (description) = "Language to search in and also what gets returned. Defaults to English."];
|
455
|
-
repeated .CPublishedFile_QueryFiles_Request.KVTag required_kv_tags = 34 [(description) = "Required key-value tags to match on."];
|
456
|
-
repeated .CPublishedFile_QueryFiles_Request.TagGroup taggroups = 42 [(description) = "(Optional) At least one of the tags must be present on a published file to satisfy the query."];
|
457
|
-
optional .CPublishedFile_QueryFiles_Request.DateRange date_range_created = 44 [(description) = "(Optional) Filter to items created within this range."];
|
458
|
-
optional .CPublishedFile_QueryFiles_Request.DateRange date_range_updated = 45 [(description) = "(Optional) Filter to items updated within this range."];
|
459
|
-
repeated .EContentDescriptorID excluded_content_descriptors = 46 [(description) = "(Optional) Filter out items that have these content descriptors."];
|
460
|
-
optional bool totalonly = 16 [(description) = "(Optional) If true, only return the total number of files that satisfy this query."];
|
461
|
-
optional bool ids_only = 35 [(description) = "(Optional) If true, only return the published file ids of files that satisfy this query."];
|
462
|
-
optional bool return_vote_data = 17 [(description) = "Return vote data"];
|
463
|
-
optional bool return_tags = 18 [(description) = "Return tags in the file details"];
|
464
|
-
optional bool return_kv_tags = 19 [(description) = "Return key-value tags in the file details"];
|
465
|
-
optional bool return_previews = 20 [(description) = "Return preview image and video details in the file details"];
|
466
|
-
optional bool return_children = 21 [(description) = "Return child item ids in the file details"];
|
467
|
-
optional bool return_short_description = 22 [(description) = "Populate the short_description field instead of file_description"];
|
468
|
-
optional bool return_for_sale_data = 30 [(description) = "Return pricing information, if applicable"];
|
469
|
-
optional bool return_metadata = 32 [default = false, (description) = "Populate the metadata"];
|
470
|
-
optional uint32 return_playtime_stats = 36 [(description) = "Return playtime stats for the specified number of days before today."];
|
471
|
-
optional bool return_details = 37 [(description) = "By default, if none of the other 'return_*' fields are set, only some voting details are returned. Set this to true to return the default set of details."];
|
472
|
-
optional bool strip_description_bbcode = 38 [(description) = "Strips BBCode from descriptions."];
|
473
|
-
optional .EPublishedFileRevision desired_revision = 40 [default = k_EPublishedFileRevision_Default, (description) = "Return the data for the specified revision."];
|
474
|
-
optional bool return_reactions = 43 [default = false, (description) = "If true, then reactions to items will be returned."];
|
475
|
-
}
|
476
|
-
|
477
|
-
message CPublishedFile_QueryFiles_Response {
|
478
|
-
optional uint32 total = 1 [(description) = "Number of matches found, not necessarily number of items returned"];
|
479
|
-
repeated .PublishedFileDetails publishedfiledetails = 2 [(description) = "Each file details will be populated, depending on what return values were requested."];
|
480
|
-
optional string next_cursor = 3 [(description) = "If a paging cursor was used, then this will be the next cursor to use for paging through results"];
|
481
|
-
}
|
482
|
-
|
483
|
-
message CPublishedFile_AddAppRelationship_Request {
|
484
|
-
optional uint64 publishedfileid = 1;
|
485
|
-
optional uint32 appid = 2;
|
486
|
-
optional uint32 relationship = 3;
|
487
|
-
}
|
488
|
-
|
489
|
-
message CPublishedFile_AddAppRelationship_Response {
|
490
|
-
}
|
491
|
-
|
492
|
-
message CPublishedFile_RemoveAppRelationship_Request {
|
493
|
-
optional uint64 publishedfileid = 1;
|
494
|
-
optional uint32 appid = 2;
|
495
|
-
optional uint32 relationship = 3;
|
496
|
-
}
|
497
|
-
|
498
|
-
message CPublishedFile_RemoveAppRelationship_Response {
|
499
|
-
}
|
500
|
-
|
501
|
-
message CPublishedFile_GetAppRelationships_Request {
|
502
|
-
optional uint64 publishedfileid = 1;
|
503
|
-
}
|
504
|
-
|
505
|
-
message CPublishedFile_GetAppRelationships_Response {
|
506
|
-
message AppRelationship {
|
507
|
-
optional uint32 appid = 1;
|
508
|
-
optional uint32 relationship = 2;
|
509
|
-
}
|
510
|
-
|
511
|
-
repeated .CPublishedFile_GetAppRelationships_Response.AppRelationship app_relationships = 3;
|
512
|
-
}
|
513
|
-
|
514
|
-
message CPublishedFile_GetAppRelationshipsBatched_Request {
|
515
|
-
repeated uint64 publishedfileids = 1;
|
516
|
-
optional uint32 filter_relationship = 2;
|
517
|
-
}
|
518
|
-
|
519
|
-
message CPublishedFile_GetAppRelationshipsBatched_Response {
|
520
|
-
message AppRelationship {
|
521
|
-
optional uint32 appid = 1;
|
522
|
-
optional uint32 relationship = 2;
|
523
|
-
}
|
524
|
-
|
525
|
-
message PublishedFileAppRelationship {
|
526
|
-
optional uint64 publishedfileid = 1;
|
527
|
-
optional uint32 result = 2;
|
528
|
-
repeated .CPublishedFile_GetAppRelationshipsBatched_Response.AppRelationship app_relationships = 3;
|
529
|
-
}
|
530
|
-
|
531
|
-
repeated .CPublishedFile_GetAppRelationshipsBatched_Response.PublishedFileAppRelationship relationships = 1;
|
532
|
-
}
|
533
|
-
|
534
|
-
message CPublishedFile_StartPlaytimeTracking_Request {
|
535
|
-
optional uint32 appid = 1;
|
536
|
-
repeated uint64 publishedfileids = 2;
|
537
|
-
}
|
538
|
-
|
539
|
-
message CPublishedFile_StartPlaytimeTracking_Response {
|
540
|
-
}
|
541
|
-
|
542
|
-
message CPublishedFile_StopPlaytimeTracking_Request {
|
543
|
-
optional uint32 appid = 1;
|
544
|
-
repeated uint64 publishedfileids = 2;
|
545
|
-
}
|
546
|
-
|
547
|
-
message CPublishedFile_StopPlaytimeTracking_Response {
|
548
|
-
}
|
549
|
-
|
550
|
-
message CPublishedFile_StopPlaytimeTrackingForAllAppItems_Request {
|
551
|
-
optional uint32 appid = 1;
|
552
|
-
}
|
553
|
-
|
554
|
-
message CPublishedFile_StopPlaytimeTrackingForAllAppItems_Response {
|
555
|
-
}
|
556
|
-
|
557
|
-
message CPublishedFile_SetPlaytimeForControllerConfigs_Request {
|
558
|
-
message ControllerConfigUsage {
|
559
|
-
optional uint64 publishedfileid = 1;
|
560
|
-
optional float seconds_active = 2;
|
561
|
-
}
|
562
|
-
|
563
|
-
optional uint32 appid = 1;
|
564
|
-
repeated .CPublishedFile_SetPlaytimeForControllerConfigs_Request.ControllerConfigUsage controller_config_usage = 2;
|
565
|
-
}
|
566
|
-
|
567
|
-
message CPublishedFile_SetPlaytimeForControllerConfigs_Response {
|
568
|
-
}
|
569
|
-
|
570
|
-
message CPublishedFile_AddChild_Request {
|
571
|
-
optional uint64 publishedfileid = 1;
|
572
|
-
optional uint64 child_publishedfileid = 2;
|
573
|
-
}
|
574
|
-
|
575
|
-
message CPublishedFile_AddChild_Response {
|
576
|
-
}
|
577
|
-
|
578
|
-
message CPublishedFile_RemoveChild_Request {
|
579
|
-
optional uint64 publishedfileid = 1;
|
580
|
-
optional uint64 child_publishedfileid = 2;
|
581
|
-
}
|
582
|
-
|
583
|
-
message CPublishedFile_RemoveChild_Response {
|
584
|
-
}
|
585
|
-
|
586
|
-
message CPublishedFile_GetUserVoteSummary_Request {
|
587
|
-
repeated fixed64 publishedfileids = 1;
|
588
|
-
}
|
589
|
-
|
590
|
-
message CPublishedFile_GetUserVoteSummary_Response {
|
591
|
-
message VoteSummary {
|
592
|
-
optional fixed64 publishedfileid = 1;
|
593
|
-
optional bool vote_for = 2;
|
594
|
-
optional bool vote_against = 3;
|
595
|
-
optional bool reported = 4;
|
596
|
-
}
|
597
|
-
|
598
|
-
repeated .CPublishedFile_GetUserVoteSummary_Response.VoteSummary summaries = 1;
|
599
|
-
}
|
600
|
-
|
601
|
-
message CPublishedFile_GetItemChanges_Request {
|
602
|
-
optional uint32 appid = 1;
|
603
|
-
optional uint32 last_time_updated = 2;
|
604
|
-
optional uint32 num_items_max = 3;
|
605
|
-
}
|
606
|
-
|
607
|
-
message CPublishedFile_GetItemChanges_Response {
|
608
|
-
message WorkshopItemInfo {
|
609
|
-
optional fixed64 published_file_id = 1;
|
610
|
-
optional uint32 time_updated = 2;
|
611
|
-
optional fixed64 manifest_id = 3;
|
612
|
-
}
|
613
|
-
|
614
|
-
optional uint32 update_time = 1;
|
615
|
-
repeated .CPublishedFile_GetItemChanges_Response.WorkshopItemInfo workshop_items = 2;
|
616
|
-
}
|
617
|
-
|
618
|
-
message CPublishedFile_GetContentDescriptors_Request {
|
619
|
-
optional fixed64 publishedfileid = 1;
|
620
|
-
}
|
621
|
-
|
622
|
-
message CPublishedFile_GetContentDescriptors_Response {
|
623
|
-
message ContentDescriptor {
|
624
|
-
optional .EContentDescriptorID descriptorid = 1 [default = k_EContentDescriptor_NudityOrSexualContent];
|
625
|
-
optional uint32 accountid = 2;
|
626
|
-
optional uint32 timestamp = 3;
|
627
|
-
optional bool moderator_set = 4;
|
628
|
-
}
|
629
|
-
|
630
|
-
repeated .CPublishedFile_GetContentDescriptors_Response.ContentDescriptor content_descriptors = 1;
|
631
|
-
}
|
632
|
-
|
633
|
-
message CPublishedFile_UpdateContentDescriptors_Request {
|
634
|
-
optional fixed64 publishedfileid = 1;
|
635
|
-
repeated .EContentDescriptorID descriptors_to_add = 2;
|
636
|
-
repeated .EContentDescriptorID descriptors_to_remove = 3;
|
637
|
-
}
|
638
|
-
|
639
|
-
message CPublishedFile_UpdateContentDescriptors_Response {
|
640
|
-
optional uint32 timestamp_updated = 1;
|
641
|
-
}
|
642
|
-
|
643
|
-
message CPublishedFile_FileSubscribed_Notification {
|
644
|
-
message RevisionData {
|
645
|
-
optional .EPublishedFileRevision revision = 1 [default = k_EPublishedFileRevision_Default];
|
646
|
-
optional fixed64 file_hcontent = 2 [(description) = "Manifest GID"];
|
647
|
-
optional uint32 rtime_updated = 3 [(description) = "Last time content updated"];
|
648
|
-
}
|
649
|
-
|
650
|
-
optional fixed64 published_file_id = 1 [(description) = "PublishedFileID_t for the content"];
|
651
|
-
optional uint32 app_id = 2;
|
652
|
-
optional fixed64 file_hcontent = 3 [(description) = "UGC file handle or manifest GID"];
|
653
|
-
optional uint32 file_size = 4;
|
654
|
-
optional uint32 rtime_subscribed = 5;
|
655
|
-
optional bool is_depot_content = 6 [(description) = "True if workshop item is delivered via Steampipe"];
|
656
|
-
optional uint32 rtime_updated = 7 [(description) = "Last time content updated"];
|
657
|
-
repeated .CPublishedFile_FileSubscribed_Notification.RevisionData revisions = 8 [(description) = "Data for each of the revisions that this item has"];
|
658
|
-
}
|
659
|
-
|
660
|
-
message CPublishedFile_FileUnsubscribed_Notification {
|
661
|
-
optional fixed64 published_file_id = 1 [(description) = "PublishedFileID_t for the content"];
|
662
|
-
optional uint32 app_id = 2;
|
663
|
-
}
|
664
|
-
|
665
|
-
message CPublishedFile_FileDeleted_Client_Notification {
|
666
|
-
optional fixed64 published_file_id = 1 [(description) = "PublishedFileID_t for the content"];
|
667
|
-
optional uint32 app_id = 2;
|
668
|
-
}
|
669
|
-
|
670
|
-
service PublishedFile {
|
671
|
-
option (service_description) = "A service to access published file data";
|
672
|
-
|
673
|
-
rpc Vote (.CPublishedFile_Vote_Request) returns (.CPublishedFile_Vote_Response) {
|
674
|
-
option (method_description) = "User wants to vote on the item";
|
675
|
-
}
|
676
|
-
|
677
|
-
rpc Subscribe (.CPublishedFile_Subscribe_Request) returns (.CPublishedFile_Subscribe_Response) {
|
678
|
-
option (method_description) = "Subscribes the user to the published file";
|
679
|
-
}
|
680
|
-
|
681
|
-
rpc Unsubscribe (.CPublishedFile_Unsubscribe_Request) returns (.CPublishedFile_Unsubscribe_Response) {
|
682
|
-
option (method_description) = "Unsubscribes the user from the published file";
|
683
|
-
}
|
684
|
-
|
685
|
-
rpc CanSubscribe (.CPublishedFile_CanSubscribe_Request) returns (.CPublishedFile_CanSubscribe_Response) {
|
686
|
-
option (method_description) = "Check if the user can subscribe to the published file";
|
687
|
-
}
|
688
|
-
|
689
|
-
rpc GetSubSectionData (.CPublishedFile_GetSubSectionData_Request) returns (.CPublishedFile_GetSubSectionData_Response) {
|
690
|
-
option (method_description) = "Get sub section data (for table of contents, a specific section, or all)";
|
691
|
-
}
|
692
|
-
|
693
|
-
rpc Publish (.CPublishedFile_Publish_Request) returns (.CPublishedFile_Publish_Response) {
|
694
|
-
option (method_description) = "Publishes a clouded user file to the Workshop.";
|
695
|
-
}
|
696
|
-
|
697
|
-
rpc GetDetails (.CPublishedFile_GetDetails_Request) returns (.CPublishedFile_GetDetails_Response) {
|
698
|
-
option (method_description) = "Retrieves information about a set of published files.";
|
699
|
-
}
|
700
|
-
|
701
|
-
rpc GetItemInfo (.CPublishedFile_GetItemInfo_Request) returns (.CPublishedFile_GetItemInfo_Response) {
|
702
|
-
option (method_description) = "Retrieves information about a set of published files.";
|
703
|
-
}
|
704
|
-
|
705
|
-
rpc GetUserFiles (.CPublishedFile_GetUserFiles_Request) returns (.CPublishedFile_GetUserFiles_Response) {
|
706
|
-
option (method_description) = "Retrieves files published by a user.";
|
707
|
-
}
|
708
|
-
|
709
|
-
rpc GetUserFileCount (.CPublishedFile_GetUserFiles_Request) returns (.CPublishedFile_GetUserFiles_Response) {
|
710
|
-
option (method_description) = "Retrieves a count of files published by a user. Uses the same messages as GetUserFiles but totalonly must be true.";
|
711
|
-
}
|
712
|
-
|
713
|
-
rpc AreFilesInSubscriptionList (.CPublishedFile_AreFilesInSubscriptionList_Request) returns (.CPublishedFile_AreFilesInSubscriptionList_Response) {
|
714
|
-
option (method_description) = "Determines which files in the given list are in a user's subscription list";
|
715
|
-
}
|
716
|
-
|
717
|
-
rpc Update (.CPublishedFile_Update_Request) returns (.CPublishedFile_Update_Response) {
|
718
|
-
option (method_description) = "Updates information about a published file.";
|
719
|
-
}
|
720
|
-
|
721
|
-
rpc Delete (.CPublishedFile_Delete_Request) returns (.CPublishedFile_Delete_Response) {
|
722
|
-
option (method_description) = "Deletes a published file.";
|
723
|
-
}
|
724
|
-
|
725
|
-
rpc GetChangeHistoryEntry (.CPublishedFile_GetChangeHistoryEntry_Request) returns (.CPublishedFile_GetChangeHistoryEntry_Response) {
|
726
|
-
option (method_description) = "Returns data on a specific change history entry for a published file";
|
727
|
-
}
|
728
|
-
|
729
|
-
rpc GetChangeHistory (.CPublishedFile_GetChangeHistory_Request) returns (.CPublishedFile_GetChangeHistory_Response) {
|
730
|
-
option (method_description) = "Returns data on the change history for a published file";
|
731
|
-
}
|
732
|
-
|
733
|
-
rpc RefreshVotingQueue (.CPublishedFile_RefreshVotingQueue_Request) returns (.CPublishedFile_RefreshVotingQueue_Response) {
|
734
|
-
option (method_description) = "Refresh the voting queue for the user";
|
735
|
-
}
|
736
|
-
|
737
|
-
rpc QueryFiles (.CPublishedFile_QueryFiles_Request) returns (.CPublishedFile_QueryFiles_Response) {
|
738
|
-
option (method_description) = "Performs a search query for published files";
|
739
|
-
}
|
740
|
-
|
741
|
-
rpc AddAppRelationship (.CPublishedFile_AddAppRelationship_Request) returns (.CPublishedFile_AddAppRelationship_Response) {
|
742
|
-
option (method_description) = "Adds a relationship between the published file and the given app";
|
743
|
-
}
|
744
|
-
|
745
|
-
rpc RemoveAppRelationship (.CPublishedFile_RemoveAppRelationship_Request) returns (.CPublishedFile_RemoveAppRelationship_Response) {
|
746
|
-
option (method_description) = "Remove a relationship between the published file and the given app";
|
747
|
-
}
|
748
|
-
|
749
|
-
rpc GetAppRelationships (.CPublishedFile_GetAppRelationships_Request) returns (.CPublishedFile_GetAppRelationships_Response) {
|
750
|
-
option (method_description) = "Returns the list of app relationships for this published file";
|
751
|
-
}
|
752
|
-
|
753
|
-
rpc GetAppRelationshipsBatched (.CPublishedFile_GetAppRelationshipsBatched_Request) returns (.CPublishedFile_GetAppRelationshipsBatched_Response) {
|
754
|
-
option (method_description) = "Returns the list of app relationships for set of published files";
|
755
|
-
}
|
756
|
-
|
757
|
-
rpc StartPlaytimeTracking (.CPublishedFile_StartPlaytimeTracking_Request) returns (.CPublishedFile_StartPlaytimeTracking_Response) {
|
758
|
-
option (method_description) = "Start usage tracking for a given set of published files";
|
759
|
-
}
|
760
|
-
|
761
|
-
rpc StopPlaytimeTracking (.CPublishedFile_StopPlaytimeTracking_Request) returns (.CPublishedFile_StopPlaytimeTracking_Response) {
|
762
|
-
option (method_description) = "Stops usage tracking for a given set of published files";
|
763
|
-
}
|
764
|
-
|
765
|
-
rpc StopPlaytimeTrackingForAllAppItems (.CPublishedFile_StopPlaytimeTrackingForAllAppItems_Request) returns (.CPublishedFile_StopPlaytimeTrackingForAllAppItems_Response) {
|
766
|
-
option (method_description) = "Stops usage tracking for all items currently tracked for the specified app";
|
767
|
-
}
|
768
|
-
|
769
|
-
rpc SetPlaytimeForControllerConfigs (.CPublishedFile_SetPlaytimeForControllerConfigs_Request) returns (.CPublishedFile_SetPlaytimeForControllerConfigs_Response) {
|
770
|
-
option (method_description) = "Stops usage tracking all controller configs for the given app and set the usage time for the for the given controller configs";
|
771
|
-
}
|
772
|
-
|
773
|
-
rpc AddChild (.CPublishedFile_AddChild_Request) returns (.CPublishedFile_AddChild_Response) {
|
774
|
-
option (method_description) = "Adds a parent->child relationship between the given items.";
|
775
|
-
}
|
776
|
-
|
777
|
-
rpc RemoveChild (.CPublishedFile_RemoveChild_Request) returns (.CPublishedFile_RemoveChild_Response) {
|
778
|
-
option (method_description) = "Removes parent->child relationship between the given items.";
|
779
|
-
}
|
780
|
-
|
781
|
-
rpc GetUserVoteSummary (.CPublishedFile_GetUserVoteSummary_Request) returns (.CPublishedFile_GetUserVoteSummary_Response) {
|
782
|
-
option (method_description) = "Get user vote summary";
|
783
|
-
}
|
784
|
-
|
785
|
-
rpc GetItemChanges (.CPublishedFile_GetItemChanges_Request) returns (.CPublishedFile_GetItemChanges_Response) {
|
786
|
-
option (method_description) = "Get list of updated items since given date";
|
787
|
-
}
|
788
|
-
|
789
|
-
rpc GetContentDescriptors (.CPublishedFile_GetContentDescriptors_Request) returns (.CPublishedFile_GetContentDescriptors_Response) {
|
790
|
-
option (method_description) = "Returns more detailed information about the content descriptors for the published file";
|
791
|
-
}
|
792
|
-
|
793
|
-
rpc UpdateContentDescriptors (.CPublishedFile_UpdateContentDescriptors_Request) returns (.CPublishedFile_UpdateContentDescriptors_Response) {
|
794
|
-
option (method_description) = "Updates content descriptors on the published file";
|
795
|
-
}
|
796
|
-
}
|
797
|
-
|
798
|
-
service PublishedFileClient {
|
799
|
-
option (service_description) = "Published file client notifications";
|
800
|
-
option (service_execution_site) = k_EProtoExecutionSiteSteamClient;
|
801
|
-
|
802
|
-
rpc NotifyFileSubscribed (.CPublishedFile_FileSubscribed_Notification) returns (.NoResponse) {
|
803
|
-
option (method_description) = "Notification from the server when a user subscribes to a file";
|
804
|
-
}
|
805
|
-
|
806
|
-
rpc NotifyFileUnsubscribed (.CPublishedFile_FileUnsubscribed_Notification) returns (.NoResponse) {
|
807
|
-
option (method_description) = "Notification from the server when a user unsubscribes from a file";
|
808
|
-
}
|
809
|
-
|
810
|
-
rpc NotifyFileDeleted (.CPublishedFile_FileDeleted_Client_Notification) returns (.NoResponse) {
|
811
|
-
option (method_description) = "Notification from the server when a published file is deleted";
|
812
|
-
}
|
813
|
-
}
|
1
|
+
import "steammessages_base.proto";
|
2
|
+
import "steammessages_unified_base.steamclient.proto";
|
3
|
+
import "enums_productinfo.proto";
|
4
|
+
|
5
|
+
option cc_generic_services = true;
|
6
|
+
|
7
|
+
enum EPublishedFileRevision {
|
8
|
+
k_EPublishedFileRevision_Default = 0;
|
9
|
+
k_EPublishedFileRevision_Latest = 1;
|
10
|
+
k_EPublishedFileRevision_ApprovedSnapshot = 2;
|
11
|
+
k_EPublishedFileRevision_ApprovedSnapshot_China = 3;
|
12
|
+
k_EPublishedFileRevision_RejectedSnapshot = 4;
|
13
|
+
k_EPublishedFileRevision_RejectedSnapshot_China = 5;
|
14
|
+
}
|
15
|
+
|
16
|
+
enum EPublishedFileForSaleStatus {
|
17
|
+
k_PFFSS_NotForSale = 0;
|
18
|
+
k_PFFSS_PendingApproval = 1;
|
19
|
+
k_PFFSS_ApprovedForSale = 2;
|
20
|
+
k_PFFSS_RejectedForSale = 3;
|
21
|
+
k_PFFSS_NoLongerForSale = 4;
|
22
|
+
k_PFFSS_TentativeApproval = 5;
|
23
|
+
}
|
24
|
+
|
25
|
+
message CPublishedFile_Vote_Request {
|
26
|
+
optional uint64 publishedfileid = 1;
|
27
|
+
optional bool vote_up = 2;
|
28
|
+
}
|
29
|
+
|
30
|
+
message CPublishedFile_Vote_Response {
|
31
|
+
}
|
32
|
+
|
33
|
+
message CPublishedFile_Subscribe_Request {
|
34
|
+
optional uint64 publishedfileid = 1;
|
35
|
+
optional uint32 list_type = 2;
|
36
|
+
optional int32 appid = 3;
|
37
|
+
optional bool notify_client = 4;
|
38
|
+
}
|
39
|
+
|
40
|
+
message CPublishedFile_Subscribe_Response {
|
41
|
+
}
|
42
|
+
|
43
|
+
message CPublishedFile_Unsubscribe_Request {
|
44
|
+
optional uint64 publishedfileid = 1;
|
45
|
+
optional uint32 list_type = 2;
|
46
|
+
optional int32 appid = 3;
|
47
|
+
optional bool notify_client = 4;
|
48
|
+
}
|
49
|
+
|
50
|
+
message CPublishedFile_Unsubscribe_Response {
|
51
|
+
}
|
52
|
+
|
53
|
+
message CPublishedFile_CanSubscribe_Request {
|
54
|
+
optional uint64 publishedfileid = 1;
|
55
|
+
}
|
56
|
+
|
57
|
+
message CPublishedFile_CanSubscribe_Response {
|
58
|
+
optional bool can_subscribe = 1;
|
59
|
+
}
|
60
|
+
|
61
|
+
message CPublishedFile_GetSubSectionData_Request {
|
62
|
+
optional uint64 publishedfileid = 1;
|
63
|
+
optional bool for_table_of_contents = 2;
|
64
|
+
optional uint64 specific_sectionid = 3;
|
65
|
+
optional .EPublishedFileRevision desired_revision = 4 [default = k_EPublishedFileRevision_Default, (description) = "Return the data for the specified revision."];
|
66
|
+
}
|
67
|
+
|
68
|
+
message PublishedFileSubSection {
|
69
|
+
optional uint64 sectionid = 1;
|
70
|
+
optional string title = 2;
|
71
|
+
optional string description_text = 3;
|
72
|
+
optional uint32 sort_order = 4;
|
73
|
+
}
|
74
|
+
|
75
|
+
message CPublishedFile_GetSubSectionData_Response {
|
76
|
+
repeated .PublishedFileSubSection sub_sections = 1;
|
77
|
+
}
|
78
|
+
|
79
|
+
message CPublishedFile_Publish_Request {
|
80
|
+
optional uint32 appid = 1 [(description) = "App Id this file is being published FROM."];
|
81
|
+
optional uint32 consumer_appid = 2 [(description) = "App Id this file is being published TO."];
|
82
|
+
optional string cloudfilename = 3 [(description) = "Name of the file to publish in the user's cloud."];
|
83
|
+
optional string preview_cloudfilename = 4 [(description) = "Name of the file to use as the published file's preview."];
|
84
|
+
optional string title = 5 [(description) = "Text title for the published file."];
|
85
|
+
optional string file_description = 6 [(description) = "Text description for the published file."];
|
86
|
+
optional uint32 file_type = 7 [(description) = "(EWorkshopFileType) Type of Workshop file to publish."];
|
87
|
+
optional string consumer_shortcut_name = 8 [(description) = "Shortcut name for the published file."];
|
88
|
+
optional string youtube_username = 9 [(description) = "(Optional) User's YouTube account username."];
|
89
|
+
optional string youtube_videoid = 10 [(description) = "(Optional) Video Id of a YouTube video for this published file."];
|
90
|
+
optional uint32 visibility = 11 [(description) = "(ERemoteStoragePublishedFileVisibility) Visibility of the published file (private, friends, public, etc.)"];
|
91
|
+
optional string redirect_uri = 12 [(description) = "(Optional) If supplied, the resulting published file's Id is appended to the URI."];
|
92
|
+
repeated string tags = 13 [(description) = "Array of text tags to apply to the published file."];
|
93
|
+
optional string collection_type = 14 [(description) = "(Optional) Type of collection the published file represents."];
|
94
|
+
optional string game_type = 15 [(description) = "(Optional) Type of game the published file represents."];
|
95
|
+
optional string url = 16 [(description) = "(Optional) If this represents a game, this is the URL to that game's page."];
|
96
|
+
}
|
97
|
+
|
98
|
+
message CPublishedFile_Publish_Response {
|
99
|
+
optional uint64 publishedfileid = 1;
|
100
|
+
optional string redirect_uri = 2;
|
101
|
+
}
|
102
|
+
|
103
|
+
message CPublishedFile_GetDetails_Request {
|
104
|
+
repeated fixed64 publishedfileids = 1 [(description) = "Set of published file Ids to retrieve details for."];
|
105
|
+
optional bool includetags = 2 [(description) = "If true, return tag information in the returned details."];
|
106
|
+
optional bool includeadditionalpreviews = 3 [(description) = "If true, return preview information in the returned details."];
|
107
|
+
optional bool includechildren = 4 [(description) = "If true, return children in the returned details."];
|
108
|
+
optional bool includekvtags = 5 [(description) = "If true, return key value tags in the returned details."];
|
109
|
+
optional bool includevotes = 6 [(description) = "If true, return vote data in the returned details."];
|
110
|
+
optional bool short_description = 8 [(description) = "If true, return a short description instead of the full description."];
|
111
|
+
optional bool includeforsaledata = 10 [(description) = "If true, return pricing data, if applicable."];
|
112
|
+
optional bool includemetadata = 11 [(description) = "If true, populate the metadata field."];
|
113
|
+
optional int32 language = 12 [default = 0, (description) = "Specifies the localized text to return. Defaults to English."];
|
114
|
+
optional uint32 return_playtime_stats = 13 [(description) = "Return playtime stats for the specified number of days before today."];
|
115
|
+
optional uint32 appid = 14;
|
116
|
+
optional bool strip_description_bbcode = 15 [(description) = "Strips BBCode from descriptions."];
|
117
|
+
optional .EPublishedFileRevision desired_revision = 16 [default = k_EPublishedFileRevision_Default, (description) = "Return the data for the specified revision."];
|
118
|
+
optional bool includereactions = 17 [default = false, (description) = "If true, then reactions to items will be returned."];
|
119
|
+
}
|
120
|
+
|
121
|
+
message PublishedFileDetails {
|
122
|
+
message Tag {
|
123
|
+
optional string tag = 1;
|
124
|
+
optional bool adminonly = 2;
|
125
|
+
optional string display_name = 3;
|
126
|
+
}
|
127
|
+
|
128
|
+
message Preview {
|
129
|
+
optional uint64 previewid = 1;
|
130
|
+
optional uint32 sortorder = 2;
|
131
|
+
optional string url = 3;
|
132
|
+
optional uint32 size = 4;
|
133
|
+
optional string filename = 5;
|
134
|
+
optional string youtubevideoid = 6;
|
135
|
+
optional uint32 preview_type = 7;
|
136
|
+
optional string external_reference = 8;
|
137
|
+
}
|
138
|
+
|
139
|
+
message Child {
|
140
|
+
optional uint64 publishedfileid = 1;
|
141
|
+
optional uint32 sortorder = 2;
|
142
|
+
optional uint32 file_type = 3;
|
143
|
+
}
|
144
|
+
|
145
|
+
message KVTag {
|
146
|
+
optional string key = 1;
|
147
|
+
optional string value = 2;
|
148
|
+
}
|
149
|
+
|
150
|
+
message VoteData {
|
151
|
+
optional float score = 1;
|
152
|
+
optional uint32 votes_up = 2;
|
153
|
+
optional uint32 votes_down = 3;
|
154
|
+
}
|
155
|
+
|
156
|
+
message ForSaleData {
|
157
|
+
optional bool is_for_sale = 1;
|
158
|
+
optional uint32 price_category = 2;
|
159
|
+
optional .EPublishedFileForSaleStatus estatus = 3 [default = k_PFFSS_NotForSale];
|
160
|
+
optional uint32 price_category_floor = 4;
|
161
|
+
optional bool price_is_pay_what_you_want = 5;
|
162
|
+
optional uint32 discount_percentage = 6;
|
163
|
+
}
|
164
|
+
|
165
|
+
message PlaytimeStats {
|
166
|
+
optional uint64 playtime_seconds = 1;
|
167
|
+
optional uint64 num_sessions = 2;
|
168
|
+
}
|
169
|
+
|
170
|
+
message Reaction {
|
171
|
+
optional uint32 reactionid = 1;
|
172
|
+
optional uint32 count = 2;
|
173
|
+
}
|
174
|
+
|
175
|
+
optional uint32 result = 1;
|
176
|
+
optional uint64 publishedfileid = 2;
|
177
|
+
optional fixed64 creator = 3;
|
178
|
+
optional uint32 creator_appid = 4;
|
179
|
+
optional uint32 consumer_appid = 5;
|
180
|
+
optional uint32 consumer_shortcutid = 6;
|
181
|
+
optional string filename = 7;
|
182
|
+
optional uint64 file_size = 8;
|
183
|
+
optional uint64 preview_file_size = 9;
|
184
|
+
optional string file_url = 10;
|
185
|
+
optional string preview_url = 11;
|
186
|
+
optional string youtubevideoid = 12;
|
187
|
+
optional string url = 13;
|
188
|
+
optional fixed64 hcontent_file = 14;
|
189
|
+
optional fixed64 hcontent_preview = 15;
|
190
|
+
optional string title = 16;
|
191
|
+
optional string file_description = 17;
|
192
|
+
optional string short_description = 18;
|
193
|
+
optional uint32 time_created = 19;
|
194
|
+
optional uint32 time_updated = 20;
|
195
|
+
optional uint32 visibility = 21;
|
196
|
+
optional uint32 flags = 22;
|
197
|
+
optional bool workshop_file = 23;
|
198
|
+
optional bool workshop_accepted = 24;
|
199
|
+
optional bool show_subscribe_all = 25;
|
200
|
+
optional int32 num_comments_developer = 26;
|
201
|
+
optional int32 num_comments_public = 27;
|
202
|
+
optional bool banned = 28;
|
203
|
+
optional string ban_reason = 29;
|
204
|
+
optional fixed64 banner = 30;
|
205
|
+
optional bool can_be_deleted = 31;
|
206
|
+
optional bool incompatible = 32;
|
207
|
+
optional string app_name = 33;
|
208
|
+
optional uint32 file_type = 34;
|
209
|
+
optional bool can_subscribe = 35;
|
210
|
+
optional uint32 subscriptions = 36;
|
211
|
+
optional uint32 favorited = 37;
|
212
|
+
optional uint32 followers = 38;
|
213
|
+
optional uint32 lifetime_subscriptions = 39;
|
214
|
+
optional uint32 lifetime_favorited = 40;
|
215
|
+
optional uint32 lifetime_followers = 41;
|
216
|
+
optional uint64 lifetime_playtime = 62;
|
217
|
+
optional uint64 lifetime_playtime_sessions = 63;
|
218
|
+
optional uint32 views = 42;
|
219
|
+
optional uint32 image_width = 43;
|
220
|
+
optional uint32 image_height = 44;
|
221
|
+
optional string image_url = 45;
|
222
|
+
optional bool spoiler_tag = 46;
|
223
|
+
optional uint32 shortcutid = 47;
|
224
|
+
optional string shortcutname = 48;
|
225
|
+
optional uint32 num_children = 49;
|
226
|
+
optional uint32 num_reports = 50;
|
227
|
+
repeated .PublishedFileDetails.Preview previews = 51;
|
228
|
+
repeated .PublishedFileDetails.Tag tags = 52;
|
229
|
+
repeated .PublishedFileDetails.Child children = 53;
|
230
|
+
repeated .PublishedFileDetails.KVTag kvtags = 54;
|
231
|
+
optional .PublishedFileDetails.VoteData vote_data = 55;
|
232
|
+
optional .PublishedFileDetails.PlaytimeStats playtime_stats = 64;
|
233
|
+
optional uint32 time_subscribed = 56 [(description) = "Only valid in PublishedFile.GetUserFiles and not normal PublishedFile.GetDetail calls"];
|
234
|
+
optional .PublishedFileDetails.ForSaleData for_sale_data = 57 [(description) = "Pricing information, if applicable."];
|
235
|
+
optional string metadata = 58 [(description) = "Metadata associated with the item"];
|
236
|
+
optional int32 language = 61 [default = 0, (description) = "The language of the title and description."];
|
237
|
+
optional bool maybe_inappropriate_sex = 65;
|
238
|
+
optional bool maybe_inappropriate_violence = 66;
|
239
|
+
repeated .EContentDescriptorID content_descriptorids = 72;
|
240
|
+
optional uint64 revision_change_number = 67 [(description) = "The change number for the specified revision."];
|
241
|
+
optional .EPublishedFileRevision revision = 68 [default = k_EPublishedFileRevision_Default, (description) = "The revision of the data returned, usually k_EPublishedFileRevision_Latest, but can be another revision/snapshot depending on the caller."];
|
242
|
+
repeated .EPublishedFileRevision available_revisions = 69 [(description) = "Available revisions"];
|
243
|
+
repeated .PublishedFileDetails.Reaction reactions = 70 [(description) = "Reactions to this item"];
|
244
|
+
optional .EBanContentCheckResult ban_text_check_result = 71 [default = k_EBanContentCheckResult_NotScanned];
|
245
|
+
optional float search_score = 73 [(description) = "Search score, admin only"];
|
246
|
+
}
|
247
|
+
|
248
|
+
message CPublishedFile_GetDetails_Response {
|
249
|
+
repeated .PublishedFileDetails publishedfiledetails = 1;
|
250
|
+
}
|
251
|
+
|
252
|
+
message CPublishedFile_GetItemInfo_Request {
|
253
|
+
message WorkshopItem {
|
254
|
+
optional fixed64 published_file_id = 1;
|
255
|
+
optional uint32 time_updated = 2;
|
256
|
+
optional .EPublishedFileRevision desired_revision = 3 [default = k_EPublishedFileRevision_Default, (description) = "Return the data for the specified revision."];
|
257
|
+
}
|
258
|
+
|
259
|
+
optional uint32 appid = 1;
|
260
|
+
optional uint32 last_time_updated = 2;
|
261
|
+
repeated .CPublishedFile_GetItemInfo_Request.WorkshopItem workshop_items = 3;
|
262
|
+
}
|
263
|
+
|
264
|
+
message CPublishedFile_GetItemInfo_Response {
|
265
|
+
message WorkshopItemInfo {
|
266
|
+
optional fixed64 published_file_id = 1;
|
267
|
+
optional uint32 time_updated = 2;
|
268
|
+
optional fixed64 manifest_id = 3;
|
269
|
+
optional uint32 flags = 4;
|
270
|
+
}
|
271
|
+
|
272
|
+
optional uint32 update_time = 1;
|
273
|
+
repeated .CPublishedFile_GetItemInfo_Response.WorkshopItemInfo workshop_items = 2;
|
274
|
+
repeated fixed64 private_items = 3;
|
275
|
+
}
|
276
|
+
|
277
|
+
message CPublishedFile_GetUserFiles_Request {
|
278
|
+
message KVTag {
|
279
|
+
optional string key = 1;
|
280
|
+
optional string value = 2;
|
281
|
+
}
|
282
|
+
|
283
|
+
message TagGroup {
|
284
|
+
repeated string tags = 1;
|
285
|
+
}
|
286
|
+
|
287
|
+
optional fixed64 steamid = 1 [(description) = "Steam ID of the user whose files are being requested."];
|
288
|
+
optional uint32 appid = 2 [(description) = "App Id of the app that the files were published to."];
|
289
|
+
optional uint32 shortcutid = 3 [(description) = "(Optional) Shortcut Id to retrieve published files from."];
|
290
|
+
optional uint32 page = 4 [default = 1, (description) = "(Optional) Starting page for results."];
|
291
|
+
optional uint32 numperpage = 5 [default = 1, (description) = "(Optional) The number of results, per page to return."];
|
292
|
+
optional string type = 6 [default = "myfiles", (description) = "(Optional) Type of files to be returned."];
|
293
|
+
optional string sortmethod = 7 [default = "lastupdated", (description) = "(Optional) Sorting method to use on returned values."];
|
294
|
+
optional uint32 privacy = 9 [(description) = "(optional) Filter by privacy settings."];
|
295
|
+
repeated string requiredtags = 10 [(description) = "(Optional) Tags that must be present on a published file to satisfy the query."];
|
296
|
+
repeated string excludedtags = 11 [(description) = "(Optional) Tags that must NOT be present on a published file to satisfy the query."];
|
297
|
+
repeated .CPublishedFile_GetUserFiles_Request.KVTag required_kv_tags = 30 [(description) = "Required key-value tags to match on."];
|
298
|
+
optional uint32 filetype = 14 [(description) = "(Optional) File type to match files to."];
|
299
|
+
optional uint32 creator_appid = 15 [(description) = "App Id of the app that published the files, only matched if specified."];
|
300
|
+
optional string match_cloud_filename = 16 [(description) = "Match this cloud filename if specified."];
|
301
|
+
optional uint32 cache_max_age_seconds = 27 [default = 0, (description) = "Allow stale data to be returned for the specified number of seconds."];
|
302
|
+
optional int32 language = 29 [default = 0, (description) = "Specifies the localized text to return. Defaults to English."];
|
303
|
+
repeated .CPublishedFile_GetUserFiles_Request.TagGroup taggroups = 34 [(description) = "(Optional) At least one of the tags must be present on a published file to satisfy the query."];
|
304
|
+
repeated .EContentDescriptorID excluded_content_descriptors = 37 [(description) = "(Optional) Filter out items that have these content descriptors."];
|
305
|
+
optional bool totalonly = 17 [(description) = "(Optional) If true, only return the total number of files that satisfy this query."];
|
306
|
+
optional bool ids_only = 18 [(description) = "(Optional) If true, only return the published file ids of files that satisfy this query."];
|
307
|
+
optional bool return_vote_data = 19 [default = true, (description) = "Return vote data"];
|
308
|
+
optional bool return_tags = 20 [(description) = "Return tags in the file details"];
|
309
|
+
optional bool return_kv_tags = 21 [default = true, (description) = "Return key-value tags in the file details"];
|
310
|
+
optional bool return_previews = 22 [(description) = "Return preview image and video details in the file details"];
|
311
|
+
optional bool return_children = 23 [(description) = "Return child item ids in the file details"];
|
312
|
+
optional bool return_short_description = 24 [default = true, (description) = "Populate the short_description field instead of file_description"];
|
313
|
+
optional bool return_for_sale_data = 26 [(description) = "Return pricing information, if applicable"];
|
314
|
+
optional bool return_metadata = 28 [default = false, (description) = "Populate the metadata field"];
|
315
|
+
optional uint32 return_playtime_stats = 31 [(description) = "Return playtime stats for the specified number of days before today."];
|
316
|
+
optional bool strip_description_bbcode = 32 [(description) = "Strips BBCode from descriptions."];
|
317
|
+
optional bool return_reactions = 35 [default = false, (description) = "If true, then reactions to items will be returned."];
|
318
|
+
optional uint32 startindex_override = 25 [(description) = "Backwards compatible for the client."];
|
319
|
+
optional .EPublishedFileRevision desired_revision = 33 [default = k_EPublishedFileRevision_Default, (description) = "Return the data for the specified revision."];
|
320
|
+
optional bool return_apps = 36 [(description) = "Return list of apps the items belong to"];
|
321
|
+
}
|
322
|
+
|
323
|
+
message CPublishedFile_GetUserFiles_Response {
|
324
|
+
message App {
|
325
|
+
optional uint32 appid = 1;
|
326
|
+
optional string name = 2;
|
327
|
+
optional uint32 shortcutid = 3;
|
328
|
+
optional bool private = 4;
|
329
|
+
}
|
330
|
+
|
331
|
+
optional uint32 total = 1;
|
332
|
+
optional uint32 startindex = 2;
|
333
|
+
repeated .PublishedFileDetails publishedfiledetails = 3;
|
334
|
+
repeated .CPublishedFile_GetUserFiles_Response.App apps = 4;
|
335
|
+
}
|
336
|
+
|
337
|
+
message CPublishedFile_AreFilesInSubscriptionList_Request {
|
338
|
+
optional uint32 appid = 1;
|
339
|
+
repeated fixed64 publishedfileids = 2;
|
340
|
+
optional uint32 listtype = 3 [(description) = "See EUCMListType"];
|
341
|
+
optional uint32 filetype = 4 [(description) = "See EPublishedFileInfoMatchingFileType"];
|
342
|
+
optional uint32 workshopfiletype = 5 [(description) = "See EWorkshopFileType. If specified, overrides filetype"];
|
343
|
+
}
|
344
|
+
|
345
|
+
message CPublishedFile_AreFilesInSubscriptionList_Response {
|
346
|
+
message InList {
|
347
|
+
optional fixed64 publishedfileid = 1;
|
348
|
+
optional bool inlist = 2;
|
349
|
+
}
|
350
|
+
|
351
|
+
repeated .CPublishedFile_AreFilesInSubscriptionList_Response.InList files = 1;
|
352
|
+
}
|
353
|
+
|
354
|
+
message CPublishedFile_Update_Request {
|
355
|
+
optional uint32 appid = 1 [(description) = "App Id this published file belongs to."];
|
356
|
+
optional fixed64 publishedfileid = 2 [(description) = "Published file id of the file we'd like to update."];
|
357
|
+
optional string title = 3 [(description) = "(Optional) Title of the published file."];
|
358
|
+
optional string file_description = 4 [(description) = "(Optional) Description of the published file."];
|
359
|
+
optional uint32 visibility = 5 [(description) = "(Optional) Visibility of the published file."];
|
360
|
+
repeated string tags = 6 [(description) = "(Optional) Set of tags for the published file."];
|
361
|
+
optional string filename = 7 [(description) = "(Optional) Filename for the published file."];
|
362
|
+
optional string preview_filename = 8 [(description) = "(Optional) Preview filename for the published file."];
|
363
|
+
optional bool spoiler_tag = 10 [(description) = "(Optional) Whether this published file should have a spoiler tag attached to it."];
|
364
|
+
optional uint32 image_width = 15 [(description) = "(Optional) If this is an image file, you can specify the image width."];
|
365
|
+
optional uint32 image_height = 16 [(description) = "(Optional) If this is an image file, you can specify the image height."];
|
366
|
+
}
|
367
|
+
|
368
|
+
message CPublishedFile_Update_Response {
|
369
|
+
}
|
370
|
+
|
371
|
+
message CPublishedFile_Delete_Request {
|
372
|
+
optional fixed64 publishedfileid = 1 [(description) = "Published file id of the file we'd like to delete."];
|
373
|
+
optional uint32 appid = 5;
|
374
|
+
}
|
375
|
+
|
376
|
+
message CPublishedFile_Delete_Response {
|
377
|
+
}
|
378
|
+
|
379
|
+
message CPublishedFile_GetChangeHistoryEntry_Request {
|
380
|
+
optional fixed64 publishedfileid = 1 [(description) = "Published file id of the file we'd like to get the change history for."];
|
381
|
+
optional uint32 timestamp = 2;
|
382
|
+
optional int32 language = 3;
|
383
|
+
}
|
384
|
+
|
385
|
+
message CPublishedFile_GetChangeHistoryEntry_Response {
|
386
|
+
optional string change_description = 1;
|
387
|
+
optional int32 language = 2;
|
388
|
+
}
|
389
|
+
|
390
|
+
message CPublishedFile_GetChangeHistory_Request {
|
391
|
+
optional fixed64 publishedfileid = 1 [(description) = "Published file id of the file we'd like to get the change history for."];
|
392
|
+
optional bool total_only = 2 [(description) = "Return the total number of changes only."];
|
393
|
+
optional uint32 startindex = 3;
|
394
|
+
optional uint32 count = 4;
|
395
|
+
optional int32 language = 5 [default = 0, (description) = "Desired language"];
|
396
|
+
}
|
397
|
+
|
398
|
+
message CPublishedFile_GetChangeHistory_Response {
|
399
|
+
message ChangeLog {
|
400
|
+
optional uint32 timestamp = 1;
|
401
|
+
optional string change_description = 2;
|
402
|
+
optional int32 language = 3;
|
403
|
+
}
|
404
|
+
|
405
|
+
repeated .CPublishedFile_GetChangeHistory_Response.ChangeLog changes = 1;
|
406
|
+
optional uint32 total = 2;
|
407
|
+
}
|
408
|
+
|
409
|
+
message CPublishedFile_RefreshVotingQueue_Request {
|
410
|
+
optional uint32 appid = 1;
|
411
|
+
optional uint32 matching_file_type = 2 [(description) = "EPublishedFileInfoMatchingFileType"];
|
412
|
+
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."];
|
413
|
+
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."];
|
414
|
+
repeated string excluded_tags = 5 [(description) = "Exclude any files that have any of these tags."];
|
415
|
+
optional uint32 desired_queue_size = 6 [(description) = "Desired number of items in the voting queue. May be clamped by the server"];
|
416
|
+
optional .EPublishedFileRevision desired_revision = 8 [default = k_EPublishedFileRevision_Default, (description) = "Filter to items that have data for the specified revision."];
|
417
|
+
}
|
418
|
+
|
419
|
+
message CPublishedFile_RefreshVotingQueue_Response {
|
420
|
+
}
|
421
|
+
|
422
|
+
message CPublishedFile_QueryFiles_Request {
|
423
|
+
message KVTag {
|
424
|
+
optional string key = 1;
|
425
|
+
optional string value = 2;
|
426
|
+
}
|
427
|
+
|
428
|
+
message TagGroup {
|
429
|
+
repeated string tags = 1;
|
430
|
+
}
|
431
|
+
|
432
|
+
message DateRange {
|
433
|
+
optional uint32 timestamp_start = 1 [(description) = "(Optional) Include items with the relevant date field after this value."];
|
434
|
+
optional uint32 timestamp_end = 2 [(description) = "(Optional) Include items with the relevant date field before this value."];
|
435
|
+
}
|
436
|
+
|
437
|
+
optional uint32 query_type = 1 [(description) = "enumeration EPublishedFileQueryType in clientenums.h"];
|
438
|
+
optional uint32 page = 2 [(description) = "Current page"];
|
439
|
+
optional string cursor = 39 [(description) = "Cursor to paginate through the results (set to '*' for the first request). Prefer this over using the page parameter, as it will allow you to do deep pagination. When used, the page parameter will be ignored."];
|
440
|
+
optional uint32 numperpage = 3 [default = 1, (description) = "(Optional) The number of results, per page to return."];
|
441
|
+
optional uint32 creator_appid = 4 [(description) = "App that created the files"];
|
442
|
+
optional uint32 appid = 5 [(description) = "App that consumes the files"];
|
443
|
+
repeated string requiredtags = 6 [(description) = "Tags to match on. See match_all_tags parameter below"];
|
444
|
+
repeated string excludedtags = 7 [(description) = "(Optional) Tags that must NOT be present on a published file to satisfy the query."];
|
445
|
+
optional bool match_all_tags = 8 [default = true, (description) = "If true, then items must have all the tags specified, otherwise they must have at least one of the tags."];
|
446
|
+
repeated string required_flags = 9 [(description) = "Required flags that must be set on any returned items"];
|
447
|
+
repeated string omitted_flags = 10 [(description) = "Flags that must not be set on any returned items"];
|
448
|
+
optional string search_text = 11 [(description) = "Text to match in the item's title or description"];
|
449
|
+
optional uint32 filetype = 12 [(description) = "EPublishedFileInfoMatchingFileType"];
|
450
|
+
optional fixed64 child_publishedfileid = 13 [(description) = "Find all items that reference the given item."];
|
451
|
+
optional uint32 days = 14 [(description) = "If query_type is k_PublishedFileQueryType_RankedByTrend, then this is the number of days to get votes for [1,7]."];
|
452
|
+
optional bool include_recent_votes_only = 15 [(description) = "If query_type is k_PublishedFileQueryType_RankedByTrend, then limit result set just to items that have votes within the day range given"];
|
453
|
+
optional uint32 cache_max_age_seconds = 31 [default = 0, (description) = "Allow stale data to be returned for the specified number of seconds."];
|
454
|
+
optional int32 language = 33 [default = 0, (description) = "Language to search in and also what gets returned. Defaults to English."];
|
455
|
+
repeated .CPublishedFile_QueryFiles_Request.KVTag required_kv_tags = 34 [(description) = "Required key-value tags to match on."];
|
456
|
+
repeated .CPublishedFile_QueryFiles_Request.TagGroup taggroups = 42 [(description) = "(Optional) At least one of the tags must be present on a published file to satisfy the query."];
|
457
|
+
optional .CPublishedFile_QueryFiles_Request.DateRange date_range_created = 44 [(description) = "(Optional) Filter to items created within this range."];
|
458
|
+
optional .CPublishedFile_QueryFiles_Request.DateRange date_range_updated = 45 [(description) = "(Optional) Filter to items updated within this range."];
|
459
|
+
repeated .EContentDescriptorID excluded_content_descriptors = 46 [(description) = "(Optional) Filter out items that have these content descriptors."];
|
460
|
+
optional bool totalonly = 16 [(description) = "(Optional) If true, only return the total number of files that satisfy this query."];
|
461
|
+
optional bool ids_only = 35 [(description) = "(Optional) If true, only return the published file ids of files that satisfy this query."];
|
462
|
+
optional bool return_vote_data = 17 [(description) = "Return vote data"];
|
463
|
+
optional bool return_tags = 18 [(description) = "Return tags in the file details"];
|
464
|
+
optional bool return_kv_tags = 19 [(description) = "Return key-value tags in the file details"];
|
465
|
+
optional bool return_previews = 20 [(description) = "Return preview image and video details in the file details"];
|
466
|
+
optional bool return_children = 21 [(description) = "Return child item ids in the file details"];
|
467
|
+
optional bool return_short_description = 22 [(description) = "Populate the short_description field instead of file_description"];
|
468
|
+
optional bool return_for_sale_data = 30 [(description) = "Return pricing information, if applicable"];
|
469
|
+
optional bool return_metadata = 32 [default = false, (description) = "Populate the metadata"];
|
470
|
+
optional uint32 return_playtime_stats = 36 [(description) = "Return playtime stats for the specified number of days before today."];
|
471
|
+
optional bool return_details = 37 [(description) = "By default, if none of the other 'return_*' fields are set, only some voting details are returned. Set this to true to return the default set of details."];
|
472
|
+
optional bool strip_description_bbcode = 38 [(description) = "Strips BBCode from descriptions."];
|
473
|
+
optional .EPublishedFileRevision desired_revision = 40 [default = k_EPublishedFileRevision_Default, (description) = "Return the data for the specified revision."];
|
474
|
+
optional bool return_reactions = 43 [default = false, (description) = "If true, then reactions to items will be returned."];
|
475
|
+
}
|
476
|
+
|
477
|
+
message CPublishedFile_QueryFiles_Response {
|
478
|
+
optional uint32 total = 1 [(description) = "Number of matches found, not necessarily number of items returned"];
|
479
|
+
repeated .PublishedFileDetails publishedfiledetails = 2 [(description) = "Each file details will be populated, depending on what return values were requested."];
|
480
|
+
optional string next_cursor = 3 [(description) = "If a paging cursor was used, then this will be the next cursor to use for paging through results"];
|
481
|
+
}
|
482
|
+
|
483
|
+
message CPublishedFile_AddAppRelationship_Request {
|
484
|
+
optional uint64 publishedfileid = 1;
|
485
|
+
optional uint32 appid = 2;
|
486
|
+
optional uint32 relationship = 3;
|
487
|
+
}
|
488
|
+
|
489
|
+
message CPublishedFile_AddAppRelationship_Response {
|
490
|
+
}
|
491
|
+
|
492
|
+
message CPublishedFile_RemoveAppRelationship_Request {
|
493
|
+
optional uint64 publishedfileid = 1;
|
494
|
+
optional uint32 appid = 2;
|
495
|
+
optional uint32 relationship = 3;
|
496
|
+
}
|
497
|
+
|
498
|
+
message CPublishedFile_RemoveAppRelationship_Response {
|
499
|
+
}
|
500
|
+
|
501
|
+
message CPublishedFile_GetAppRelationships_Request {
|
502
|
+
optional uint64 publishedfileid = 1;
|
503
|
+
}
|
504
|
+
|
505
|
+
message CPublishedFile_GetAppRelationships_Response {
|
506
|
+
message AppRelationship {
|
507
|
+
optional uint32 appid = 1;
|
508
|
+
optional uint32 relationship = 2;
|
509
|
+
}
|
510
|
+
|
511
|
+
repeated .CPublishedFile_GetAppRelationships_Response.AppRelationship app_relationships = 3;
|
512
|
+
}
|
513
|
+
|
514
|
+
message CPublishedFile_GetAppRelationshipsBatched_Request {
|
515
|
+
repeated uint64 publishedfileids = 1;
|
516
|
+
optional uint32 filter_relationship = 2;
|
517
|
+
}
|
518
|
+
|
519
|
+
message CPublishedFile_GetAppRelationshipsBatched_Response {
|
520
|
+
message AppRelationship {
|
521
|
+
optional uint32 appid = 1;
|
522
|
+
optional uint32 relationship = 2;
|
523
|
+
}
|
524
|
+
|
525
|
+
message PublishedFileAppRelationship {
|
526
|
+
optional uint64 publishedfileid = 1;
|
527
|
+
optional uint32 result = 2;
|
528
|
+
repeated .CPublishedFile_GetAppRelationshipsBatched_Response.AppRelationship app_relationships = 3;
|
529
|
+
}
|
530
|
+
|
531
|
+
repeated .CPublishedFile_GetAppRelationshipsBatched_Response.PublishedFileAppRelationship relationships = 1;
|
532
|
+
}
|
533
|
+
|
534
|
+
message CPublishedFile_StartPlaytimeTracking_Request {
|
535
|
+
optional uint32 appid = 1;
|
536
|
+
repeated uint64 publishedfileids = 2;
|
537
|
+
}
|
538
|
+
|
539
|
+
message CPublishedFile_StartPlaytimeTracking_Response {
|
540
|
+
}
|
541
|
+
|
542
|
+
message CPublishedFile_StopPlaytimeTracking_Request {
|
543
|
+
optional uint32 appid = 1;
|
544
|
+
repeated uint64 publishedfileids = 2;
|
545
|
+
}
|
546
|
+
|
547
|
+
message CPublishedFile_StopPlaytimeTracking_Response {
|
548
|
+
}
|
549
|
+
|
550
|
+
message CPublishedFile_StopPlaytimeTrackingForAllAppItems_Request {
|
551
|
+
optional uint32 appid = 1;
|
552
|
+
}
|
553
|
+
|
554
|
+
message CPublishedFile_StopPlaytimeTrackingForAllAppItems_Response {
|
555
|
+
}
|
556
|
+
|
557
|
+
message CPublishedFile_SetPlaytimeForControllerConfigs_Request {
|
558
|
+
message ControllerConfigUsage {
|
559
|
+
optional uint64 publishedfileid = 1;
|
560
|
+
optional float seconds_active = 2;
|
561
|
+
}
|
562
|
+
|
563
|
+
optional uint32 appid = 1;
|
564
|
+
repeated .CPublishedFile_SetPlaytimeForControllerConfigs_Request.ControllerConfigUsage controller_config_usage = 2;
|
565
|
+
}
|
566
|
+
|
567
|
+
message CPublishedFile_SetPlaytimeForControllerConfigs_Response {
|
568
|
+
}
|
569
|
+
|
570
|
+
message CPublishedFile_AddChild_Request {
|
571
|
+
optional uint64 publishedfileid = 1;
|
572
|
+
optional uint64 child_publishedfileid = 2;
|
573
|
+
}
|
574
|
+
|
575
|
+
message CPublishedFile_AddChild_Response {
|
576
|
+
}
|
577
|
+
|
578
|
+
message CPublishedFile_RemoveChild_Request {
|
579
|
+
optional uint64 publishedfileid = 1;
|
580
|
+
optional uint64 child_publishedfileid = 2;
|
581
|
+
}
|
582
|
+
|
583
|
+
message CPublishedFile_RemoveChild_Response {
|
584
|
+
}
|
585
|
+
|
586
|
+
message CPublishedFile_GetUserVoteSummary_Request {
|
587
|
+
repeated fixed64 publishedfileids = 1;
|
588
|
+
}
|
589
|
+
|
590
|
+
message CPublishedFile_GetUserVoteSummary_Response {
|
591
|
+
message VoteSummary {
|
592
|
+
optional fixed64 publishedfileid = 1;
|
593
|
+
optional bool vote_for = 2;
|
594
|
+
optional bool vote_against = 3;
|
595
|
+
optional bool reported = 4;
|
596
|
+
}
|
597
|
+
|
598
|
+
repeated .CPublishedFile_GetUserVoteSummary_Response.VoteSummary summaries = 1;
|
599
|
+
}
|
600
|
+
|
601
|
+
message CPublishedFile_GetItemChanges_Request {
|
602
|
+
optional uint32 appid = 1;
|
603
|
+
optional uint32 last_time_updated = 2;
|
604
|
+
optional uint32 num_items_max = 3;
|
605
|
+
}
|
606
|
+
|
607
|
+
message CPublishedFile_GetItemChanges_Response {
|
608
|
+
message WorkshopItemInfo {
|
609
|
+
optional fixed64 published_file_id = 1;
|
610
|
+
optional uint32 time_updated = 2;
|
611
|
+
optional fixed64 manifest_id = 3;
|
612
|
+
}
|
613
|
+
|
614
|
+
optional uint32 update_time = 1;
|
615
|
+
repeated .CPublishedFile_GetItemChanges_Response.WorkshopItemInfo workshop_items = 2;
|
616
|
+
}
|
617
|
+
|
618
|
+
message CPublishedFile_GetContentDescriptors_Request {
|
619
|
+
optional fixed64 publishedfileid = 1;
|
620
|
+
}
|
621
|
+
|
622
|
+
message CPublishedFile_GetContentDescriptors_Response {
|
623
|
+
message ContentDescriptor {
|
624
|
+
optional .EContentDescriptorID descriptorid = 1 [default = k_EContentDescriptor_NudityOrSexualContent];
|
625
|
+
optional uint32 accountid = 2;
|
626
|
+
optional uint32 timestamp = 3;
|
627
|
+
optional bool moderator_set = 4;
|
628
|
+
}
|
629
|
+
|
630
|
+
repeated .CPublishedFile_GetContentDescriptors_Response.ContentDescriptor content_descriptors = 1;
|
631
|
+
}
|
632
|
+
|
633
|
+
message CPublishedFile_UpdateContentDescriptors_Request {
|
634
|
+
optional fixed64 publishedfileid = 1;
|
635
|
+
repeated .EContentDescriptorID descriptors_to_add = 2;
|
636
|
+
repeated .EContentDescriptorID descriptors_to_remove = 3;
|
637
|
+
}
|
638
|
+
|
639
|
+
message CPublishedFile_UpdateContentDescriptors_Response {
|
640
|
+
optional uint32 timestamp_updated = 1;
|
641
|
+
}
|
642
|
+
|
643
|
+
message CPublishedFile_FileSubscribed_Notification {
|
644
|
+
message RevisionData {
|
645
|
+
optional .EPublishedFileRevision revision = 1 [default = k_EPublishedFileRevision_Default];
|
646
|
+
optional fixed64 file_hcontent = 2 [(description) = "Manifest GID"];
|
647
|
+
optional uint32 rtime_updated = 3 [(description) = "Last time content updated"];
|
648
|
+
}
|
649
|
+
|
650
|
+
optional fixed64 published_file_id = 1 [(description) = "PublishedFileID_t for the content"];
|
651
|
+
optional uint32 app_id = 2;
|
652
|
+
optional fixed64 file_hcontent = 3 [(description) = "UGC file handle or manifest GID"];
|
653
|
+
optional uint32 file_size = 4;
|
654
|
+
optional uint32 rtime_subscribed = 5;
|
655
|
+
optional bool is_depot_content = 6 [(description) = "True if workshop item is delivered via Steampipe"];
|
656
|
+
optional uint32 rtime_updated = 7 [(description) = "Last time content updated"];
|
657
|
+
repeated .CPublishedFile_FileSubscribed_Notification.RevisionData revisions = 8 [(description) = "Data for each of the revisions that this item has"];
|
658
|
+
}
|
659
|
+
|
660
|
+
message CPublishedFile_FileUnsubscribed_Notification {
|
661
|
+
optional fixed64 published_file_id = 1 [(description) = "PublishedFileID_t for the content"];
|
662
|
+
optional uint32 app_id = 2;
|
663
|
+
}
|
664
|
+
|
665
|
+
message CPublishedFile_FileDeleted_Client_Notification {
|
666
|
+
optional fixed64 published_file_id = 1 [(description) = "PublishedFileID_t for the content"];
|
667
|
+
optional uint32 app_id = 2;
|
668
|
+
}
|
669
|
+
|
670
|
+
service PublishedFile {
|
671
|
+
option (service_description) = "A service to access published file data";
|
672
|
+
|
673
|
+
rpc Vote (.CPublishedFile_Vote_Request) returns (.CPublishedFile_Vote_Response) {
|
674
|
+
option (method_description) = "User wants to vote on the item";
|
675
|
+
}
|
676
|
+
|
677
|
+
rpc Subscribe (.CPublishedFile_Subscribe_Request) returns (.CPublishedFile_Subscribe_Response) {
|
678
|
+
option (method_description) = "Subscribes the user to the published file";
|
679
|
+
}
|
680
|
+
|
681
|
+
rpc Unsubscribe (.CPublishedFile_Unsubscribe_Request) returns (.CPublishedFile_Unsubscribe_Response) {
|
682
|
+
option (method_description) = "Unsubscribes the user from the published file";
|
683
|
+
}
|
684
|
+
|
685
|
+
rpc CanSubscribe (.CPublishedFile_CanSubscribe_Request) returns (.CPublishedFile_CanSubscribe_Response) {
|
686
|
+
option (method_description) = "Check if the user can subscribe to the published file";
|
687
|
+
}
|
688
|
+
|
689
|
+
rpc GetSubSectionData (.CPublishedFile_GetSubSectionData_Request) returns (.CPublishedFile_GetSubSectionData_Response) {
|
690
|
+
option (method_description) = "Get sub section data (for table of contents, a specific section, or all)";
|
691
|
+
}
|
692
|
+
|
693
|
+
rpc Publish (.CPublishedFile_Publish_Request) returns (.CPublishedFile_Publish_Response) {
|
694
|
+
option (method_description) = "Publishes a clouded user file to the Workshop.";
|
695
|
+
}
|
696
|
+
|
697
|
+
rpc GetDetails (.CPublishedFile_GetDetails_Request) returns (.CPublishedFile_GetDetails_Response) {
|
698
|
+
option (method_description) = "Retrieves information about a set of published files.";
|
699
|
+
}
|
700
|
+
|
701
|
+
rpc GetItemInfo (.CPublishedFile_GetItemInfo_Request) returns (.CPublishedFile_GetItemInfo_Response) {
|
702
|
+
option (method_description) = "Retrieves information about a set of published files.";
|
703
|
+
}
|
704
|
+
|
705
|
+
rpc GetUserFiles (.CPublishedFile_GetUserFiles_Request) returns (.CPublishedFile_GetUserFiles_Response) {
|
706
|
+
option (method_description) = "Retrieves files published by a user.";
|
707
|
+
}
|
708
|
+
|
709
|
+
rpc GetUserFileCount (.CPublishedFile_GetUserFiles_Request) returns (.CPublishedFile_GetUserFiles_Response) {
|
710
|
+
option (method_description) = "Retrieves a count of files published by a user. Uses the same messages as GetUserFiles but totalonly must be true.";
|
711
|
+
}
|
712
|
+
|
713
|
+
rpc AreFilesInSubscriptionList (.CPublishedFile_AreFilesInSubscriptionList_Request) returns (.CPublishedFile_AreFilesInSubscriptionList_Response) {
|
714
|
+
option (method_description) = "Determines which files in the given list are in a user's subscription list";
|
715
|
+
}
|
716
|
+
|
717
|
+
rpc Update (.CPublishedFile_Update_Request) returns (.CPublishedFile_Update_Response) {
|
718
|
+
option (method_description) = "Updates information about a published file.";
|
719
|
+
}
|
720
|
+
|
721
|
+
rpc Delete (.CPublishedFile_Delete_Request) returns (.CPublishedFile_Delete_Response) {
|
722
|
+
option (method_description) = "Deletes a published file.";
|
723
|
+
}
|
724
|
+
|
725
|
+
rpc GetChangeHistoryEntry (.CPublishedFile_GetChangeHistoryEntry_Request) returns (.CPublishedFile_GetChangeHistoryEntry_Response) {
|
726
|
+
option (method_description) = "Returns data on a specific change history entry for a published file";
|
727
|
+
}
|
728
|
+
|
729
|
+
rpc GetChangeHistory (.CPublishedFile_GetChangeHistory_Request) returns (.CPublishedFile_GetChangeHistory_Response) {
|
730
|
+
option (method_description) = "Returns data on the change history for a published file";
|
731
|
+
}
|
732
|
+
|
733
|
+
rpc RefreshVotingQueue (.CPublishedFile_RefreshVotingQueue_Request) returns (.CPublishedFile_RefreshVotingQueue_Response) {
|
734
|
+
option (method_description) = "Refresh the voting queue for the user";
|
735
|
+
}
|
736
|
+
|
737
|
+
rpc QueryFiles (.CPublishedFile_QueryFiles_Request) returns (.CPublishedFile_QueryFiles_Response) {
|
738
|
+
option (method_description) = "Performs a search query for published files";
|
739
|
+
}
|
740
|
+
|
741
|
+
rpc AddAppRelationship (.CPublishedFile_AddAppRelationship_Request) returns (.CPublishedFile_AddAppRelationship_Response) {
|
742
|
+
option (method_description) = "Adds a relationship between the published file and the given app";
|
743
|
+
}
|
744
|
+
|
745
|
+
rpc RemoveAppRelationship (.CPublishedFile_RemoveAppRelationship_Request) returns (.CPublishedFile_RemoveAppRelationship_Response) {
|
746
|
+
option (method_description) = "Remove a relationship between the published file and the given app";
|
747
|
+
}
|
748
|
+
|
749
|
+
rpc GetAppRelationships (.CPublishedFile_GetAppRelationships_Request) returns (.CPublishedFile_GetAppRelationships_Response) {
|
750
|
+
option (method_description) = "Returns the list of app relationships for this published file";
|
751
|
+
}
|
752
|
+
|
753
|
+
rpc GetAppRelationshipsBatched (.CPublishedFile_GetAppRelationshipsBatched_Request) returns (.CPublishedFile_GetAppRelationshipsBatched_Response) {
|
754
|
+
option (method_description) = "Returns the list of app relationships for set of published files";
|
755
|
+
}
|
756
|
+
|
757
|
+
rpc StartPlaytimeTracking (.CPublishedFile_StartPlaytimeTracking_Request) returns (.CPublishedFile_StartPlaytimeTracking_Response) {
|
758
|
+
option (method_description) = "Start usage tracking for a given set of published files";
|
759
|
+
}
|
760
|
+
|
761
|
+
rpc StopPlaytimeTracking (.CPublishedFile_StopPlaytimeTracking_Request) returns (.CPublishedFile_StopPlaytimeTracking_Response) {
|
762
|
+
option (method_description) = "Stops usage tracking for a given set of published files";
|
763
|
+
}
|
764
|
+
|
765
|
+
rpc StopPlaytimeTrackingForAllAppItems (.CPublishedFile_StopPlaytimeTrackingForAllAppItems_Request) returns (.CPublishedFile_StopPlaytimeTrackingForAllAppItems_Response) {
|
766
|
+
option (method_description) = "Stops usage tracking for all items currently tracked for the specified app";
|
767
|
+
}
|
768
|
+
|
769
|
+
rpc SetPlaytimeForControllerConfigs (.CPublishedFile_SetPlaytimeForControllerConfigs_Request) returns (.CPublishedFile_SetPlaytimeForControllerConfigs_Response) {
|
770
|
+
option (method_description) = "Stops usage tracking all controller configs for the given app and set the usage time for the for the given controller configs";
|
771
|
+
}
|
772
|
+
|
773
|
+
rpc AddChild (.CPublishedFile_AddChild_Request) returns (.CPublishedFile_AddChild_Response) {
|
774
|
+
option (method_description) = "Adds a parent->child relationship between the given items.";
|
775
|
+
}
|
776
|
+
|
777
|
+
rpc RemoveChild (.CPublishedFile_RemoveChild_Request) returns (.CPublishedFile_RemoveChild_Response) {
|
778
|
+
option (method_description) = "Removes parent->child relationship between the given items.";
|
779
|
+
}
|
780
|
+
|
781
|
+
rpc GetUserVoteSummary (.CPublishedFile_GetUserVoteSummary_Request) returns (.CPublishedFile_GetUserVoteSummary_Response) {
|
782
|
+
option (method_description) = "Get user vote summary";
|
783
|
+
}
|
784
|
+
|
785
|
+
rpc GetItemChanges (.CPublishedFile_GetItemChanges_Request) returns (.CPublishedFile_GetItemChanges_Response) {
|
786
|
+
option (method_description) = "Get list of updated items since given date";
|
787
|
+
}
|
788
|
+
|
789
|
+
rpc GetContentDescriptors (.CPublishedFile_GetContentDescriptors_Request) returns (.CPublishedFile_GetContentDescriptors_Response) {
|
790
|
+
option (method_description) = "Returns more detailed information about the content descriptors for the published file";
|
791
|
+
}
|
792
|
+
|
793
|
+
rpc UpdateContentDescriptors (.CPublishedFile_UpdateContentDescriptors_Request) returns (.CPublishedFile_UpdateContentDescriptors_Response) {
|
794
|
+
option (method_description) = "Updates content descriptors on the published file";
|
795
|
+
}
|
796
|
+
}
|
797
|
+
|
798
|
+
service PublishedFileClient {
|
799
|
+
option (service_description) = "Published file client notifications";
|
800
|
+
option (service_execution_site) = k_EProtoExecutionSiteSteamClient;
|
801
|
+
|
802
|
+
rpc NotifyFileSubscribed (.CPublishedFile_FileSubscribed_Notification) returns (.NoResponse) {
|
803
|
+
option (method_description) = "Notification from the server when a user subscribes to a file";
|
804
|
+
}
|
805
|
+
|
806
|
+
rpc NotifyFileUnsubscribed (.CPublishedFile_FileUnsubscribed_Notification) returns (.NoResponse) {
|
807
|
+
option (method_description) = "Notification from the server when a user unsubscribes from a file";
|
808
|
+
}
|
809
|
+
|
810
|
+
rpc NotifyFileDeleted (.CPublishedFile_FileDeleted_Client_Notification) returns (.NoResponse) {
|
811
|
+
option (method_description) = "Notification from the server when a published file is deleted";
|
812
|
+
}
|
813
|
+
}
|