$votePoll_Request method

@experimental Request $votePoll_Request({ required String token, required int pollId, BuiltList<int>? optionIds, PollVotePollApiVersion? apiVersion, bool? oCSAPIRequest, })

Vote on a poll.

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

Parameters:

• optionIds IDs of the selected options. Defaults to [].
• 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: Voted successfully
• 400: Voting is not possible
• 404: Poll not found

See:

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

Implementation

@_i2.experimental
_i3.Request $votePoll_Request({
  required String token,
  required int pollId,
  BuiltList<int>? optionIds,
  PollVotePollApiVersion? 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 $optionIds = _$jsonSerializers.serialize(optionIds, specifiedType: const FullType(BuiltList, [FullType(int)]));
  $optionIds ??= const [];
  _parameters['optionIds%5B%5D'] = $optionIds;

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

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