Požadavek confirm-message
Účel a dopady
Potvrdí přijetí zprávy (viz get-messages) – dokud zpráva není potvrzena, server ji doručuje znovu.
Dostupnost, kontext, oprávnění apod.
Dostupné každému přihlášenému uživateli pro vlastní frontu zpráv.
XML požadavek (syntax + popis)
<request>
<confirm-message
id="{number}"
/>
</request>
Parametry a pravidla (atributy, potomci)
id- Identifikátor potvrzované zprávy. (typ:number; povinný – chybí-li nebo se nepodaří převést na číslo, požadavek skončí chybou)
Požadavek nemá žádné potomky.
Příklady požadavku
(Zatím bez ověřeného příkladu.)
Zpracování a vedlejší účinky
Pokud přihlášený uživatel nemá inicializovanou frontu zpráv, požadavek selže bez ohledu na id.
XML odpověď (syntax + popis)
<response>
<confirm-message
type="ok|error"
id="{number}"
detail="{string}"
/>
</response>
Příklady odpovědi
(Zatím bez ověřeného příkladu.)
Chyby a reakce
type="error" id="{echo}" detail="ID zpravy se nepodarilo rozpoznat"–idchybí nebo je neplatné.type="error" id="{id}" detail="Uzivatel nema frontu zprav"– přihlášený uživatel nemá inicializovanou frontu zpráv.type="error" id="{id}" detail="Pri provadeni doslo k chybam"– potvrzení selhalo (pozor, množné číslo „chybám“); tato větev není sebeuzavírající a může nést vnořené error.
Související požadavky
- get-messages – příjem zpráv k potvrzení.
- send-message – odeslání zprávy.