join_room

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

Parameters

Name	Type	Required?	Description
name	string	Required	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: my_room

JSON

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

Join a room and retry on failure

YAML

version: 1.0.0
sections:
  main:
    - join_room:
        name: my_room
    - play: "say: room ended with results %{join_room_result}"

JSON

{
  "version": "1.0.0",
  "sections": {
    "main": [
      {
        "join_room": {
          "name": "my_room"
        }
      },
      {
        "play": "say: room ended with results %{join_room_result}"
      }
    ]
  }
}