getParticipants method

Future<DynamiteResponse<RoomGetParticipantsResponseApplicationJson, RoomRoomGetParticipantsHeaders>> getParticipants({
  1. required String token,
  2. int? includeStatus,
  3. RoomGetParticipantsApiVersion? apiVersion,
  4. 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:

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

See:

Implementation

Future<DynamiteResponse<RoomGetParticipantsResponseApplicationJson, RoomRoomGetParticipantsHeaders>> getParticipants({
  required String token,
  int? includeStatus,
  RoomGetParticipantsApiVersion? apiVersion,
  bool? oCSAPIRequest,
}) async {
  final rawResponse = getParticipantsRaw(
    token: token,
    includeStatus: includeStatus,
    apiVersion: apiVersion,
    oCSAPIRequest: oCSAPIRequest,
  );

  return rawResponse.future;
}