GraphQlClient class

GraphQlClient the main entry point client creation

This class is a singleton which ensues that the same object can be referenced multiple times in the app

Inheritance

Constructors

GraphQlClient(String idToken, String endpoint, String variant)

Properties

endpoint ↔ String
getter/setter pairinherited
hashCode → int
The hash code for this object.
no setterinherited
idToken ↔ String
getter/setter pairinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
variant ↔ String
getter/setter pairinherited

Methods

buildHeaders({bool authenticated = true, Map<String, String>? customHeaders}) → Map<String, String>
Constructs default request headers, optionally excluding the Authorization header
inherited
callRESTAPI({required String endpoint, required String method, Map<String, dynamic>? variables, Map<String, dynamic>? queryParams, Duration? timeout, Map<String, String>? customHeaders}) → Future<Response>
Makes an unauthenticated REST API call with the method passed
inherited
checkQueryString(String query) → bool
Checks if the provided query string is a valid GraphQL query.
inherited
clientIsValid() → bool
Validates the client instance.
inherited
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
Converts a dynamic URI or string to a Uri instance
inherited
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?
Parses error messages from a GraphQL response body.
inherited
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, {String? endpoint, Duration? timeout, Map<String, String>? customHeaders}) → Future<Response>
Sends a POST request with a timeout
inherited
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, {Duration? timeout, String? endpoint, Map<String, String>? customHeaders, bool isAuthenticated = true}) → Future<Response>
Executes a GraphQL query
inherited
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.
inherited
toMap(Response? response) → Map<String, dynamic>
Converts an HTTP response to a Map
inherited
toString() → String
A string representation of this object.
inherited
uploadMedia({required String endpoint, required Map<String, String> uploadHeaders, dynamic updateSink(StreamedRequest request)?, Duration? timeout}) → Future<Response>
Uploads media files to the specified endpoint.
inherited

Operators

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