IGraphQlClient class abstract

IGraphQlClient is the blueprint of a valid GraphQL client. To construct a graphQL client, extend this class. This class provide out of the box implementation of client methods but they can be overridden. Best use case for overriding is when defining a mock client. Check mocks.dart for a concrete mocking implementation.

Implementers

Constructors

IGraphQlClient()

Properties

endpoint ↔ String
getter/setter pair
hashCode → int
The hash code for this object.
no setterinherited
idToken ↔ String
getter/setter pair
requestHeaders → Map<String, String>
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

callRESTAPI({required String endpoint, required String method, Map<String, dynamic>? variables}) → Future<Response>
callRESTAPI is used when making unauthenticated REST backend calls
checkQueryString(String query) → bool
clientIsValid() → bool
close() → void
Closes the client and cleans up any resources associated with it.
inherited
delete(Uri url, {Map<String, String>? headers, Object? body, Encoding? encoding}) → Future<Response>
Sends an HTTP DELETE request with the given headers to the given URL.
inherited
fromUriOrString(dynamic uri) → Uri
get(Uri url, {Map<String, String>? headers}) → Future<Response>
Sends an HTTP GET request with the given headers to the given URL.
inherited
Sends an HTTP HEAD request with the given headers to the given URL.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
parseError(Map<String, dynamic>? body) → String?
patch(Uri url, {Map<String, String>? headers, Object? body, Encoding? encoding}) → Future<Response>
Sends an HTTP PATCH request with the given headers and body to the given URL.
inherited
post(Uri url, {Map<String, String>? headers, Object? body, Encoding? encoding}) → Future<Response>
Sends an HTTP POST request with the given headers and body to the given URL.
inherited
postWithTimeout(Map<String, dynamic> bodyMap) → Future<Response>
put(Uri url, {Map<String, String>? headers, Object? body, Encoding? encoding}) → Future<Response>
Sends an HTTP PUT request with the given headers and body to the given URL.
inherited
query(String queryString, Map<String, dynamic> variables) → Future<Response>
read(Uri url, {Map<String, String>? headers}) → Future<String>
Sends an HTTP GET request with the given headers to the given URL and returns a Future that completes to the body of the response as a String.
inherited
readBytes(Uri url, {Map<String, String>? headers}) → Future<Uint8List>
Sends an HTTP GET request with the given headers to the given URL and returns a Future that completes to the body of the response as a list of bytes.
inherited
send(BaseRequest request) → Future<StreamedResponse>
Sends an HTTP request and asynchronously returns the response.
toMap(Response? response) → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited