getBreakoutRoomParticipants method

Future<DynamiteResponse<RoomGetBreakoutRoomParticipantsResponseApplicationJson, RoomRoomGetBreakoutRoomParticipantsHeaders>> getBreakoutRoomParticipants({ required String token, RoomGetBreakoutRoomParticipantsApiVersion? apiVersion, RoomGetBreakoutRoomParticipantsIncludeStatus? includeStatus, bool? oCSAPIRequest, })

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:

• apiVersion Defaults to "v4".
• token
• includeStatus Include the user statuses. Defaults to 0.
• 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:

• $getBreakoutRoomParticipants_Request for the request send by this method.
• $getBreakoutRoomParticipants_Serializer for a converter to parse the Response from an executed request.

Implementation

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

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