new RemoteRoom(identifier, dataopt)
Create a remote room.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
identifier |
string | The ID for this room | |
data |
Object |
<optional> |
The key-value data object to assign to this room. |
- Source:
Methods
get(key) → {*}
Get the data value for the given key.
Parameters:
| Name | Type | Description |
|---|---|---|
key |
string | An arbitrary bridge-specific key. |
- Source:
Returns:
Stored data for this key. May be undefined.
- Type
- *
getId() → {string}
Get the room ID.
- Source:
Returns:
The room ID
- Type
- string
serialize() → {Object}
Serialize all the data about this room, excluding the room ID.
- Source:
Returns:
The serialised data
- Type
- Object
set(key, val)
Set an arbitrary bridge-specific data value for this room.
Parameters:
| Name | Type | Description |
|---|---|---|
key |
string | The key to store the data value under. |
val |
* | The data value. This value should be serializable via
JSON.stringify(data). |
- Source: