RoomApi (io.github.congcoi123:tenio 3.1.1 API)

java.lang.Object
- com.tenio.logger.AbstractLogger
- - com.tenio.api.RoomApi

```
public final class RoomApi
extends AbstractLogger
```
This class provides you a necessary interface for managing rooms.

Author:

kong

See Also:

IRoomManager

Constructor Summary

Constructors
Constructor Description

RoomApi(IRoomManager roomManager)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`add(AbstractRoom room)`	Add a new room to your server.
`boolean`	`contain(java.lang.String roomId)`	Determine if the room has existed or not.
`AbstractRoom`	`get(java.lang.String roomId)`	Retrieve a room by its ID.
`java.util.List<java.util.List<java.lang.Object>>`	`getAllRoomInfos()`
`java.util.Map<java.lang.String,AbstractRoom>`	`gets()`
`void`	`remove(AbstractRoom room)`	Remove a room from your server.

Methods inherited from class com.tenio.logger.AbstractLogger
buildgen, debug, error, info, info, info, info, info, info, info, info, strgen

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - RoomApi
```
public RoomApi(IRoomManager roomManager)
```
- Method Detail
  - gets
```
public java.util.Map<java.lang.String,AbstractRoom> gets()
```
    Returns:
    
    all the current rooms in your server
  - add
```
public void add(AbstractRoom room)
```
    Add a new room to your server. You need create your own room first.
    
    Parameters:
    
    room - that is added, see AbstractRoom
  - contain
```
public boolean contain(java.lang.String roomId)
```
    Determine if the room has existed or not.
    
    Parameters:
    
    roomId - the unique ID
    
    Returns:
    
    Returns true if the room has existed, null otherwise
  - get
```
public AbstractRoom get(java.lang.String roomId)
```
    Retrieve a room by its ID.
    
    Parameters:
    
    roomId - the unique ID
    
    Returns:
    
    Returns a room's instance if it has existed, null otherwise
  - remove
```
public void remove(AbstractRoom room)
```
    Remove a room from your server.
    
    Parameters:
    
    room - that is removed, see AbstractRoom
  - getAllRoomInfos
```
public java.util.List<java.util.List<java.lang.Object>> getAllRoomInfos()
```
    Returns:
    
    all rooms' information data