aether_core
library
Classes
AppBuilder
AppDialog
AppHttpClient
AppHttpClientBase
Dio HTTP Wrapper with convenient, predictable exception handling.
AppInfo
AppService
AppSettings
BackgroundTransformer
The default Transformer for Dio .
BaseOptions
A set of base settings for each Dio()
.
BaseOptions and Options will be merged into one RequestOptions before
sending the requests. See Options.compose .
BinaryReader
The BinaryReader is used to bring data back from the binary format on the
disk.
BinaryWriter
The BinaryWriter is used to encode data to the binary format.
Bindings
Bindings should be extended or implemented.
When using GetMaterialApp
, all GetPage
s and navigation
methods (like Get.to()) have a binding
property that takes an
instance of Bindings to manage the
dependencies() (via Get.put()) for the Route you are opening.
BindingsBuilder <T >
Simplifies Bindings generation from a single callback.
To avoid the creation of a custom Binding instance per route.
Box <E >
Boxes contain all of your data. In the browser, each box has its own
IndexedDB database. On all other platforms, each Box is stored in a
separate file in the Hive home directory.
BoxBase <E >
Boxes contain all of your data. In the browser, each box has its own
IndexedDB database. On all other platforms, each Box is stored in a
seperate file in the Hive home directory.
BoxCollection
BoxEvent
A event representing a change in a box.
BrowserConfiguration
Additional configuration options for LaunchMode.inAppBrowserView
CancelToken
Controls cancellation of Dio 's requests.
CollectionBox <V >
represents a Box being part of a BoxCollection
Credential
CredentialService
CrossFileTestOverrides
Overrides some functions of CrossFile for testing purposes
Crypto
CustomTransition
Debug
DialogRequest <T >
DialogResponse <T >
The response returned from awaiting a call on the DialogService
DialogService
A DialogService that uses the Get package to show dialogs from the business logic
Dio
Dio enables you to make HTTP requests easily.
DioMixin
DisposableInterface
Entity
EnumSafeType
ErrorInterceptorHandler
The handler for interceptors to handle error occurred during the request.
FastList <T >
Field <T >
Example:
late final EntityField
FieldBase <T >
FilteringTextInputFormatters
FormData
A class to create readable "multipart/form-data" streams.
It can be used to submit forms and file uploads to http server.
FullLifeCycleController
FusedTransformer
A Transformer that has a fast path for decoding UTF8-encoded JSON.
If the response is utf8-encoded JSON and no custom decoder is specified in the RequestOptions , this transformer
is significantly faster than the default SyncTransformer and the BackgroundTransformer .
This improvement is achieved by using a fused Utf8Decoder and JsonDecoder to decode the response,
which is faster than decoding the utf8-encoded JSON in two separate steps, since
Dart uses a special fast decoder for this case.
See https://github.com/dart-lang/sdk/blob/5b2ea0c7a227d91c691d2ff8cbbeb5f7f86afdb9/sdk/lib/_internal/vm/lib/convert_patch.dart#L40
GetBar
GetBuilder <T extends GetxController >
GetBuilderState <T extends GetxController >
GetCupertinoApp
GetDelegate
GetInformationParser
GetInstance
GetInterface
GetInterface allows any auxiliary package to be merged into the "Get"
class through extensions
GetLifeCycle
GetMaterialApp
GetMaterialController
GetMicrotask
GetMiddleware
The Page Middlewares.
The Functions will be called in this order
(( redirect -> onPageCalled -> onBindingsStart ->
onPageBuildStart -> onPageBuilt -> onPageDispose ))
GetModalBottomSheetRoute <T >
GetNavConfig
This config enables us to navigate directly to a sub-url
GetNavigator
GetNotifier <T >
GetObserver
GetPage <T >
GetPlatform
GetQueue
GetResponsiveView <T >
Extend this widget to build responsive view.
this widget contains the screen
property that have all
information about the screen size and type.
You have two options to build it.
1- with builder
method you return the widget to build.
2- with methods desktop
, tablet
,phone
, watch
. the specific
method will be built when the screen type matches the method
when the screen is ScreenType.Tablet the tablet
method
will be exuded and so on.
Note if you use this method please set the
property alwaysUseBuilder
to false
With settings
property you can set the width limit for the screen types.
GetResponsiveWidget <T extends GetLifeCycleBase ? >
GetRouterOutlet
GetSnackBar
GetSnackBarState
GetSocket
GetStream <T >
GetStream is the lightest and most performative way of working
with events at Dart. You sintaxe is like StreamController, but it works
with simple callbacks. In this way, every event calls only one function.
There is no buffering, to very low memory consumption.
event add will add a object to stream. addError will add a error
to stream. listen is a very light StreamSubscription interface.
Is possible take the last value with value property.
GetStreamTransformation <T >
GetUtils
GetView <T >
GetView is a great way of quickly access your Controller
without having to call Get.find
GetWidget <S extends GetLifeCycleBase ? >
GetWidget is a great way of quickly access your individual Controller
without having to call Get.find
GetX <T extends DisposableInterface >
GetxController
GetxService
Unlike GetxController, which serves to control events on each of its pages,
GetxService is not automatically disposed (nor can be removed with
Get.delete()).
It is ideal for situations where, once started, that service will
remain in memory, such as Auth control for example. Only way to remove
it is Get.reset().
GetXState <T extends DisposableInterface >
GraphQLEntity <T extends Entity >
GraphQLQuery
The headers class for requests and responses.
HiveAesCipher
Default encryption algorithm. Uses AES256 CBC with PKCS7 padding.
HiveCipher
Abstract cipher can be implemented to customize encryption.
HiveCollection <E extends HiveObjectMixin >
List containing HiveObjectMixin s.
HiveField
Annotate all fields you want to persist with HiveField .
HiveInterface
The main API interface of Hive. Available through the Hive
constant.
HiveList <E extends HiveObjectMixin >
Allows defining references to other HiveObjectMixin s.
HiveObject
HiveType
Annotate classes with HiveType to generate a TypeAdapter
.
HttpClientAdapter
HttpAdapter
is a bridge between Dio and HttpClient .
InstanceInfo
Interceptor
Interceptor helps to deal with RequestOptions , Response ,
and DioException during the lifecycle of a request
before it reaches users.
Interceptors
A Queue-Model list for Interceptor s.
InterceptorsWrapper
A helper class to create interceptors in ease.
InternalFinalCallback <T >
Special callable class to keep the contract of a regular method, and avoid
overrides if you extend the class that uses it, as Dart has no final
methods.
Used in DisposableInterface
to avoid the danger of overriding onStart.
LazyBox <E >
LazyBox es don't keep the values in memory like normal boxes. Each time a
value is read, it is loaded from the backend.
LightSubscription <T >
ListField <E extends Entity >
Example:
late final EntityListField
ListParam <T >
Indicates a param being used as queries or form data,
and how does it gets formatted.
LogInterceptor
LogInterceptor is used to print logs during network requests.
It should be the last interceptor added,
otherwise modifications by following interceptors will not be logged.
This is because the execution of interceptors is in the order of addition.
MediaFile
MiddlewareRunner
MiniStream <T >
MiniSubscription <T >
MixinBuilder <T extends GetxController >
MultipartFile
A file to be uploaded as part of a MultipartRequest
. This doesn't need to
correspond to a physical file.
Node <T >
Obx
The simplest reactive widget in GetX.
ObxState
ObxValue <T extends RxInterface >
Similar to Obx, but manages a local state.
Pass the initial data in constructor.
Useful for simple local states, like toggles, visibility, themes,
button states, etc.
Sample:
ObxValue((data) => Switch(
value: data.value,
onChanged: (flag) => data.value = flag,
),
false.obs,
),
ObxWidget
The ObxWidget is the base for all GetX reactive widgets
Options
The configuration for a single request.
BaseOptions and Options will be merged into one RequestOptions before
sending the requests. See Options.compose .
OverlayRequest <T >
OverlayResponse <T >
PageInfo
Paging
PathDecoded
QueuedInterceptor
Interceptor in queue.
QueuedInterceptorsWrapper
A helper class to create queued-interceptors in ease.
RedirectRecord
A record that records the redirection happens during requests,
including status code, request method, and the location.
RequestInterceptorHandler
The handler for interceptors to handle before the request has been sent.
RequestOptions
The internal request option class that is the eventual result after
BaseOptions and Options are composed.
Response <T >
The Response class contains the payload (could be transformed)
that respond from the request, and other information of the response.
ResponseBody
The response wrapper class for adapters.
ResponseInterceptorHandler
The handler for interceptors to handle after respond.
ResponsiveScreen
ResponsiveScreenSettings
RestBody
RestQuery
RouterOutlet <TDelegate extends RouterDelegate <T > , T extends Object >
RouterOutletState <TDelegate extends RouterDelegate <T > , T extends Object >
Routing
Rx <T >
Foundation class used for custom Types
outside the common native Dart
types.
For example, any custom "Model" class, like User().obs will use Rx
as
wrapper.
RxBool
RxController
RxDouble
RxInt
RxInterface <T >
This class is the foundation for all reactive (Rx) classes that makes Get
so powerful.
This interface is the contract that _RxImpl]
RxList <E >
Create a list similar to List<T>
RxMap <K , V >
Rxn <T >
RxnBool
RxnDouble
RxnInt
RxnNum
RxNotifier <T >
RxnString
Rx class for String
Type.
RxNum
RxSet <E >
RxStatus
RxString
Rx class for String
Type.
SearchParams
SearchResults
SheetRequest <T >
SheetResponse <T >
The response returned from awaiting a call on the BottomSheetService
SimpleBuilder
SimpleBuilderState
SnackbarController
SnackbarService
A service that allows the user to show the snackbar from a ViewModel
SuperController <T >
SyncTransformer
If you want to custom the transformation of request/response data,
you can provide a Transformer by your self, and replace
the transformer by setting the Dio.transformer .
Transformer
Transformer allows changes to the request/response data before
it is sent/received to/from the server.
Translations
TrustedCertificate
TypeAdapter <T >
Type adapters can be implemented to support non primitive values.
TypeRegistry
TypeRegistries contain the TypeAdapter s associated with a typeId.
Uuid
uuid for Dart
Author: Yulian Kuncheff
Released under MIT License.
https://github.com/Daegalus/dart-uuid
Value <T >
ValueBuilder <T >
Manages a local state like ObxValue, but uses a callback instead of
a Rx value.
ValueBuilderState <T >
ValueTransformers
WebViewConfiguration
Additional configuration options for LaunchMode.inAppWebView .
Worker
Workers
XFile
A CrossFile is a cross-platform, simplified File abstraction.
XFileImage
Decodes the given XFile object as an image, associating it with the given
scale.
Enums
AppNetworkExceptionReason
Reason for a network exception.
ConnectivityResult
Connection status check result.
DialogPlatform
DioExceptionType
The exception enumeration indicates what type of exception
has happened during requests.
EasyLoadingIndicatorType
loading indicator type. see https://github.com/jogboms/flutter_spinkit#-showcase
HiveStorageBackendPreference
declares the preferred JS StorageBackend to be used
LaunchMode
The desired mode to launch a URL.
ListFormat
Specifies the array format (a single parameter with multiple parameter
or multiple parameters with the same name).
and the separator for array items.
PopMode
Enables the user to customize the intended pop behavior
PreventDuplicateHandlingMode
Enables the user to customize the behavior when pushing multiple routes that
shouldn't be duplicates
ResponseType
Indicates which transformation should be applied to the response data.
RowStyle
ScreenType
SmartManagement
GetX by default disposes unused controllers from memory,
Through different behaviors.
SmartManagement.full
SmartManagement.full is the default one. Dispose classes that are
not being used and were not set to be permanent. In the majority
of the cases you will want to keep this config untouched.
If you new to GetX then don't change this.
SmartManagement.onlyBuilder only controllers started in init:
or loaded into a Binding with Get.lazyPut() will be disposed. If you use
Get.put() or Get.putAsync() or any other approach, SmartManagement
will not have permissions to exclude this dependency. With the default
behavior, even widgets instantiated with "Get.put" will be removed,
unlike SmartManagement.onlyBuilders.
SmartManagement.keepFactory Just like SmartManagement.full,
it will remove it's dependencies when it's not being used anymore.
However, it will keep their factory, which means it will recreate
the dependency if you need that instance again.
SnackbarStatus
Indicates Status of snackbar
SnackbarStatus.OPEN Snack is fully open, SnackbarStatus.CLOSED Snackbar
has closed,
SnackbarStatus.OPENING Starts with the opening animation and ends
with the full
snackbar display, SnackbarStatus.CLOSING Starts with the closing animation
and ends
with the full snackbar dispose
SnackPosition
Indicates if snack is going to start at the TOP or at the BOTTOM
SnackStyle
Indicates if snack will be attached to the edge of the screen or not
Transition
Functions
ambiguate <T > (T? value )
→ T?
bodyBytesToString (Stream <List <int > > bodyBytes , Map <String , String > headers )
→ Future <String >
canLaunch (String urlString )
→ Future <bool >
Checks whether the specified URL can be handled by some app installed on the
device.
canLaunchUrl (Uri url )
→ Future <bool >
Checks whether the specified URL can be handled by some app installed on the
device.
closeInAppWebView ()
→ Future <void >
Closes the current in-app web view, if one was previously opened by
launchUrl .
closeWebView ()
→ Future <void >
Closes the current WebView, if one was previously opened via a call to launch .
debounce <T > (RxInterface <T > listener , WorkerCallback <T > callback , {Duration ? time , Function ? onError , void onDone ()?, bool ? cancelOnError })
→ Worker
debounce is similar to interval , but sends the last value.
Useful for Anti DDos, every time the user stops typing for 1 second,
for instance.
When listener
emits the last "value", when time
hits,
it calls callback
with the last "value" emitted.
defaultLogWriterCallback (String value , {bool isError = false })
→ void
default logger from GetX
ever <T > (RxInterface <T > listener , WorkerCallback <T > callback , {dynamic condition = true , Function ? onError , void onDone ()?, bool ? cancelOnError })
→ Worker
Called every time listener
changes. As long as the condition
returns true.
everAll (List <RxInterface > listeners , WorkerCallback callback , {dynamic condition = true , Function ? onError , void onDone ()?, bool ? cancelOnError })
→ Worker
Similar to ever , but takes a list of listeners
, the condition
for the callback
is common to all listeners
,
and the callback
is executed to each one of them. The Worker is
common to all, so worker.dispose()
will cancel all streams.
interval <T > (RxInterface <T > listener , WorkerCallback <T > callback , {Duration time = const Duration(seconds: 1) , dynamic condition = true , Function ? onError , void onDone ()?, bool ? cancelOnError })
→ Worker
Ignore all changes in listener
during time
(1 sec by default) or until
condition
is met (can be a bool expression or a bool Function()
),
It brings the 1st "value" since the period of time, so
if you click a counter button 3 times in 1 sec, it will show you "1"
(after 1 sec of the first press)
click counter 3 times in 1 sec, it will show you "4" (after 1 sec)
click counter 2 times in 1 sec, it will show you "7" (after 1 sec).
launch (String urlString , {bool ? forceSafariVC , bool forceWebView = false , bool enableJavaScript = false , bool enableDomStorage = false , bool universalLinksOnly = false , Brightness ? statusBarBrightness , String ? webOnlyWindowName })
→ Future <bool >
Parses the specified URL string and delegates handling of it to the
underlying platform.
launchEmail (String recipients , {String bcc = '' , String subject = '' , String body = '' , bool showError = false })
→ Future <void >
launchPhoneCall (String phoneNumber , {bool showError = false })
→ Future <void >
launchUrl (Uri url , {LaunchMode mode = LaunchMode.platformDefault , WebViewConfiguration webViewConfiguration = const WebViewConfiguration() , BrowserConfiguration browserConfiguration = const BrowserConfiguration() , String ? webOnlyWindowName })
→ Future <bool >
Passes url
to the underlying platform for handling.
once <T > (RxInterface <T > listener , WorkerCallback <T > callback , {dynamic condition = true , Function ? onError , void onDone ()?, bool ? cancelOnError })
→ Worker
once()
will execute only 1 time when condition
is met and cancel
the subscription to the listener
stream right after that.
condition
defines when callback
is called, and
can be a bool or a bool Function()
.
safeLaunchUri (Uri uri , {LaunchMode mode = LaunchMode.platformDefault , bool showError = false , String ? defaultErrorText })
→ Future <void >
safeLaunchUrl (String url , {LaunchMode mode = LaunchMode.platformDefault , bool showError = false , String ? defaultErrorText })
→ Future <void >
supportsCloseForLaunchMode (LaunchMode mode )
→ Future <bool >
Returns true if closeInAppWebView is supported for mode
in the current
platform implementation.
supportsLaunchMode (LaunchMode mode )
→ Future <bool >
Returns true if mode
is supported by the current platform implementation.
Typedefs
AddSubscription <T >
= FutureOr <void > Function(LightSubscription <T > subs )
AsyncInstanceBuilderCallback <S >
= Future <S > Function()
BindingBuilderCallback
= void Function()
CompactionStrategy
= bool Function(int entries , int deletedEntries )
A function which decides when to compact a box.
Computed <T >
= T Function()
Condition
= bool Function()
Decoder <T >
= T Function(dynamic data )
DefaultTransformer
= SyncTransformer
DialogBuilder
= Widget Function(BuildContext , DialogRequest , void (DialogResponse ) )
DioError
= DioException
DioError describes the exception info when a request failed.
DioErrorType
= DioExceptionType
Deprecated in favor of DioExceptionType and will be removed in future major versions.
DioMediaType
= MediaType
The type (alias) for specifying the content-type of the MultipartFile
.
EntityBuilder <E extends Entity >
= E Function()
GetControllerBuilder <T extends DisposableInterface >
= Widget Function(T controller )
GetPageBuilder
= Widget Function()
GetXControllerBuilder <T extends DisposableInterface >
= Widget Function(T controller )
The signature that iterates header fields.
HttpLibraryMethod <T >
= Future <Response <T > > Function()
A callback that returns a Dio response, presumably from a Dio method
it has called which performs an HTTP request, such as dio.get()
,
dio.post()
, etc.
InjectorBuilderCallback <S >
= S Function(GetInstance )
InstanceBuilderCallback <S >
= S Function()
InterceptorErrorCallback
= void Function(DioException error , ErrorInterceptorHandler handler )
The signature of Interceptor.onError .
InterceptorSendCallback
= void Function(RequestOptions options , RequestInterceptorHandler handler )
The signature of Interceptor.onRequest .
InterceptorSuccessCallback
= void Function(Response response , ResponseInterceptorHandler handler )
The signature of Interceptor.onResponse .
JsonDecodeCallback
= FutureOr Function(String )
The callback definition for decoding a JSON string.
JsonEncodeCallback
= FutureOr <String > Function(Object )
The callback definition for encoding a JSON object.
KeyComparator
= int Function(dynamic key1 , dynamic key2 )
LogWriterCallback
= void Function(String text , {bool isError })
VoidCallback from logs
NotifierBuilder <T >
= Widget Function(T state )
OnTap
= void Function(GetSnackBar snack )
PrintFunctionCallback
= void Function(String prefix , dynamic value , String info , {bool ? isError })
Progress
= dynamic Function(double percent )
ProgressCallback
= void Function(int count , int total )
The type of a progress listening callback when sending or receiving data.
RemoveSubscription <T >
= FutureOr <bool ? > Function(LightSubscription <T > subs )
RequestEncoder
= FutureOr <List <int > > Function(String request , RequestOptions options )
The type of a request encoding callback.
ResponseDecoder
= FutureOr <String ? > Function(List <int > responseBytes , RequestOptions options , ResponseBody responseBody )
The type of a response decoding callback.
ResponseExceptionMapper
= AppNetworkResponseException <Exception , dynamic > ? Function<T >(Response <T > , Exception )
Function which takes a Dio response object and an exception and returns
an optional AppHttpClientException , optionally mapping the response
to a custom exception.
SnackbarStatusCallback
= void Function(SnackbarStatus ? status )
ValidateStatus
= bool Function(int ? status )
The type of a response status code validate callback.
ValueBuilderBuilder <T >
= Widget Function(T snapshot , ValueBuilderUpdateCallback <T > updater )
ValueBuilderUpdateCallback <T >
= void Function(T snapshot )
ValueChanging <T >
= T Function(T value )
ValueTransform <T >
= T Function(dynamic value )
ValueUpdater <T >
= T Function()
WidgetCallback
= Widget Function()
WorkerCallback <T >
= dynamic Function(T callback )