leaveCall method

Future<DynamiteResponse<CallLeaveCallResponseApplicationJson, void>> leaveCall({
  1. required String token,
  2. CallLeaveCallAll? all,
  3. CallLeaveCallApiVersion? apiVersion,
  4. bool? oCSAPIRequest,
})

Leave a call.

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:

  • all whether to also terminate the call for all participants. 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: Call left successfully
  • 404: Call session not found

See:

  • leaveCallRaw for an experimental operation that returns a DynamiteRawResponse that can be serialized.

Implementation

Future<_i1.DynamiteResponse<CallLeaveCallResponseApplicationJson, void>> leaveCall({
  required String token,
  CallLeaveCallAll? all,
  CallLeaveCallApiVersion? apiVersion,
  bool? oCSAPIRequest,
}) async {
  final rawResponse = leaveCallRaw(
    token: token,
    all: all,
    apiVersion: apiVersion,
    oCSAPIRequest: oCSAPIRequest,
  );

  return rawResponse.future;
}