$backend_Request method

  1. @experimental
Request $backend_Request({
  1. RecordingBackendApiVersion? apiVersion,
  2. bool? oCSAPIRequest,
})

Update the recording status as a backend.

Returns a DynamiteRequest backing the backend operation. Throws a DynamiteApiException if the API call does not return an expected status code.

Parameters:

  • apiVersion Defaults to "v1".
  • oCSAPIRequest Required to be true for the API request to pass. Defaults to true.

Status codes:

  • 200: Recording status updated successfully
  • 400: Updating recording status is not possible
  • 403: Missing permissions to update recording status
  • 404: Room not found

See:

  • backend for a method executing this request and parsing the response.
  • $backend_Serializer for a converter to parse the Response from an executed this request.

Implementation

@_i2.experimental
_i3.Request $backend_Request({
  RecordingBackendApiVersion? apiVersion,
  bool? oCSAPIRequest,
}) {
  final _parameters = <String, Object?>{};
  var __apiVersion =
      _$jsonSerializers.serialize(apiVersion, specifiedType: const FullType(RecordingBackendApiVersion));
  __apiVersion ??= 'v1';
  _parameters['apiVersion'] = __apiVersion;

  final _path = _i5.UriTemplate('/ocs/v2.php/apps/spreed/api/{apiVersion}/recording/backend').expand(_parameters);
  final _uri = Uri.parse('${_rootClient.baseURL}$_path');
  final _request = _i3.Request('post', _uri);
  _request.headers['Accept'] = 'application/json';
// coverage:ignore-start
  final authentication = _i6.IterableExtension(_rootClient.authentications)?.firstWhereOrNull(
    (auth) => switch (auth) {
      _i1.DynamiteHttpBearerAuthentication() || _i1.DynamiteHttpBasicAuthentication() => true,
      _ => false,
    },
  );

  if (authentication != null) {
    _request.headers.addAll(
      authentication.headers,
    );
  }

// coverage:ignore-end
  var __oCSAPIRequest = _$jsonSerializers.serialize(oCSAPIRequest, specifiedType: const FullType(bool));
  __oCSAPIRequest ??= true;
  _request.headers['OCS-APIRequest'] = const _i4.HeaderEncoder().convert(__oCSAPIRequest);

  return _request;
}