addRoom - Přidání místnosti do domény
XML dotaz odeslaný klientem na server
<protocol>
      <addRoom name="d25" 
               password="a22" 
               isPrivate="true" 
               isPermanent="true" 
               maxUsers="10" 
               category="a" 
               content="b" 
               languages="en" 
               [sid="2"] />
 </protocol>
                    
Atribut
Význam
name
Jméno místnosti, kterou chceme do domény přidat.
password
Heslo pro přístup do místnosti.
isPrivate
Volba, zda místnost je nebo není viditelná.
isPermanent
Volba, zda bude místnost smazána po odhlášení uživatele, který místnost založil. Zadáme-li isPermanent="true", místnost nebude po odhlášení zakladatele místnosti smazána. Má-li místnost nastavenu vlastnost isPermanent="true", nebudou smazány ani proměnné, které uživatel v místnosti založil. Pokud ale uživatel, který místnost založil, bude chtít místnost sám smazat pomocí funkce delRoom, samozřejmě místnost smaže.
maxUsers
Maximální počet klientů, který se může do místnosti připojit. Hodnota, kterou můžete nastavit, se pohybuje od 2 do 50.
category
Kategorie, do které chcete zařadit tuto místnost. Tento atribut má pouze informativní charakter a pro práci XML Socket Multiuser Serveru není důležitý.
content
Stručný popis místnosti. Tento atribut má pouze informativní charakter a pro práci XML Socket Multiuser Serveru není důležitý.
language
Jazyk, kterým se v této místnosti bude komunikovat. Tento atribut má pouze informativní charakter a pro práci XML Socket Multiuser Serveru není důležitý.
Poznámka: Místnosti můžete přidávat pouze do domén, které mají povoleno přidávání místností. Taková doména musí mít nastaveno maxRoomsPerUser>0 a maxRooms>0.
XML odpověď serveru klientovi
<protocol>
      <response action="addRoom" errorCode="0" [sid="2"]/>
</protocol>
                    
errorCode
Popis chyby
101
V doméně není povoleno zakládat nové místnosti.
102
Byla překročena hodnota maxRoomsPerUser nebo maxRooms.
103
Není zadána proměnná name.
104
Místnost tohoto jména již v doméně existuje.
105
Nepodařilo se odeslat zprávu o založení místnosti všem klientům.
XML zpráva serveru ostatním klientům
<protocol>
      <received action="addRoom" name="d27" sentFrom="test"/>
</protocol>
                        
Atribut
Význam
name
Jméno nové místnosti.
sentFrom
Jméno klienta, který místnost založil.
Poznámka: Ostatní klienti přihlášení do domény dostanou zprávu pouze v případě, že nová místnost je veřejná, tj. isPrivate=false.
Pokud je nově založená místnost neveřejná, ostatní klienti žádnou zprávu neobdrží.