steamutils 1.2.50 → 1.2.52

Sign up to get free protection for your applications and to get access to all the features.
Files changed (227) hide show
  1. package/.idea/codeStyles/codeStyleConfig.xml +5 -0
  2. package/.idea/steamutils.iml +1 -1
  3. package/.idea/vcs.xml +1 -1
  4. package/SteamClient.js +16 -12
  5. package/example.js +14 -0
  6. package/helpers/protos.js +21 -0
  7. package/index.js +1 -1
  8. package/package.json +6 -6
  9. package/protos/{base_gcmessages.proto → csgo/base_gcmessages_csgo.proto} +547 -533
  10. package/protos/csgo/c_peer2peer_netmessages.proto +55 -0
  11. package/protos/csgo/clientmessages.proto +48 -0
  12. package/protos/csgo/connectionless_netmessages.proto +19 -0
  13. package/protos/csgo/cs_gameevents.proto +34 -0
  14. package/protos/csgo/cs_usercmd.proto +34 -0
  15. package/protos/{cstrike15_gcmessages.proto → csgo/cstrike15_gcmessages.proto} +1402 -1344
  16. package/protos/{cstrike15_usermessages.proto → csgo/cstrike15_usermessages.proto} +596 -597
  17. package/protos/csgo/demo.proto +160 -0
  18. package/protos/{econ_gcmessages.proto → csgo/econ_gcmessages.proto} +228 -225
  19. package/protos/{engine_gcmessages.proto → csgo/engine_gcmessages.proto} +14 -16
  20. package/protos/{enums_clientserver.proto → csgo/enums_clientserver.proto} +1529 -1534
  21. package/protos/{fatdemo.proto → csgo/fatdemo.proto} +125 -125
  22. package/protos/csgo/gameevents.proto +120 -0
  23. package/protos/{gcsdk_gcmessages.proto → csgo/gcsdk_gcmessages.proto} +323 -302
  24. package/protos/{gcsystemmsgs.proto → csgo/gcsystemmsgs.proto} +242 -246
  25. package/protos/csgo/netmessages.proto +604 -0
  26. package/protos/csgo/network_connection.proto +126 -0
  27. package/protos/csgo/networkbasetypes.proto +244 -0
  28. package/protos/csgo/networksystem_protomessages.proto +17 -0
  29. package/protos/{steamdatagram_messages_auth.proto → csgo/steamdatagram_messages_auth.proto} +65 -65
  30. package/protos/csgo/steamdatagram_messages_sdr.proto +534 -0
  31. package/protos/{steammessages.proto → csgo/steammessages.proto} +597 -601
  32. package/protos/{steammessages_base.proto → csgo/steammessages_base.proto} +301 -288
  33. package/protos/csgo/steammessages_cloud.steamworkssdk.proto +68 -0
  34. package/protos/{steammessages_gamenetworkingui.proto → csgo/steammessages_gamenetworkingui.proto} +61 -42
  35. package/protos/csgo/steammessages_helprequest.steamworkssdk.proto +22 -0
  36. package/protos/csgo/steammessages_oauth.steamworkssdk.proto +18 -0
  37. package/protos/csgo/steammessages_player.steamworkssdk.proto +254 -0
  38. package/protos/csgo/steammessages_publishedfile.steamworkssdk.proto +233 -0
  39. package/protos/csgo/steammessages_steamlearn.steamworkssdk.proto +357 -0
  40. package/protos/csgo/steammessages_unified_base.steamworkssdk.proto +30 -0
  41. package/protos/{steamnetworkingsockets_messages.proto → csgo/steamnetworkingsockets_messages.proto} +205 -204
  42. package/protos/{steamnetworkingsockets_messages_certs.proto → csgo/steamnetworkingsockets_messages_certs.proto} +39 -38
  43. package/protos/{steamnetworkingsockets_messages_udp.proto → csgo/steamnetworkingsockets_messages_udp.proto} +75 -75
  44. package/protos/csgo/te.proto +259 -0
  45. package/protos/{uifontfile_format.proto → csgo/uifontfile_format.proto} +13 -16
  46. package/protos/csgo/usercmd.proto +38 -0
  47. package/protos/csgo/usermessages.proto +721 -0
  48. package/protos/csgo/valveextensions.proto +17 -0
  49. package/protos/google/protobuf/descriptor.proto +281 -0
  50. package/protos/{clientmetrics.proto → steam/clientmetrics.proto} +45 -45
  51. package/protos/{content_manifest.proto → steam/content_manifest.proto} +62 -62
  52. package/protos/steam/contenthubs.proto +41 -0
  53. package/protos/{encrypted_app_ticket.proto → steam/encrypted_app_ticket.proto} +10 -10
  54. package/protos/{enums.proto → steam/enums.proto} +444 -285
  55. package/protos/steam/enums_clientserver.proto +1539 -0
  56. package/protos/steam/enums_productinfo.proto +13 -0
  57. package/protos/{htmlmessages.proto → steam/htmlmessages.proto} +1027 -993
  58. package/protos/steam/offline_ticket.proto +8 -0
  59. package/protos/{renderer → steam/renderer}/rendermessages.proto +893 -893
  60. package/protos/steam/steamdatagram_messages_auth.proto +65 -0
  61. package/protos/{steamdatagram_messages_sdr.proto → steam/steamdatagram_messages_sdr.proto} +533 -518
  62. package/protos/{steammessages_accounthardware.steamclient.proto → steam/steammessages_accounthardware.steamclient.proto} +201 -188
  63. package/protos/{steammessages_appoverview.proto → steam/steammessages_appoverview.proto} +187 -185
  64. package/protos/steam/steammessages_auth.steamclient.proto +435 -0
  65. package/protos/steam/steammessages_base.proto +332 -0
  66. package/protos/{steammessages_broadcast.steamclient.proto → steam/steammessages_broadcast.steamclient.proto} +759 -756
  67. package/protos/{steammessages_chat.steamclient.proto → steam/steammessages_chat.steamclient.proto} +1281 -1281
  68. package/protos/steam/steammessages_client_objects.proto +645 -0
  69. package/protos/{steammessages_clientlanp2p.proto → steam/steammessages_clientlanp2p.proto} +42 -26
  70. package/protos/{steammessages_clientmetrics.steamclient.proto → steam/steammessages_clientmetrics.steamclient.proto} +194 -176
  71. package/protos/{steammessages_clientnotificationtypes.proto → steam/steammessages_clientnotificationtypes.proto} +231 -129
  72. package/protos/{steammessages_clientserver.proto → steam/steammessages_clientserver.proto} +392 -384
  73. package/protos/{steammessages_clientserver_2.proto → steam/steammessages_clientserver_2.proto} +760 -776
  74. package/protos/{steammessages_clientserver_appinfo.proto → steam/steammessages_clientserver_appinfo.proto} +131 -166
  75. package/protos/{steammessages_clientserver_friends.proto → steam/steammessages_clientserver_friends.proto} +260 -260
  76. package/protos/{steammessages_clientserver_gameservers.proto → steam/steammessages_clientserver_gameservers.proto} +159 -159
  77. package/protos/{steammessages_clientserver_lbs.proto → steam/steammessages_clientserver_lbs.proto} +70 -70
  78. package/protos/{steammessages_clientserver_login.proto → steam/steammessages_clientserver_login.proto} +167 -159
  79. package/protos/{steammessages_clientserver_mms.proto → steam/steammessages_clientserver_mms.proto} +228 -235
  80. package/protos/{steammessages_clientserver_ucm.proto → steam/steammessages_clientserver_ucm.proto} +205 -202
  81. package/protos/{steammessages_clientserver_uds.proto → steam/steammessages_clientserver_uds.proto} +124 -104
  82. package/protos/{steammessages_clientserver_ufs.proto → steam/steammessages_clientserver_ufs.proto} +172 -172
  83. package/protos/{steammessages_clientserver_userstats.proto → steam/steammessages_clientserver_userstats.proto} +80 -80
  84. package/protos/steam/steammessages_clientsettings.proto +168 -0
  85. package/protos/{steammessages_cloud.steamclient.proto → steam/steammessages_cloud.steamclient.proto} +513 -512
  86. package/protos/{steammessages_contentsystem.steamclient.proto → steam/steammessages_contentsystem.steamclient.proto} +115 -77
  87. package/protos/{steammessages_credentials.steamclient.proto → steam/steammessages_credentials.steamclient.proto} +115 -141
  88. package/protos/steam/steammessages_datapublisher.steamclient.proto +116 -0
  89. package/protos/{steammessages_depotbuilder.steamclient.proto → steam/steammessages_depotbuilder.steamclient.proto} +118 -118
  90. package/protos/{steammessages_deviceauth.steamclient.proto → steam/steammessages_deviceauth.steamclient.proto} +203 -200
  91. package/protos/{steammessages_econ.steamclient.proto → steam/steammessages_econ.steamclient.proto} +150 -105
  92. package/protos/{steammessages_friendmessages.steamclient.proto → steam/steammessages_friendmessages.steamclient.proto} +168 -168
  93. package/protos/{steammessages_gamenetworking.steamclient.proto → steam/steammessages_gamenetworking.steamclient.proto} +32 -32
  94. package/protos/steam/steammessages_gamenetworkingui.proto +61 -0
  95. package/protos/{steammessages_gamenotifications.steamclient.proto → steam/steammessages_gamenotifications.steamclient.proto} +156 -156
  96. package/protos/{steammessages_gameservers.steamclient.proto → steam/steammessages_gameservers.steamclient.proto} +152 -152
  97. package/protos/{steammessages_hiddevices.proto → steam/steammessages_hiddevices.proto} +157 -156
  98. package/protos/{steammessages_inventory.steamclient.proto → steam/steammessages_inventory.steamclient.proto} +224 -224
  99. package/protos/{steammessages_linkfilter.steamclient.proto → steam/steammessages_linkfilter.steamclient.proto} +49 -49
  100. package/protos/{steammessages_lobbymatchmaking.steamclient.proto → steam/steammessages_lobbymatchmaking.steamclient.proto} +33 -33
  101. package/protos/{steammessages_market.steamclient.proto → steam/steammessages_market.steamclient.proto} +26 -26
  102. package/protos/steam/steammessages_marketingmessages.steamclient.proto +274 -0
  103. package/protos/{steammessages_offline.steamclient.proto → steam/steammessages_offline.steamclient.proto} +40 -37
  104. package/protos/{steammessages_parental.steamclient.proto → steam/steammessages_parental.steamclient.proto} +228 -186
  105. package/protos/{steammessages_parties.steamclient.proto → steam/steammessages_parties.steamclient.proto} +94 -94
  106. package/protos/{steammessages_partnerapps.steamclient.proto → steam/steammessages_partnerapps.steamclient.proto} +138 -136
  107. package/protos/{steammessages_player.steamclient.proto → steam/steammessages_player.steamclient.proto} +1060 -912
  108. package/protos/{steammessages_publishedfile.steamclient.proto → steam/steammessages_publishedfile.steamclient.proto} +813 -711
  109. package/protos/{steammessages_qms.steamclient.proto → steam/steammessages_qms.steamclient.proto} +125 -125
  110. package/protos/{steammessages_remoteclient.proto → steam/steammessages_remoteclient.proto} +99 -99
  111. package/protos/{steammessages_remoteclient_discovery.proto → steam/steammessages_remoteclient_discovery.proto} +235 -228
  112. package/protos/{steammessages_remoteclient_service.steamclient.proto → steam/steammessages_remoteclient_service.steamclient.proto} +86 -90
  113. package/protos/{steammessages_remoteclient_service_messages.proto → steam/steammessages_remoteclient_service_messages.proto} +217 -196
  114. package/protos/{steammessages_remoteplay.proto → steam/steammessages_remoteplay.proto} +976 -871
  115. package/protos/{steammessages_secrets.steamclient.proto → steam/steammessages_secrets.steamclient.proto} +39 -39
  116. package/protos/{steammessages_shader.steamclient.proto → steam/steammessages_shader.steamclient.proto} +108 -96
  117. package/protos/{steammessages_site_license.steamclient.proto → steam/steammessages_site_license.steamclient.proto} +128 -128
  118. package/protos/{steammessages_sitelicenseclient.proto → steam/steammessages_sitelicenseclient.proto} +38 -38
  119. package/protos/{steammessages_siteserverui.proto → steam/steammessages_siteserverui.proto} +130 -130
  120. package/protos/{steammessages_star.steamclient.proto → steam/steammessages_star.steamclient.proto} +64 -64
  121. package/protos/{steammessages_steamtv.steamclient.proto → steam/steammessages_steamtv.steamclient.proto} +630 -630
  122. package/protos/{steammessages_store.steamclient.proto → steam/steammessages_store.steamclient.proto} +371 -262
  123. package/protos/steam/steammessages_storebrowse.steamclient.proto +402 -0
  124. package/protos/{steammessages_timedtrial.steamclient.proto → steam/steammessages_timedtrial.steamclient.proto} +50 -50
  125. package/protos/{steammessages_twofactor.steamclient.proto → steam/steammessages_twofactor.steamclient.proto} +186 -154
  126. package/protos/{steammessages_unified_base.steamclient.proto → steam/steammessages_unified_base.steamclient.proto} +33 -33
  127. package/protos/{steammessages_unified_test.steamclient.proto → steam/steammessages_unified_test.steamclient.proto} +61 -50
  128. package/protos/{steammessages_useraccount.steamclient.proto → steam/steammessages_useraccount.steamclient.proto} +249 -210
  129. package/protos/{steammessages_vac.steamclient.proto → steam/steammessages_vac.steamclient.proto} +44 -44
  130. package/protos/steam/steammessages_video.steamclient.proto +171 -0
  131. package/protos/{steammessages_virtualcontroller.proto → steam/steammessages_virtualcontroller.proto} +138 -138
  132. package/protos/{steammessages_workshop.steamclient.proto → steam/steammessages_workshop.steamclient.proto} +23 -23
  133. package/protos/steam/steamnetworkingsockets_messages.proto +205 -0
  134. package/protos/steam/steamnetworkingsockets_messages_certs.proto +39 -0
  135. package/protos/steam/steamnetworkingsockets_messages_udp.proto +75 -0
  136. package/protos/steam/webuimessages_base.proto +24 -0
  137. package/protos/steam/webuimessages_gamenotes.proto +21 -0
  138. package/protos/steam/webuimessages_steamengine.proto +32 -0
  139. package/protos/steam/webuimessages_storagedevicemanager.proto +110 -0
  140. package/protos/steam/webuimessages_systemmanager.proto +17 -0
  141. package/protos/steam/webuimessages_transport.proto +18 -0
  142. package/protos/steam/webuimessages_transportvalidation.proto +97 -0
  143. package/protos/webui/common.proto +5508 -0
  144. package/protos/webui/common_base.proto +27 -0
  145. package/protos/webui/service_accountlinking.proto +27 -0
  146. package/protos/webui/service_accountprivacy.proto +42 -0
  147. package/protos/webui/service_auction.proto +97 -0
  148. package/protos/webui/service_authentication.proto +222 -0
  149. package/protos/webui/service_authenticationsupport.proto +74 -0
  150. package/protos/webui/service_broadcast.proto +562 -0
  151. package/protos/webui/service_chat.proto +11 -0
  152. package/protos/webui/service_chatroom.proto +810 -0
  153. package/protos/webui/service_chatusability.proto +107 -0
  154. package/protos/webui/service_clan.proto +41 -0
  155. package/protos/webui/service_clanchatrooms.proto +25 -0
  156. package/protos/webui/service_clanfaqs.proto +202 -0
  157. package/protos/webui/service_clientcomm.proto +150 -0
  158. package/protos/webui/service_clientmetrics.proto +63 -0
  159. package/protos/webui/service_cloud.proto +222 -0
  160. package/protos/webui/service_cloudconfigstore.proto +51 -0
  161. package/protos/webui/service_cloudgaming.proto +30 -0
  162. package/protos/webui/service_community.proto +365 -0
  163. package/protos/webui/service_econ.proto +134 -0
  164. package/protos/webui/service_embedded.proto +24 -0
  165. package/protos/webui/service_experimentservice.proto +6 -0
  166. package/protos/webui/service_fovasvideo.proto +15 -0
  167. package/protos/webui/service_friendmessages.proto +133 -0
  168. package/protos/webui/service_friendslist.proto +70 -0
  169. package/protos/webui/service_gamenotes.proto +15 -0
  170. package/protos/webui/service_helprequestlogs.proto +26 -0
  171. package/protos/webui/service_loyaltyrewards.proto +252 -0
  172. package/protos/webui/service_marketingmessages.proto +184 -0
  173. package/protos/webui/service_mobileapp.proto +18 -0
  174. package/protos/webui/service_mobileauth.proto +24 -0
  175. package/protos/webui/service_mobiledevice.proto +26 -0
  176. package/protos/webui/service_mobileperaccount.proto +31 -0
  177. package/protos/webui/service_news.proto +101 -0
  178. package/protos/webui/service_parental.proto +178 -0
  179. package/protos/webui/service_partnermembershipinvite.proto +29 -0
  180. package/protos/webui/service_partnerstorebrowse.proto +6 -0
  181. package/protos/webui/service_phone.proto +51 -0
  182. package/protos/webui/service_physicalgoods.proto +15 -0
  183. package/protos/webui/service_player.proto +885 -0
  184. package/protos/webui/service_promotioneventinvites.proto +50 -0
  185. package/protos/webui/service_promotionplanning.proto +72 -0
  186. package/protos/webui/service_publishedfile.proto +687 -0
  187. package/protos/webui/service_publishing.proto +119 -0
  188. package/protos/webui/service_quest.proto +127 -0
  189. package/protos/webui/service_salefeature.proto +315 -0
  190. package/protos/webui/service_saleitemrewards.proto +54 -0
  191. package/protos/webui/service_shoppingcart.proto +108 -0
  192. package/protos/webui/service_steamawards.proto +19 -0
  193. package/protos/webui/service_steamcharts.proto +75 -0
  194. package/protos/webui/service_steamengine.proto +36 -0
  195. package/protos/webui/service_steamlearn.proto +727 -0
  196. package/protos/webui/service_steamnotification.proto +84 -0
  197. package/protos/webui/service_steamtv.proto +495 -0
  198. package/protos/webui/service_steamvrvoicechat.proto +67 -0
  199. package/protos/webui/service_steamvrwebrtc.proto +48 -0
  200. package/protos/webui/service_storagedevicemanager.proto +104 -0
  201. package/protos/webui/service_store.proto +289 -0
  202. package/protos/webui/service_storeappsimilarity.proto +76 -0
  203. package/protos/webui/service_storebrowse.proto +73 -0
  204. package/protos/webui/service_storequery.proto +97 -0
  205. package/protos/webui/service_storesales.proto +15 -0
  206. package/protos/webui/service_storetopsellers.proto +44 -0
  207. package/protos/webui/service_systemmanager.proto +11 -0
  208. package/protos/webui/service_test_transporterror.proto +6 -0
  209. package/protos/webui/service_transportauth.proto +12 -0
  210. package/protos/webui/service_transportvalidation.proto +69 -0
  211. package/protos/webui/service_twofactor.proto +181 -0
  212. package/protos/webui/service_useraccount.proto +138 -0
  213. package/protos/webui/service_usergameactivity.proto +34 -0
  214. package/protos/webui/service_usergamenotes.proto +53 -0
  215. package/protos/webui/service_usernews.proto +68 -0
  216. package/protos/webui/service_userreviews.proto +96 -0
  217. package/protos/webui/service_video.proto +128 -0
  218. package/protos/webui/service_voicechat.proto +139 -0
  219. package/protos/webui/service_webrtc.proto +52 -0
  220. package/.idea/deployment.xml +0 -21
  221. package/protos/netmessages.proto +0 -491
  222. package/protos/network_connection.proto +0 -70
  223. package/protos/steamdatagram_messages.proto +0 -205
  224. package/protos/steammessages_auth.steamclient.proto +0 -192
  225. package/protos/steammessages_client_objects.proto +0 -336
  226. package/protos/steammessages_datapublisher.steamclient.proto +0 -67
  227. package/protos/steammessages_video.steamclient.proto +0 -84
@@ -0,0 +1,61 @@
1
+ import "steamnetworkingsockets_messages.proto";
2
+ import "steamdatagram_messages_sdr.proto";
3
+
4
+ option optimize_for = SPEED;
5
+ option cc_generic_services = true;
6
+
7
+ message CGameNetworkingUI_GlobalState {
8
+ }
9
+
10
+ message CGameNetworkingUI_ConnectionState {
11
+ optional string connection_key = 1;
12
+ optional uint32 appid = 2;
13
+ optional fixed32 connection_id_local = 3;
14
+ optional string identity_local = 4;
15
+ optional string identity_remote = 5;
16
+ optional uint32 connection_state = 10;
17
+ optional uint32 start_time = 12;
18
+ optional uint32 close_time = 13;
19
+ optional uint32 close_reason = 14;
20
+ optional string close_message = 15;
21
+ optional string status_loc_token = 16;
22
+ optional uint32 transport_kind = 20;
23
+ optional string sdrpopid_local = 21;
24
+ optional string sdrpopid_remote = 22;
25
+ optional string address_remote = 23;
26
+ optional .CMsgSteamDatagramP2PRoutingSummary p2p_routing = 24;
27
+ optional uint32 ping_interior = 25;
28
+ optional uint32 ping_remote_front = 26;
29
+ optional uint32 ping_default_internet_route = 27;
30
+ optional .CMsgSteamDatagramConnectionQuality e2e_quality_local = 30;
31
+ optional .CMsgSteamDatagramConnectionQuality e2e_quality_remote = 31;
32
+ optional uint64 e2e_quality_remote_instantaneous_time = 32;
33
+ optional uint64 e2e_quality_remote_lifetime_time = 33;
34
+ optional .CMsgSteamDatagramConnectionQuality front_quality_local = 40;
35
+ optional .CMsgSteamDatagramConnectionQuality front_quality_remote = 41;
36
+ optional uint64 front_quality_remote_instantaneous_time = 42;
37
+ optional uint64 front_quality_remote_lifetime_time = 43;
38
+ }
39
+
40
+ message CGameNetworkingUI_Message {
41
+ repeated .CGameNetworkingUI_ConnectionState connection_state = 1;
42
+ }
43
+
44
+ message CGameNetworkingUI_ConnectionSummary {
45
+ optional uint32 transport_kind = 1;
46
+ optional uint32 connection_state = 8;
47
+ optional string sdrpop_local = 2;
48
+ optional string sdrpop_remote = 3;
49
+ optional uint32 ping_ms = 4;
50
+ optional float packet_loss = 5;
51
+ optional uint32 ping_default_internet_route = 6;
52
+ optional bool ip_was_shared = 7;
53
+ }
54
+
55
+ message CGameNetworkingUI_AppSummary {
56
+ optional uint32 appid = 1;
57
+ optional bool ip_was_shared_with_friend = 10;
58
+ optional bool ip_was_shared_with_nonfriend = 11;
59
+ optional uint32 active_connections = 20;
60
+ optional .CGameNetworkingUI_ConnectionSummary main_cxn = 30;
61
+ }
@@ -1,156 +1,156 @@
1
- import "steammessages_base.proto";
2
- import "steammessages_unified_base.steamclient.proto";
3
-
4
- option cc_generic_services = true;
5
-
6
- message CGameNotifications_Variable {
7
- optional string key = 1 [(description) = "The name of the variable in the localized text -- anywhere that %variablename% is found within the text it will be substituded with the given value"];
8
- optional string value = 2 [(description) = "The value of the variable to substitute in the localized text in place of the given variable. Can itself be a localization token."];
9
- }
10
-
11
- message CGameNotifications_LocalizedText {
12
- optional string token = 1 [(description) = "A localization token that maps to the desired string."];
13
- repeated .CGameNotifications_Variable variables = 2 [(description) = "A list of variables values to substitute in any variables found in the localized string."];
14
- optional string rendered_text = 3 [(description) = "Text rendered in the requested language, complete with variable substitutions, if a language was specified."];
15
- }
16
-
17
- message CGameNotifications_UserStatus {
18
- optional fixed64 steamid = 1 [(description) = "The specific user's steamid."];
19
- optional string state = 2 [(description) = "The user's state. ready -- the user is ready to play. waiting -- The game is waiting on an action from the user. completed, the game is over."];
20
- optional .CGameNotifications_LocalizedText title = 3 [(description) = "Title of the session to display to this user in their list of active sessions."];
21
- optional .CGameNotifications_LocalizedText message = 4 [(description) = "Subtitle of the session to display to this user user within their list of active sessions."];
22
- }
23
-
24
- message CGameNotifications_CreateSession_Request {
25
- optional uint32 appid = 1 [(description) = "The appid to create the session for."];
26
- optional uint64 context = 2 [(description) = "Game-specified context value the game can used to associate the session with some object on their backend."];
27
- optional .CGameNotifications_LocalizedText title = 3 [(description) = "The title of the session to be displayed within each user's list of sessions."];
28
- repeated .CGameNotifications_UserStatus users = 4 [(description) = "The initial state of all users in the session."];
29
- optional fixed64 steamid = 5 [(description) = "(Optional) steamid to make the request on behalf of -- if specified, the user must be in the session and all users being added to the session must be friends with the user."];
30
- }
31
-
32
- message CGameNotifications_CreateSession_Response {
33
- optional uint64 sessionid = 1 [(description) = "The sessionid of the created session."];
34
- }
35
-
36
- message CGameNotifications_DeleteSession_Request {
37
- optional uint64 sessionid = 1 [(description) = "The sessionid to delete."];
38
- optional uint32 appid = 2 [(description) = "The appid of the session to delete."];
39
- optional fixed64 steamid = 3 [(description) = "(Optional) steamid to make the request on behalf of -- if specified, the user must be in the session."];
40
- }
41
-
42
- message CGameNotifications_DeleteSession_Response {
43
- }
44
-
45
- message CGameNotifications_UpdateSession_Request {
46
- optional uint64 sessionid = 1 [(description) = "The sessionid to update."];
47
- optional uint32 appid = 2 [(description) = "The appid of the session to update."];
48
- optional .CGameNotifications_LocalizedText title = 3 [(description) = "(Optional) The new title of the session. If not specified, the title will not be changed."];
49
- repeated .CGameNotifications_UserStatus users = 4 [(description) = "(Optional) A list of users whose state will be updated to reflect the given state. If the users are not already in the session, they will be added to it."];
50
- optional fixed64 steamid = 6 [(description) = "(Optional) steamid to make the request on behalf of -- if specified, the user must be in the session and all users being added to the session must be friends with the user."];
51
- }
52
-
53
- message CGameNotifications_UpdateSession_Response {
54
- }
55
-
56
- message CGameNotifications_EnumerateSessions_Request {
57
- optional uint32 appid = 1 [(description) = "The sessionid to request details for. Optional. If not specified, all the user's sessions will be returned."];
58
- optional bool include_all_user_messages = 3 [(description) = "(Optional) Boolean determining whether the message for all users should be included. Defaults to false."];
59
- optional bool include_auth_user_message = 4 [(description) = "(Optional) Boolean determining whether the message for the authenticated user should be included. Defaults to false."];
60
- optional string language = 5 [(description) = "(Optional) Language to localize the text in."];
61
- }
62
-
63
- message CGameNotifications_Session {
64
- optional uint64 sessionid = 1 [(description) = "The sessionid for this session."];
65
- optional uint64 appid = 2 [(description) = "The appid for the session."];
66
- optional uint64 context = 3 [(description) = "Game-specified context value the game can used to associate the session with some object on their backend."];
67
- optional .CGameNotifications_LocalizedText title = 4 [(description) = "The current title for the session."];
68
- optional uint32 time_created = 5 [(description) = "The time the session was created."];
69
- optional uint32 time_updated = 6 [(description) = "The last time the session was updated."];
70
- repeated .CGameNotifications_UserStatus user_status = 7 [(description) = "The status of all the users in the session."];
71
- }
72
-
73
- message CGameNotifications_EnumerateSessions_Response {
74
- repeated .CGameNotifications_Session sessions = 1 [(description) = "A list of the user's sessions."];
75
- }
76
-
77
- message CGameNotifications_GetSessionDetails_Request {
78
- message RequestedSession {
79
- optional uint64 sessionid = 1 [(description) = "The sessionid to get details for."];
80
- optional bool include_auth_user_message = 3 [(description) = "(Optional) Boolean determining whether the message for the authenticated user should be included. Defaults to false."];
81
- }
82
-
83
- repeated .CGameNotifications_GetSessionDetails_Request.RequestedSession sessions = 1;
84
- optional uint32 appid = 2 [(description) = "The appid for the sessions."];
85
- optional string language = 3 [(description) = "Language to localize the text in."];
86
- }
87
-
88
- message CGameNotifications_GetSessionDetails_Response {
89
- repeated .CGameNotifications_Session sessions = 1 [(description) = "The details of the session."];
90
- }
91
-
92
- message GameNotificationSettings {
93
- optional uint32 appid = 1 [(description) = "The appid to create the session for."];
94
- optional bool allow_notifications = 2 [(description) = "Whether the user allows notification for this app."];
95
- }
96
-
97
- message CGameNotifications_UpdateNotificationSettings_Request {
98
- repeated .GameNotificationSettings game_notification_settings = 1;
99
- }
100
-
101
- message CGameNotifications_UpdateNotificationSettings_Response {
102
- }
103
-
104
- message CGameNotifications_OnNotificationsRequested_Notification {
105
- optional fixed64 steamid = 1 [(description) = "steamid of the user who notifications were requested for."];
106
- optional uint32 appid = 2 [(description) = "The appid that requested notifications."];
107
- }
108
-
109
- message CGameNotifications_OnUserStatusChanged_Notification {
110
- optional fixed64 steamid = 1 [(description) = "steamid of the user whose status changed."];
111
- optional uint64 sessionid = 2 [(description) = "The sessionid of the session where the user's status was changed."];
112
- optional uint32 appid = 3 [(description) = "The appid of the session where the user's status changed."];
113
- optional .CGameNotifications_UserStatus status = 4 [(description) = "(Optional) New status of the user."];
114
- optional bool removed = 5 [(description) = "(Optional) User has been removed from the session."];
115
- }
116
-
117
- service GameNotifications {
118
- option (service_description) = "A service for functions related to the asyncronous game notification server.";
119
-
120
- rpc UserCreateSession (.CGameNotifications_CreateSession_Request) returns (.CGameNotifications_CreateSession_Response) {
121
- option (method_description) = "Creates an async game session";
122
- }
123
-
124
- rpc UserDeleteSession (.CGameNotifications_DeleteSession_Request) returns (.CGameNotifications_DeleteSession_Response) {
125
- option (method_description) = "Deletes an async game session";
126
- }
127
-
128
- rpc UserUpdateSession (.CGameNotifications_UpdateSession_Request) returns (.CGameNotifications_UpdateSession_Response) {
129
- option (method_description) = "Updates an async game session";
130
- }
131
-
132
- rpc EnumerateSessions (.CGameNotifications_EnumerateSessions_Request) returns (.CGameNotifications_EnumerateSessions_Response) {
133
- option (method_description) = "Enumerates a user's sessions";
134
- }
135
-
136
- rpc GetSessionDetails (.CGameNotifications_GetSessionDetails_Request) returns (.CGameNotifications_GetSessionDetails_Response) {
137
- option (method_description) = "Get the details for a specific session";
138
- }
139
-
140
- rpc UpdateNotificationSettings (.CGameNotifications_UpdateNotificationSettings_Request) returns (.CGameNotifications_UpdateNotificationSettings_Response) {
141
- option (method_description) = "Updates whether a user allows game notifications for a specific app";
142
- }
143
- }
144
-
145
- service GameNotificationsClient {
146
- option (service_description) = "Client notifications";
147
- option (service_execution_site) = k_EProtoExecutionSiteSteamClient;
148
-
149
- rpc OnNotificationsRequested (.CGameNotifications_OnNotificationsRequested_Notification) returns (.NoResponse) {
150
- option (method_description) = "Requests that the user opt into notifications";
151
- }
152
-
153
- rpc OnUserStatusChanged (.CGameNotifications_OnUserStatusChanged_Notification) returns (.NoResponse) {
154
- option (method_description) = "Notification that the user's status has changed";
155
- }
156
- }
1
+ import "steammessages_base.proto";
2
+ import "steammessages_unified_base.steamclient.proto";
3
+
4
+ option cc_generic_services = true;
5
+
6
+ message CGameNotifications_Variable {
7
+ optional string key = 1 [(description) = "The name of the variable in the localized text -- anywhere that %variablename% is found within the text it will be substituded with the given value"];
8
+ optional string value = 2 [(description) = "The value of the variable to substitute in the localized text in place of the given variable. Can itself be a localization token."];
9
+ }
10
+
11
+ message CGameNotifications_LocalizedText {
12
+ optional string token = 1 [(description) = "A localization token that maps to the desired string."];
13
+ repeated .CGameNotifications_Variable variables = 2 [(description) = "A list of variables values to substitute in any variables found in the localized string."];
14
+ optional string rendered_text = 3 [(description) = "Text rendered in the requested language, complete with variable substitutions, if a language was specified."];
15
+ }
16
+
17
+ message CGameNotifications_UserStatus {
18
+ optional fixed64 steamid = 1 [(description) = "The specific user's steamid."];
19
+ optional string state = 2 [(description) = "The user's state. ready -- the user is ready to play. waiting -- The game is waiting on an action from the user. completed, the game is over."];
20
+ optional .CGameNotifications_LocalizedText title = 3 [(description) = "Title of the session to display to this user in their list of active sessions."];
21
+ optional .CGameNotifications_LocalizedText message = 4 [(description) = "Subtitle of the session to display to this user user within their list of active sessions."];
22
+ }
23
+
24
+ message CGameNotifications_CreateSession_Request {
25
+ optional uint32 appid = 1 [(description) = "The appid to create the session for."];
26
+ optional uint64 context = 2 [(description) = "Game-specified context value the game can used to associate the session with some object on their backend."];
27
+ optional .CGameNotifications_LocalizedText title = 3 [(description) = "The title of the session to be displayed within each user's list of sessions."];
28
+ repeated .CGameNotifications_UserStatus users = 4 [(description) = "The initial state of all users in the session."];
29
+ optional fixed64 steamid = 5 [(description) = "(Optional) steamid to make the request on behalf of -- if specified, the user must be in the session and all users being added to the session must be friends with the user."];
30
+ }
31
+
32
+ message CGameNotifications_CreateSession_Response {
33
+ optional uint64 sessionid = 1 [(description) = "The sessionid of the created session."];
34
+ }
35
+
36
+ message CGameNotifications_DeleteSession_Request {
37
+ optional uint64 sessionid = 1 [(description) = "The sessionid to delete."];
38
+ optional uint32 appid = 2 [(description) = "The appid of the session to delete."];
39
+ optional fixed64 steamid = 3 [(description) = "(Optional) steamid to make the request on behalf of -- if specified, the user must be in the session."];
40
+ }
41
+
42
+ message CGameNotifications_DeleteSession_Response {
43
+ }
44
+
45
+ message CGameNotifications_UpdateSession_Request {
46
+ optional uint64 sessionid = 1 [(description) = "The sessionid to update."];
47
+ optional uint32 appid = 2 [(description) = "The appid of the session to update."];
48
+ optional .CGameNotifications_LocalizedText title = 3 [(description) = "(Optional) The new title of the session. If not specified, the title will not be changed."];
49
+ repeated .CGameNotifications_UserStatus users = 4 [(description) = "(Optional) A list of users whose state will be updated to reflect the given state. If the users are not already in the session, they will be added to it."];
50
+ optional fixed64 steamid = 6 [(description) = "(Optional) steamid to make the request on behalf of -- if specified, the user must be in the session and all users being added to the session must be friends with the user."];
51
+ }
52
+
53
+ message CGameNotifications_UpdateSession_Response {
54
+ }
55
+
56
+ message CGameNotifications_EnumerateSessions_Request {
57
+ optional uint32 appid = 1 [(description) = "The sessionid to request details for. Optional. If not specified, all the user's sessions will be returned."];
58
+ optional bool include_all_user_messages = 3 [(description) = "(Optional) Boolean determining whether the message for all users should be included. Defaults to false."];
59
+ optional bool include_auth_user_message = 4 [(description) = "(Optional) Boolean determining whether the message for the authenticated user should be included. Defaults to false."];
60
+ optional string language = 5 [(description) = "(Optional) Language to localize the text in."];
61
+ }
62
+
63
+ message CGameNotifications_Session {
64
+ optional uint64 sessionid = 1 [(description) = "The sessionid for this session."];
65
+ optional uint64 appid = 2 [(description) = "The appid for the session."];
66
+ optional uint64 context = 3 [(description) = "Game-specified context value the game can used to associate the session with some object on their backend."];
67
+ optional .CGameNotifications_LocalizedText title = 4 [(description) = "The current title for the session."];
68
+ optional uint32 time_created = 5 [(description) = "The time the session was created."];
69
+ optional uint32 time_updated = 6 [(description) = "The last time the session was updated."];
70
+ repeated .CGameNotifications_UserStatus user_status = 7 [(description) = "The status of all the users in the session."];
71
+ }
72
+
73
+ message CGameNotifications_EnumerateSessions_Response {
74
+ repeated .CGameNotifications_Session sessions = 1 [(description) = "A list of the user's sessions."];
75
+ }
76
+
77
+ message CGameNotifications_GetSessionDetails_Request {
78
+ message RequestedSession {
79
+ optional uint64 sessionid = 1 [(description) = "The sessionid to get details for."];
80
+ optional bool include_auth_user_message = 3 [(description) = "(Optional) Boolean determining whether the message for the authenticated user should be included. Defaults to false."];
81
+ }
82
+
83
+ repeated .CGameNotifications_GetSessionDetails_Request.RequestedSession sessions = 1;
84
+ optional uint32 appid = 2 [(description) = "The appid for the sessions."];
85
+ optional string language = 3 [(description) = "Language to localize the text in."];
86
+ }
87
+
88
+ message CGameNotifications_GetSessionDetails_Response {
89
+ repeated .CGameNotifications_Session sessions = 1 [(description) = "The details of the session."];
90
+ }
91
+
92
+ message GameNotificationSettings {
93
+ optional uint32 appid = 1 [(description) = "The appid to create the session for."];
94
+ optional bool allow_notifications = 2 [(description) = "Whether the user allows notification for this app."];
95
+ }
96
+
97
+ message CGameNotifications_UpdateNotificationSettings_Request {
98
+ repeated .GameNotificationSettings game_notification_settings = 1;
99
+ }
100
+
101
+ message CGameNotifications_UpdateNotificationSettings_Response {
102
+ }
103
+
104
+ message CGameNotifications_OnNotificationsRequested_Notification {
105
+ optional fixed64 steamid = 1 [(description) = "steamid of the user who notifications were requested for."];
106
+ optional uint32 appid = 2 [(description) = "The appid that requested notifications."];
107
+ }
108
+
109
+ message CGameNotifications_OnUserStatusChanged_Notification {
110
+ optional fixed64 steamid = 1 [(description) = "steamid of the user whose status changed."];
111
+ optional uint64 sessionid = 2 [(description) = "The sessionid of the session where the user's status was changed."];
112
+ optional uint32 appid = 3 [(description) = "The appid of the session where the user's status changed."];
113
+ optional .CGameNotifications_UserStatus status = 4 [(description) = "(Optional) New status of the user."];
114
+ optional bool removed = 5 [(description) = "(Optional) User has been removed from the session."];
115
+ }
116
+
117
+ service GameNotifications {
118
+ option (service_description) = "A service for functions related to the asyncronous game notification server.";
119
+
120
+ rpc UserCreateSession (.CGameNotifications_CreateSession_Request) returns (.CGameNotifications_CreateSession_Response) {
121
+ option (method_description) = "Creates an async game session";
122
+ }
123
+
124
+ rpc UserDeleteSession (.CGameNotifications_DeleteSession_Request) returns (.CGameNotifications_DeleteSession_Response) {
125
+ option (method_description) = "Deletes an async game session";
126
+ }
127
+
128
+ rpc UserUpdateSession (.CGameNotifications_UpdateSession_Request) returns (.CGameNotifications_UpdateSession_Response) {
129
+ option (method_description) = "Updates an async game session";
130
+ }
131
+
132
+ rpc EnumerateSessions (.CGameNotifications_EnumerateSessions_Request) returns (.CGameNotifications_EnumerateSessions_Response) {
133
+ option (method_description) = "Enumerates a user's sessions";
134
+ }
135
+
136
+ rpc GetSessionDetails (.CGameNotifications_GetSessionDetails_Request) returns (.CGameNotifications_GetSessionDetails_Response) {
137
+ option (method_description) = "Get the details for a specific session";
138
+ }
139
+
140
+ rpc UpdateNotificationSettings (.CGameNotifications_UpdateNotificationSettings_Request) returns (.CGameNotifications_UpdateNotificationSettings_Response) {
141
+ option (method_description) = "Updates whether a user allows game notifications for a specific app";
142
+ }
143
+ }
144
+
145
+ service GameNotificationsClient {
146
+ option (service_description) = "Client notifications";
147
+ option (service_execution_site) = k_EProtoExecutionSiteSteamClient;
148
+
149
+ rpc OnNotificationsRequested (.CGameNotifications_OnNotificationsRequested_Notification) returns (.NoResponse) {
150
+ option (method_description) = "Requests that the user opt into notifications";
151
+ }
152
+
153
+ rpc OnUserStatusChanged (.CGameNotifications_OnUserStatusChanged_Notification) returns (.NoResponse) {
154
+ option (method_description) = "Notification that the user's status has changed";
155
+ }
156
+ }