getBreakoutRooms method

Future<DynamiteResponse<RoomGetBreakoutRoomsResponseApplicationJson, void>> getBreakoutRooms({
  1. required String token,
  2. RoomGetBreakoutRoomsApiVersion? apiVersion,
  3. bool? oCSAPIRequest,
})

Get breakout rooms.

All for moderators and in case of "free selection", or the assigned breakout room for other participants.

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:

  • apiVersion Defaults to v4.
  • token
  • oCSAPIRequest Required to be true for the API request to pass. Defaults to true.

Status codes:

  • 200: Breakout rooms returned
  • 400: Getting breakout rooms is not possible

See:

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

Implementation

Future<_i1.DynamiteResponse<RoomGetBreakoutRoomsResponseApplicationJson, void>> getBreakoutRooms({
  required String token,
  RoomGetBreakoutRoomsApiVersion? apiVersion,
  bool? oCSAPIRequest,
}) async {
  final rawResponse = getBreakoutRoomsRaw(
    token: token,
    apiVersion: apiVersion,
    oCSAPIRequest: oCSAPIRequest,
  );

  return rawResponse.future;
}