addParticipantToRoom method

Future<DynamiteResponse<RoomAddParticipantToRoomResponseApplicationJson, void>> addParticipantToRoom({
  1. required String newParticipant,
  2. required String token,
  3. RoomAddParticipantToRoomSource? source,
  4. RoomAddParticipantToRoomApiVersion? apiVersion,
  5. bool? oCSAPIRequest,
})

Add a participant to 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:

  • newParticipant New participant.
  • source Source of the participant. Defaults to users.
  • apiVersion Defaults to v4.
  • token
  • oCSAPIRequest Required to be true for the API request to pass. Defaults to true.

Status codes:

  • 200: Participant successfully added
  • 404: User, group or other target to invite was not found
  • 501: SIP dial-out is not configured
  • 400: Adding participant is not possible

See:

Implementation

Future<DynamiteResponse<RoomAddParticipantToRoomResponseApplicationJson, void>> addParticipantToRoom({
  required String newParticipant,
  required String token,
  RoomAddParticipantToRoomSource? source,
  RoomAddParticipantToRoomApiVersion? apiVersion,
  bool? oCSAPIRequest,
}) async {
  final rawResponse = addParticipantToRoomRaw(
    newParticipant: newParticipant,
    token: token,
    source: source,
    apiVersion: apiVersion,
    oCSAPIRequest: oCSAPIRequest,
  );

  return rawResponse.future;
}