votePoll method

Future<DynamiteResponse<PollVotePollResponseApplicationJson, void>> votePoll({
  1. required String token,
  2. required int pollId,
  3. BuiltList<int>? optionIds,
  4. PollVotePollApiVersion? apiVersion,
  5. bool? oCSAPIRequest,
})

Vote on a poll.

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:

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

Implementation

Future<DynamiteResponse<PollVotePollResponseApplicationJson, void>> votePoll({
  required String token,
  required int pollId,
  BuiltList<int>? optionIds,
  PollVotePollApiVersion? apiVersion,
  bool? oCSAPIRequest,
}) async {
  final rawResponse = votePollRaw(
    token: token,
    pollId: pollId,
    optionIds: optionIds,
    apiVersion: apiVersion,
    oCSAPIRequest: oCSAPIRequest,
  );

  return rawResponse.future;
}