createPoll method

Future<DynamiteResponse<PollCreatePollResponseApplicationJson, void>> createPoll({ required String question, required BuiltList<String> options, required PollCreatePollResultMode resultMode, required int maxVotes, required String token, PollCreatePollApiVersion? apiVersion, bool? oCSAPIRequest, })

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

• question Question of the poll.
• options Options of the poll.
• resultMode Mode how the results will be shown.
• maxVotes Number of maximum votes per voter.
• apiVersion Defaults to "v1".
• token
• oCSAPIRequest Required to be true for the API request to pass. Defaults to true.

Status codes:

• 201: Poll created successfully
• 400: Creating poll is not possible

See:

• $createPoll_Request for the request send by this method.
• $createPoll_Serializer for a converter to parse the Response from an executed request.

Implementation

Future<_i1.DynamiteResponse<PollCreatePollResponseApplicationJson, void>> createPoll({
  required String question,
  required BuiltList<String> options,
  required PollCreatePollResultMode resultMode,
  required int maxVotes,
  required String token,
  PollCreatePollApiVersion? apiVersion,
  bool? oCSAPIRequest,
}) async {
  final _request = $createPoll_Request(
    question: question,
    options: options,
    resultMode: resultMode,
    maxVotes: maxVotes,
    token: token,
    apiVersion: apiVersion,
    oCSAPIRequest: oCSAPIRequest,
  );
  final _response = await _rootClient.httpClient.send(_request);

  final _serializer = $createPoll_Serializer();
  final _rawResponse =
      await _i1.ResponseConverter<PollCreatePollResponseApplicationJson, void>(_serializer).convert(_response);
  return _i1.DynamiteResponse.fromRawResponse(_rawResponse);
}