SimTX API v24/Packets/CatalogUploadResult
Appearance
| Frame | {{{frame}}}, field {{{field}}}
|
|---|---|
| Member | {{{member}}}
|
| Direction | Server → client |
| Session | Control (catalog) |
| Roles | |
| Permission | None |
| Answers | CatalogUpload |
| Defined in |
|
CatalogUploadResult reports the outcome of a CatalogUpload.
Layout
| Field | Type | Description |
|---|---|---|
packetId |
u8 |
Always 21.
|
ok |
bool |
True if the entry was published. |
message |
UTF |
Uploaded for a new entry, Updated for a new revision, otherwise the reason for failure.
|
entryId |
i32 |
The entry's ID on success; −1 on failure. |
Typical failure messages
- Publishing requires catalog.publish
- This server has no catalog
- Unknown catalog item kind 'X'
- A preset is exactly one .stxpreset file
- An item named 'X' already exists (by Author)
- Catalog entry quota reached (32), Catalog storage quota reached, Server catalog storage is full
- Manifest validation messages, passed through verbatim.
Show the message to the user; it says what to fix.