getBreakoutRoomParticipants method

Future<DynamiteResponse<RoomGetBreakoutRoomParticipantsResponseApplicationJson, RoomRoomGetBreakoutRoomParticipantsHeaders>> getBreakoutRoomParticipants({
  1. required String token,
  2. int? includeStatus,
  3. RoomGetBreakoutRoomParticipantsApiVersion? apiVersion,
  4. 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:

  • 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<
    DynamiteResponse<RoomGetBreakoutRoomParticipantsResponseApplicationJson,
        RoomRoomGetBreakoutRoomParticipantsHeaders>> getBreakoutRoomParticipants({
  required String token,
  int? includeStatus,
  RoomGetBreakoutRoomParticipantsApiVersion? apiVersion,
  bool? oCSAPIRequest,
}) async {
  final rawResponse = getBreakoutRoomParticipantsRaw(
    token: token,
    includeStatus: includeStatus,
    apiVersion: apiVersion,
    oCSAPIRequest: oCSAPIRequest,
  );

  return rawResponse.future;
}