SimTX API/Packets/CatalogDelete: Difference between revisions
Clanker moved page SimTX API/Packets/CatalogDelete to SimTX API v24/Packets/CatalogDelete: Archive the v24 protocol reference Tag: New redirect |
Protocol v25 reference: CatalogDelete Tag: Removed redirect |
||
| Line 1: | Line 1: | ||
# | {{SimTX API navigation}} | ||
{{SimTX packet | |||
| name = CatalogDelete | |||
| frame = ClientFrame | |||
| field = 39 | |||
| member = catalog_delete | |||
| direction = c2s | |||
| session = [[SimTX API/Extension catalog protocol|Control (catalog)]] | |||
| roles = <code>ROLE_CONTROL</code>, authenticated. | |||
| permission = <code>catalog.publish</code>, owner only | |||
| reply = [[SimTX API/Packets/CatalogDeleteResult|CatalogDeleteResult]] or [[SimTX API/Packets/Error|Error]] | |||
| group = catalog | |||
| file = control.proto | |||
}} | |||
'''CatalogDelete''' removes an entry from the [[SimTX API/Extension catalog protocol|extension catalog]]. Only the account that owns the entry can remove it. Refusals are answered with [[SimTX API/Packets/Error|Error]]: <code>FORBIDDEN</code> (<i>Only Author can remove this publication</i>, or no <code>catalog.publish</code>), <code>NOT_FOUND</code> (<i>That item is no longer in the catalog</i>), <code>UNAVAILABLE</code> or <code>INTERNAL</code>. | |||
== Definition == | |||
<syntaxhighlight lang="protobuf"> | |||
message CatalogDelete { 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/CatalogDeleteResult|CatalogDeleteResult]] or [[SimTX API/Packets/Error|Error]]. | |||
|- | |||
| 2 || <code>entry_id</code> || <code>int32</code> || ID of the entry to remove. | |||
|} | |||
== See also == | |||
* [[SimTX API/Packets/CatalogDeleteResult|CatalogDeleteResult]] | |||
{{SimTX API navbox}} | |||
[[Category:SimTX API]] | |||
Latest revision as of 16:44, 24 October 2026
| Frame | ClientFrame, field 39
|
|---|---|
| Member | catalog_delete
|
| Direction | Client → server |
| Session | Control (catalog) |
| Roles | ROLE_CONTROL, authenticated.
|
| Permission | catalog.publish, owner only
|
| Answered by | CatalogDeleteResult or Error |
| Defined in | control.proto
|
CatalogDelete removes an entry from the extension catalog. Only the account that owns the entry can remove it. Refusals are answered with Error: FORBIDDEN (Only Author can remove this publication, or no catalog.publish), NOT_FOUND (That item is no longer in the catalog), UNAVAILABLE or INTERNAL.
Definition[edit | edit source]
message CatalogDelete { int64 request_id = 1; int32 entry_id = 2; }
Fields[edit | edit source]
| # | Field | Type | Description |
|---|---|---|---|
| 1 | request_id |
int64 |
Nonzero; echoed in the CatalogDeleteResult or Error. |
| 2 | entry_id |
int32 |
ID of the entry to remove. |