join_room

Join a RELAY room. If the room doesn't exist, it creates a new room.

Name	Type	Default	Description
join_roomRequired	object	-	An object that accepts the join_room parameters.

join_room Parameters

Name	Type	Description
nameRequired	string	Name of the room to join. Allowed characters: A-Za-z0-9_-

Variables

Set by the method:

• join_room_result: (out) joined | failed

Examples

Joining a room

YAML

version: 1.0.0
sections:
  main:
    - join_room:
        name: my_room

JSON

{
  "version": "1.0.0",
  "sections": {
    "main": [
      {
        "join_room": {
          "name": "my_room"
        }
      }
    ]
  }
}