getBreakoutRoomParticipants method

Get the breakout room participants for a 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:

  • includeStatus Include the user statuses. Defaults to 0.
  • apiVersion Defaults to "v4".
  • token
  • oCSAPIRequest Required to be true for the API request to pass. Defaults to true.

Status codes:

  • 200: Breakout room participants returned
  • 400: Getting breakout room participants is not possible
  • 403: Missing permissions to get breakout room participants

See:

Implementation

Future<
    _i1.DynamiteResponse<RoomGetBreakoutRoomParticipantsResponseApplicationJson,
        RoomRoomGetBreakoutRoomParticipantsHeaders>> getBreakoutRoomParticipants({
  required String token,
  RoomGetBreakoutRoomParticipantsIncludeStatus? includeStatus,
  RoomGetBreakoutRoomParticipantsApiVersion? apiVersion,
  bool? oCSAPIRequest,
}) async {
  final _request = $getBreakoutRoomParticipants_Request(
    token: token,
    includeStatus: includeStatus,
    apiVersion: apiVersion,
    oCSAPIRequest: oCSAPIRequest,
  );
  final _response = await _rootClient.httpClient.send(_request);

  final _serializer = $getBreakoutRoomParticipants_Serializer();
  final _rawResponse = await _i1.ResponseConverter<RoomGetBreakoutRoomParticipantsResponseApplicationJson,
          RoomRoomGetBreakoutRoomParticipantsHeaders>(_serializer)
      .convert(_response);
  return _i1.DynamiteResponse.fromRawResponse(_rawResponse);
}