flexideo

Požadavek send-message

Odeslání zprávy uživateli.

Pomocí následujících požadavků je možné odesílat zprávy mezi uživateli, kteří mají povolené přihlašování v live režimu. Pokud jsou tito uživatelé přihlášeni v live režimu, jsou jim zprávy doručovány automaticky. Pokud přihlášeni nejsou, jsou jim doručeny, jakmile se přihlásí.

V těle obsahuje HEX kódovanou data zprávy nebo obsahuje text v atr. msg

Jde o uzel obsahující text TYP HODNOTY: string;

syntax 
<request>
<send-message
to="{number}"
type="0|1"
msg="{string}"
avoid-join="{boolean}"
size="{number}"
>
 {string} 
</send-message>
</request>

Atributy

to - Číslo příjemce - User ID pro správnou identifikaci souboru nastavení (statistiky).(typ: number)

type - Typ zprávy - Číslo typu zprávy (0 - obecná, výchozí; 1 - dokument).(typ: number)

TYP HODNOTY: number;

Možnosti obsahu:

» 0 ~ (výchozí hodnota) označuje obecnou zprávu s prostým, nestrukturovaným textem;

» 1 ~ správa spojená s instancí a typem dokumentu; generuje se zejm. na základě uložení dokumentu s nastavením XDS typem messenger.

msg - Text zprávy - Textový obsah zprávy, pokud není v těle v HEX kódová.(typ: string) TYP HODNOTY: string;

avoid-join - Neslučovat zprávy - Zpráva se nebude spojovat s ostatními zprávami téhož typu, default je false, nastavení true umožní okamžité zpracování bez čekání na další zprávy;(typ: boolean) TYP HODNOTY: boolean;

size - Velikost těla - Určuje velikost (délku) datové části (obsahu uzlu send-message), není-li size uvedeno, datová část se ignoruje, je-li tento atribut uveden, jsou data chapána jako binární (kódovaná.(typ: number) TYP HODNOTY: number;


Potomci

Požadavek send-message neobsahuje žádné další elementy. Uzel může obsahovat prostý text.


Poznámka k request

Běžná zpráva je uložena jako obsah elementu send-message. Je-li toto tělo uvedeno, je hexadecimálně kódováno. Pokud nejde o běžnou zprávu, je uveden běžný znakový obsah.

Atribut type s hodnotou 1 je generován serverem v případě, že došlo k uložení dokumentu s vložením čísla cílového uživatele (příjemce zprávy) do prvku typu messenger. Odeslání zprávy je možné zařídit i automaticky při přidání nebo změně messenger prvku spolu s XML flexideo dokumentem.


Odpověď

Struktura odpovědi na požadavek send-message vrácená v obálce response:

syntax 
<response>
<element
type="ok|error"
detail="{string}"
to="{string}"
id="{number}"
recipient="online|offline"
/>
</response>

Atributy

type - Obsahuje hodnoty ok nebo error (možnosti obsahu: ok | error)

detail - Upřesnění - Bližší popis vzniklé chyby. Je k dispozici při odpovědi typu 'error'.(typ: string)

to - popis neuveden

id - Jedinečný celočíselný identifikátor položky.(typ: number)

recipient - Stav příjemce. - popis neuveden(typ: string)

TYP HODNOTY: string;

Možnosti obsahu:

» online ~ Příjemce je aktivní.

» offline ~ Příjemce není aktivní.


Potomci

Odpověď element neobsahuje žádné další elementy, ani žádné jiné číselné či řetězcové hodnoty.

Výraz pro identifikaci chyb v odpovědi serveru: send-message[@type='error'] (odkaz na popis detailu: @detail).


Poznámka k response

Atribut id obsahuje jedinečný identifikátor zprávy. Atribut to obsahuje přepis čísla uživatele příjemce ze vstupního požadavku.


Další info

Viz. též spouštění akcí pomocí zpráv.

Požadavek get-userPožadavek change-passwordPožadavek actionPožadavek send-requestPožadavek send-messagePožadavek confirm-messagePožadavek get-messagesPožadavek tranformPožadavek set-tempPožadavek get-tempPožadavek general-lockPožadavek encryptPožadavek decryptPožadavek max-keyPožadavek reload-sslPožadavek get-versionsPožadavek uuidPožadavek cnthashPožadavek rand