Skip to main content

join_room

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

NameTypeDefaultDescription
join_roomRequiredobject-An object that accepts the join_room parameters.

join_room Parameters

NameTypeDescription
nameRequiredstringName 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

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