APIClient class Null safety

Namebase API

  • Handles HTTP requests to the Namebase API
  • Provides a simple interface for accessing the Namebase API Required : API_KEY, API_SECRET
Inheritance

Constructors

APIClient({required String key, required String secret})
APIClient Constructor

Properties

allowAutoSignedCert bool
read / writeinherited
apiDnsEndpoint String
Endpoint for Nameserver DNS Settings
final
apiUrl String
Base Client Properties
final
authHeaders Map<String, String>
read-only
authorization String
Authorization Header
read-only
baseUrl String?
read / writeinherited
defaultContentType String
read / writeinherited
defaultDecoder Decoder?
read / writeinherited
findProxy ↔ (String Function(Uri url)?)
read / writeinherited
followRedirects bool
read / writeinherited
hashCode int
The hash code for this object.
read-onlyinherited
httpClient GetHttpClient
read-onlyinherited
initialized bool
Checks whether the controller has already been initialized.
read-onlyinherited
isClosed bool
Checks whether the controller has already been closed.
read-onlyinherited
isDisposed bool
read-onlyinherited
key String
Namebase API key
final
maxAuthRetries int
read / writeinherited
maxRedirects int
read / writeinherited
onDelete InternalFinalCallback<void>
Internal callback that starts the cycle of this controller.
finalinherited
onStart InternalFinalCallback<void>
Called at the exact moment the widget is allocated in memory. It uses an internal "callable" type, to avoid any @overrides in subclases. This method should be internal and is required to define the lifetime cycle of the subclass.
finalinherited
runtimeType Type
A representation of the runtime type of the object.
read-onlyinherited
secret String
Namebase API secret
final
sendUserAgent bool
read / writeinherited
sockets List<GetSocket>
read / writeinherited
timeout Duration
read / writeinherited
trustedCertificates List<TrustedCertificate>?
read / writeinherited
userAgent String
read / writeinherited
withCredentials bool
read / writeinherited

Methods

$configureLifeCycle() → void
inherited
addRecords(List<DNSRecord> records) Future<bool>
addRecords()
delete<T>(String url, {Map<String, String>? headers, String? contentType, Map<String, dynamic>? query, Decoder<T>? decoder}) Future<Response<T>>
inherited
deleteRecords(List<DNSRecord> records) Future<bool>
deleteRecords()
dispose() → void
inherited
get<T>(String url, {Map<String, String>? headers, String? contentType, Map<String, dynamic>? query, Decoder<T>? decoder}) Future<Response<T>>
inherited
mutation<T>(String mutation, {String? url, Map<String, dynamic>? variables, Map<String, String>? headers}) Future<GraphQLResponse<T>>
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed.
inherited
onClose() → void
Called before onDelete method. onClose might be used to dispose resources used by the controller. Like closing events, or streams before the controller is destroyed. Or dispose objects that can potentially create some memory leaks, like TextEditingControllers, AnimationControllers. Might be useful as well to persist some data on disk.
inherited
onInit() → void
Called immediately after the widget is allocated in memory. You might use this to initialize something for the controller.
inherited
onReady() → void
Called 1 frame after onInit(). It is the perfect place to enter navigation events, like snackbar, dialogs, or a new route, or async request.
inherited
patch<T>(String url, dynamic body, {String? contentType, Map<String, String>? headers, Map<String, dynamic>? query, Decoder<T>? decoder, Progress? uploadProgress}) Future<Response<T>>
inherited
post<T>(String? url, dynamic body, {String? contentType, Map<String, String>? headers, Map<String, dynamic>? query, Decoder<T>? decoder, Progress? uploadProgress}) Future<Response<T>>
inherited
put<T>(String url, dynamic body, {String? contentType, Map<String, String>? headers, Map<String, dynamic>? query, Decoder<T>? decoder, Progress? uploadProgress}) Future<Response<T>>
inherited
query<T>(String query, {String? url, Map<String, dynamic>? variables, Map<String, String>? headers}) Future<GraphQLResponse<T>>
query allow made GraphQL raw querys final connect = GetConnect(); connect.baseUrl = 'https://countries.trevorblades.com/'; final response = await connect.query( r""" { country(code: "BR") { name native currency languages { code name } } } """, ); print(response.body);
inherited
refresh() Future<NamebaseResponse>
refresh()
replaceRecord(DNSRecord record) Future<bool>
replaceRecord()
request<T>(String url, String method, {dynamic body, String? contentType, Map<String, String>? headers, Map<String, dynamic>? query, Decoder<T>? decoder, Progress? uploadProgress}) Future<Response<T>>
inherited
socket(String url, {Duration ping = const Duration(seconds: 5)}) GetSocket
inherited
toString() String
A string representation of this object.
inherited

Operators

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