getParticipants method

Future<DynamiteResponse<RoomGetParticipantsResponseApplicationJson, RoomRoomGetParticipantsHeaders>> getParticipants({ required String token, RoomGetParticipantsApiVersion? apiVersion, RoomGetParticipantsIncludeStatus? includeStatus, bool? oCSAPIRequest, })

Get a list of 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: Participants returned
• 403: Missing permissions for getting participants

See:

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

Implementation

Future<_i1.DynamiteResponse<RoomGetParticipantsResponseApplicationJson, RoomRoomGetParticipantsHeaders>>
    getParticipants({
  required String token,
  RoomGetParticipantsApiVersion? apiVersion,
  RoomGetParticipantsIncludeStatus? includeStatus,
  bool? oCSAPIRequest,
}) async {
  final _request = $getParticipants_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 = $getParticipants_Serializer();
  return _i1.ResponseConverter<RoomGetParticipantsResponseApplicationJson, RoomRoomGetParticipantsHeaders>(
    _serializer,
  ).convert(_response);
}