votePoll method
Future<DynamiteResponse<PollVotePollResponseApplicationJson, void> >
votePoll({
- required String token,
- required int pollId,
- BuiltList<
int> ? optionIds, - PollVotePollApiVersion? apiVersion,
- 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 totrue
.
Status codes:
- 200: Voted successfully
- 400: Voting is not possible
- 404: Poll not found
See:
- $votePoll_Request for the request send by this method.
- $votePoll_Serializer for a converter to parse the
Response
from an executed request.
Implementation
Future<_i1.DynamiteResponse<PollVotePollResponseApplicationJson, void>> votePoll({
required String token,
required int pollId,
BuiltList<int>? optionIds,
PollVotePollApiVersion? apiVersion,
bool? oCSAPIRequest,
}) async {
final _request = $votePoll_Request(
token: token,
pollId: pollId,
optionIds: optionIds,
apiVersion: apiVersion,
oCSAPIRequest: oCSAPIRequest,
);
final _response = await _rootClient.httpClient.send(_request);
final _serializer = $votePoll_Serializer();
final _rawResponse =
await _i1.ResponseConverter<PollVotePollResponseApplicationJson, void>(_serializer).convert(_response);
return _i1.DynamiteResponse.fromRawResponse(_rawResponse);
}