start method

Future<DynamiteResponse<RecordingStartResponseApplicationJson, void>> start({ required int status, required String token, RecordingStartApiVersion? apiVersion, bool? oCSAPIRequest, })

Start 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:

• status Type of the recording.
• apiVersion Defaults to "v1".
• token
• oCSAPIRequest Required to be true for the API request to pass. Defaults to true.

Status codes:

• 200: Recording started successfully
• 400: Starting recording is not possible

See:

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

Implementation

Future<_i1.DynamiteResponse<RecordingStartResponseApplicationJson, void>> start({
  required int status,
  required String token,
  RecordingStartApiVersion? apiVersion,
  bool? oCSAPIRequest,
}) async {
  final _request = $start_Request(
    status: status,
    token: token,
    apiVersion: apiVersion,
    oCSAPIRequest: oCSAPIRequest,
  );
  final _response = await _rootClient.httpClient.send(_request);

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