stop method

Future<DynamiteResponse<RecordingStopResponseApplicationJson, void>> stop({ required String token, RecordingStopApiVersion? apiVersion, bool? oCSAPIRequest, })

Stop the recording.

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 "v1".
• token
• oCSAPIRequest Required to be true for the API request to pass. Defaults to true.

Status codes:

• 200: Recording stopped successfully
• 400: Stopping recording is not possible

See:

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

Implementation

Future<_i1.DynamiteResponse<RecordingStopResponseApplicationJson, void>> stop({
  required String token,
  RecordingStopApiVersion? apiVersion,
  bool? oCSAPIRequest,
}) async {
  final _request = $stop_Request(
    token: token,
    apiVersion: apiVersion,
    oCSAPIRequest: oCSAPIRequest,
  );
  final _response = await _rootClient.httpClient.send(_request);

  final _serializer = $stop_Serializer();
  final _rawResponse =
      await _i1.ResponseConverter<RecordingStopResponseApplicationJson, void>(_serializer).convert(_response);
  return _i1.DynamiteResponse.fromRawResponse(_rawResponse);
}