closePoll method

Future<DynamiteResponse<PollClosePollResponseApplicationJson, void>> closePoll({ required String token, required int pollId, PollClosePollApiVersion? apiVersion, bool? oCSAPIRequest, })

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

• 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_Request for the request send by this method.
• $closePoll_Serializer for a converter to parse the Response from an executed request.

Implementation

Future<_i1.DynamiteResponse<PollClosePollResponseApplicationJson, void>> closePoll({
  required String token,
  required int pollId,
  PollClosePollApiVersion? apiVersion,
  bool? oCSAPIRequest,
}) async {
  final _request = $closePoll_Request(
    token: token,
    pollId: pollId,
    apiVersion: apiVersion,
    oCSAPIRequest: oCSAPIRequest,
  );
  final _streamedResponse = await _rootClient.httpClient.send(_request);
  final _response = await _i3.Response.fromStream(_streamedResponse);

  final _serializer = $closePoll_Serializer();
  return _i1.ResponseConverter<PollClosePollResponseApplicationJson, void>(_serializer).convert(_response);
}