Function createBreakoutRoom

Parameters

• args: {
      data: string | number | string[];
      error?: Function;
      pattern?: BreakoutRoomAllocationPattern;
      success?: Function;
  }

  • data: string | number | string[]

    data: number | string | Array. Three types of parameters:

    • number : the number of rooms to create. The specified number of rooms will be created and the room will be automatically named.
    • string : the name of the room. The specified name of room will be created.
    • Array: list of room names. The specified rooms will be created.

  • Optional error?: Function

    Callback function in the event of an error.

  • Optional pattern?: BreakoutRoomAllocationPattern

    pattern BreakoutRoomAllocationPattern; How to assign the participants to the rooms. Default is Manually

    • BreakoutRoomAllocationPattern.auto: Distribute participants evenly to each room.

    • BreakoutRoomAllocationPattern.manually: Assign participants manually later.

    • BreakoutRoomAllocationPattern.selfSelect: Participants will choose the room to join.

    • Room List: success

    • Errors:

      • INVALID_OPERATION (breakout room has started!)
      • INVALID_PARAMETERS (exceed maximum size): maximum_size = 50; if support big rooms plan, up to 100

  • Optional success?: Function

    Callback function on success.