switchBreakoutRoom method

Future<DynamiteResponse<BreakoutRoomSwitchBreakoutRoomResponseApplicationJson, void>> switchBreakoutRoom({
  1. required String target,
  2. required String token,
  3. BreakoutRoomSwitchBreakoutRoomApiVersion? apiVersion,
  4. bool? oCSAPIRequest,
})

Switch to another breakout room.

Returns a Future containing a DynamiteResponse with the status code, deserialized body and headers. Throws a DynamiteApiException if the API call does not return an expected status code.

Parameters:

  • target Target breakout room.
  • apiVersion Defaults to v1.
  • token
  • oCSAPIRequest Required to be true for the API request to pass. Defaults to true.

Status codes:

  • 200: Switched to breakout room successfully
  • 400: Switching to breakout room is not possible

See:

  • switchBreakoutRoomRaw for an experimental operation that returns a DynamiteRawResponse that can be serialized.

Implementation

Future<_i1.DynamiteResponse<BreakoutRoomSwitchBreakoutRoomResponseApplicationJson, void>> switchBreakoutRoom({
  required String target,
  required String token,
  BreakoutRoomSwitchBreakoutRoomApiVersion? apiVersion,
  bool? oCSAPIRequest,
}) async {
  final rawResponse = switchBreakoutRoomRaw(
    target: target,
    token: token,
    apiVersion: apiVersion,
    oCSAPIRequest: oCSAPIRequest,
  );

  return rawResponse.future;
}