|
There are two types of rooms: dynamic and persistent. Dynamic rooms are more common than persistent rooms.
Dynamic rooms are created at any time by a user or extension. A dynamic room is automatically removed when there are no more users in that room. A zone is removed when there are no more rooms in that zone.
Persistent rooms are created using the web-based administrator and always exist, which is the only differentiator from dynamic rooms.
Whether a room is persistent or dynamic, its properties are the same and assigned during the create process. Some of the properties can be modified at run-time.
Properties assigned during room creation:
| • | Zone name (string) - The name of the zone in which to create the room. If the zone does not exist, then it is created. |
| • | Room name (string) – A unique name that can be referenced by users or the server to identify the room. |
| • | Room description (string) – Optional text description of a room viewable by any user in the same zone. |
| • | Room capacity (integer) – The total number of users allowed to join the room. If set to -1 then there is no limit. |
| • | Room password (string) – A password used to secure the room. If a room has a password, then users must provide this to successfully join the room. |
| • | Hidden (boolean) – If hidden, the room does not show up in the room list for a zone. |
| • | Use flooding filter (boolean) – If true, a flooding filter is used in the room and these flooding filter properties are needed. See Flooding Filter for more details. |
| • | Use language filter (boolean) – If true, a language filter is used in the room and these language filter properties are needed. See Language Filter for more details. |
|