addRoom - Addition of a room to the domain
XML request, sent by the client to the server
<protocol>
      <addRoom name="d25" 
               password="a22" 
               isPrivate="true" 
               isPermanent="true" 
               maxUsers="10" 
               category="a" 
               content="b" 
               languages="en" 
               [sid="2"] />
 </protocol>
                    
Attribute
Meaning
name
Name of the room we want to add to the domain.
password
Password for entry to the room.
isPrivate
Option distinguishing visible and hidden room.
isPermanent
Selection whether the room will be deleted after the client that created it has left. If we insert isPermanent="true", the room will not be deleted. If the room has the feature isPermanent="true", the variables created by the user will be deleted neither. However, if the founder of the room wants to delete the room, he, of course, can do so using the function delRoom.
maxUsers
The maximal number of clients that can be logged in the room. The adjustable value ranges from 2 to 50.
category
The category to which you can link this room. This attribute is only informative and for the XML Socket Multiuser Server is not any important.
content
A brief description of the room. This attribute is only informative and for the XML Socket Multiuser Server is not any important.
language
Language to be used in this room. This attribute is only informative and for the XML Socket Multiuser Server is not any important.
Note: Rooms can only be added to the domains where this action is enabled. Such a domain has to have maxRoomsPerUser>0 and maxRooms>0.
XML response of the server to the client
<protocol>
      <response action="addRoom" errorCode="0" [sid="2"]/>
</protocol>
                    
errorCode
Error description
101
To create new rooms is not allowed in the domain.
102
The value of maxRoomsPerUser or maxRooms was exceeded.
103
The variable name is not defined.
104
A room with this name already exists in the domain.
105
The message about creation of the room could not be sent to all clients.
XML message of the server to other clients
<protocol>
      <received action="addRoom" name="d27" sentFrom="test"/>
</protocol>
                        
Attribute
Meaning
name
Name of a new room.
sentFrom
Name of the client founding the room.
Note: Other clients logged in the domain will only receive the message in case the new room is public, it means isPrivate=false.
If the newly founded room is not public, other clients will not receive any message.