$poll_Request method

  1. @experimental
Request $poll_Request({
  1. required ClientFlowLoginV2PollRequestApplicationJson $body,
})

Poll the login flow credentials.

Returns a DynamiteRequest backing the poll operation. Throws a DynamiteApiException if the API call does not return an expected status code.

Status codes:

  • 200: Login flow credentials returned
  • 404: Login flow not found or completed

See:

  • poll for a method executing this request and parsing the response.
  • $poll_Serializer for a converter to parse the Response from an executed this request.

Implementation

@_i2.experimental
_i3.Request $poll_Request({required ClientFlowLoginV2PollRequestApplicationJson $body}) {
  const _path = '/index.php/login/v2/poll';
  final _uri = Uri.parse('${_rootClient.baseURL}$_path');
  final _request = _i3.Request('post', _uri);
  _request.headers['Accept'] = 'application/json';
// coverage:ignore-start
  final authentication = _i4.IterableExtension(_rootClient.authentications)?.firstWhereOrNull(
    (auth) => switch (auth) {
      _i1.DynamiteHttpBearerAuthentication() || _i1.DynamiteHttpBasicAuthentication() => true,
      _ => false,
    },
  );

  if (authentication != null) {
    _request.headers.addAll(
      authentication.headers,
    );
  }

// coverage:ignore-end
  _request.headers['Content-Type'] = 'application/json';
  _request.body = json.encode(
    _$jsonSerializers.serialize($body, specifiedType: const FullType(ClientFlowLoginV2PollRequestApplicationJson)),
  );
  return _request;
}