$closePoll_Request method

@experimental Request $closePoll_Request({ required String token, required int pollId, PollClosePollApiVersion? apiVersion, bool? oCSAPIRequest, })

Close a poll.

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

Parameters:

• apiVersion Defaults to "v1".
• token
• pollId ID of the poll.
• oCSAPIRequest Required to be true for the API request to pass. Defaults to true.

Status codes:

• 200: Poll closed successfully
• 400: Poll already closed
• 403: Missing permissions to close poll
• 404: Poll not found
• 500

See:

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

Implementation

@_i2.experimental
_i3.Request $closePoll_Request({
  required String token,
  required int pollId,
  PollClosePollApiVersion? apiVersion,
  bool? oCSAPIRequest,
}) {
  final _parameters = <String, Object?>{};
  final __token = _$jsonSerializers.serialize(token, specifiedType: const FullType(String));
  _i4.checkString(
    __token,
    'token',
    pattern: RegExp(r'^[a-z0-9]{4,30}$'),
  );
  _parameters['token'] = __token;

  final __pollId = _$jsonSerializers.serialize(pollId, specifiedType: const FullType(int));
  _i4.checkNumber(
    __pollId,
    'pollId',
    minimum: 0,
  );
  _parameters['pollId'] = __pollId;

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

  final _path = _i5.UriTemplate('/ocs/v2.php/apps/spreed/api/{apiVersion}/poll/{token}/{pollId}').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 = _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;
}