$rejectShare_Request method

@experimental Request $rejectShare_Request({ required int id, FederationRejectShareApiVersion? apiVersion, bool? oCSAPIRequest, })

Decline a federation invites.

🚧 Draft: Still work in progress.

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

Parameters:

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

Status codes:

• 200: Invite declined successfully
• 404: Invite can not be found
• 400: Invite was already accepted, use the "Remove the current user from a room" endpoint instead

See:

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

Implementation

@_i2.experimental
_i3.Request $rejectShare_Request({
  required int id,
  FederationRejectShareApiVersion? apiVersion,
  bool? oCSAPIRequest,
}) {
  final _parameters = <String, Object?>{};
  final $id = _$jsonSerializers.serialize(id, specifiedType: const FullType(int));
  _i4.checkNumber(
    $id,
    'id',
    minimum: 0,
  );
  _parameters['id'] = $id;

  var $apiVersion =
      _$jsonSerializers.serialize(apiVersion, specifiedType: const FullType(FederationRejectShareApiVersion));
  $apiVersion ??= 'v1';
  _parameters['apiVersion'] = $apiVersion;

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

  if (authentication != null) {
    _request.headers.addAll(
      authentication.headers,
    );
  } else {
    throw Exception('Missing authentication for bearer_auth or basic_auth');
  }

// 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;
}