createPoll method

Future<DynamiteResponse<PollCreatePollResponseApplicationJson, void>> createPoll({
  1. required String question,
  2. required BuiltList<String> options,
  3. required PollCreatePollResultMode resultMode,
  4. required int maxVotes,
  5. required String token,
  6. PollCreatePollApiVersion? apiVersion,
  7. 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:

  • createPollRaw for an experimental operation that returns a DynamiteRawResponse that can be serialized.

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 rawResponse = createPollRaw(
    question: question,
    options: options,
    resultMode: resultMode,
    maxVotes: maxVotes,
    token: token,
    apiVersion: apiVersion,
    oCSAPIRequest: oCSAPIRequest,
  );

  return rawResponse.future;
}