SimTX API/Packets/CatalogFetch: Difference between revisions
Clanker moved page SimTX API/Packets/CatalogFetch to SimTX API v24/Packets/CatalogFetch: Archive the v24 protocol reference Tag: New redirect |
Protocol v25 reference: CatalogFetch Tag: Removed redirect |
||
| Line 1: | Line 1: | ||
# | {{SimTX API navigation}} | ||
{{SimTX packet | |||
| name = CatalogFetch | |||
| frame = ClientFrame | |||
| field = 37 | |||
| member = catalog_fetch | |||
| direction = c2s | |||
| session = [[SimTX API/Extension catalog protocol|Control (catalog)]] | |||
| roles = <code>ROLE_CONTROL</code>. | |||
| permission = None | |||
| reply = [[SimTX API/Packets/CatalogEntry|CatalogEntry]] or [[SimTX API/Packets/Error|Error]] | |||
| group = catalog | |||
| file = control.proto | |||
}} | |||
'''CatalogFetch''' downloads one entry of the [[SimTX API/Extension catalog protocol|extension catalog]], including the contents of all its files. An unknown entry is answered with [[SimTX API/Packets/Error|Error]] <code>NOT_FOUND</code> (<i>That item is no longer in the catalog</i>). Heavy request; no permission needed. | |||
== Definition == | |||
<syntaxhighlight lang="protobuf"> | |||
message CatalogFetch { int64 request_id = 1; int32 entry_id = 2; } | |||
</syntaxhighlight> | |||
== Fields == | |||
{| class="wikitable" | |||
! # !! Field !! Type !! Description | |||
|- | |||
| 1 || <code>request_id</code> || <code>int64</code> || Nonzero; echoed in the [[SimTX API/Packets/CatalogEntry|CatalogEntry]] or [[SimTX API/Packets/Error|Error]]. | |||
|- | |||
| 2 || <code>entry_id</code> || <code>int32</code> || Entry ID from the [[SimTX API/Packets/CatalogList|CatalogList]]. | |||
|} | |||
== See also == | |||
* [[SimTX API/Packets/CatalogEntry|CatalogEntry]] | |||
{{SimTX API navbox}} | |||
[[Category:SimTX API]] | |||
Latest revision as of 16:44, 24 October 2026
| Frame | ClientFrame, field 37
|
|---|---|
| Member | catalog_fetch
|
| Direction | Client → server |
| Session | Control (catalog) |
| Roles | ROLE_CONTROL.
|
| Permission | None |
| Answered by | CatalogEntry or Error |
| Defined in | control.proto
|
CatalogFetch downloads one entry of the extension catalog, including the contents of all its files. An unknown entry is answered with Error NOT_FOUND (That item is no longer in the catalog). Heavy request; no permission needed.
Definition[edit | edit source]
message CatalogFetch { int64 request_id = 1; int32 entry_id = 2; }
Fields[edit | edit source]
| # | Field | Type | Description |
|---|---|---|---|
| 1 | request_id |
int64 |
Nonzero; echoed in the CatalogEntry or Error. |
| 2 | entry_id |
int32 |
Entry ID from the CatalogList. |