master_utility library

Classes

AlertDialogAction<T>
Used for specifying showAlertDialog's actions.
APIConstError
ApiException
APIRequest
APIResponse<T>
APIService
AppNetworkImage
AutoText
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.
CancelToken
Controls cancellation of Dio's requests.
DatabaseLogarteEntry
DateTimeHelper
DebouncerHelper
DialogHelper
Dio
Dio enables you to make HTTP requests easily.
DioClient
DioMixin
DismissKeyboard
DoubleClickReduntHelper
EmailDisposeHelper
EmailDisposerResModel
EncryptionHelper
This class provides helper methods for encrypting and decrypting data using the Advanced Encryption Standard (AES) algorithm.
EncryptionService
ErrorHandler
ErrorInterceptorHandler
The handler for interceptors to handle error occurred during the request.
FilePicker
The interface that implementations of file_picker must implement.
Fluttertoast
Plugin to show a toast message on screen Only for android, ios and Web platforms
FormData
A class to create readable "multipart/form-data" streams. It can be used to submit forms and file uploads to http server.
FToast
Runs on dart side this has no interaction with the Native Side Works with all platforms just in two lines of code final fToast = FToast().init(context) fToast.showToast(child)
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
Headers
The headers class for requests and responses.
HttpClientAdapter
HttpAdapter is a bridge between Dio and HttpClient.
ImagePickerHelper
To use In IOS add this code in project_directory/ios/Runner/info.plist
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 Interceptors.
InterceptorsWrapper
A helper class to create interceptors in ease.
IntlPhoneField
IntlPhoneFieldState
JWTHelper
JwtHeroInterceptor
Intercepts HTTP requests to handle JWT token management.
JwtToken
A class that represents a JWT token.
KeyboardOverlay
ListParam<T>
Indicates a param being used as queries or form data, and how does it gets formatted.
Logarte
LogarteDashboardScreen
LogarteDioInterceptor
LogarteEntry
LogarteMagicalTap
A widget that detects taps and shows the Logarte widget when the user
LogarteNavigatorObserver
LogHelper
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.
MasterUtilityMaterialApp
MixPanelEventModel
MixPanelService
MultipartFile
An upload content that is a part of MultipartRequest. This doesn't need to correspond to a physical file.
NetworkLogarteEntry
NetworkRequestLogarteEntry
NetworkResponseLogarteEntry
Options
The configuration for a single request. BaseOptions and Options will be merged into one RequestOptions before sending the requests. See Options.compose.
PermissionHandlerService
PlainLogarteEntry
PreferenceHelper
This class provides helper methods to access and store data in the device's shared preferences storage. The data is encrypted before storing it in the shared preferences
PreferenceServiceHelper
QueuedInterceptor
Interceptor in queue.
QueuedInterceptorsWrapper
A helper class to create QueuedInterceptor in ease.
ReadMoreTextHelper
ReadMoreTextHelperState
RedirectRecord
A record that records the redirection happens during requests, including status code, request method, and the location.
RefreshTokenConfiguration
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.
SessionManager
Manages the session status of the user.
SheetAction<T>
Used for specifying showModalActionSheet's actions.
SizeHelper
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.
ToastHelper
ToastStateFulState
State for _ToastStateFul
TokenStorage
The interface for token storage.
Transformer
Transformer allows changes to the request/response data before it is sent/received to/from the server.
ValidationHelper

Enums

CameraDevice
Which camera to use when picking images/videos while source is ImageSource.camera.
DateTimeFormatter
DioExceptionType
The exception enumeration indicates what type of exception has happened during requests.
FileAccessMode
The file access mode when downloading a file, corresponds to a subset of dart:io::FileMode.
FilePickerStatus
FileType
IconPosition
ListFormat
Specifies the array format (a single parameter with multiple parameter or multiple parameters with the same name). and the separator for array items.
MethodType
OkCancelResult
PermissionType
PickerActionType
ResponseType
Indicates which transformation should be applied to the response data.
SessionStatus
The session status enum.
StatusCode<T extends int>
Toast
Toast Length Only for Android Platform
ToastGravity
ToastGravity Used to define the position of the Toast on the screen
ToastType
TrimMode

Mixins

OptionsMixin
The mixin class for options that provides common attributes.

Extensions

AlertDialogActionEx on AlertDialogAction<T>
AlertDialogActionListEx on List<AlertDialogAction<T>>
DateTimeExtension on DateTime
Extension for DateTime Extension for DateTime
MapEncryption on Map
SizerDouble on num

Constants

defaultDialogTitle → const String

Properties

abbrMonth ↔ String
getter/setter pair
abbrMonthDay ↔ String
getter/setter pair
abbrMonthWeekdayDay ↔ String
getter/setter pair
abbrQuarter ↔ String
getter/setter pair
abbrStandaloneMonth ↔ String
getter/setter pair
abbrWeekday ↔ String
getter/setter pair
days ↔ String
getter/setter pair
dioClient ↔ DioClient
getter/setter pair
hour ↔ String
getter/setter pair
hour24 ↔ String
getter/setter pair
hour24Minute ↔ String
getter/setter pair
hour24MinuteSecond ↔ String
getter/setter pair
hourMinute ↔ String
getter/setter pair
hourMinuteSecond ↔ String
getter/setter pair
monthDay ↔ String
getter/setter pair
months ↔ String
getter/setter pair
monthWeekdayDay ↔ String
getter/setter pair
numMonth ↔ String
getter/setter pair
numMonthDay ↔ String
getter/setter pair
numMonthWeekdayDay ↔ String
getter/setter pair
quarter ↔ String
getter/setter pair
standaloneMonth ↔ String
getter/setter pair
weekday ↔ String
getter/setter pair
yearAbbrMonth ↔ String
getter/setter pair
yearAbbrMonthDay ↔ String
getter/setter pair
yearAbbrMonthWeekdayDay ↔ String
getter/setter pair
yearAbbrQuarter ↔ String
getter/setter pair
yearMonth ↔ String
getter/setter pair
yearMonthDay ↔ String
getter/setter pair
yearMonthWeekdayDay ↔ String
getter/setter pair
yearNumMonth ↔ String
getter/setter pair
yearNumMonthDay ↔ String
getter/setter pair
yearNumMonthWeekdayDay ↔ String
getter/setter pair
yearQuarter ↔ String
getter/setter pair
years ↔ String
getter/setter pair

Functions

defaultDioExceptionReadableStringBuilder(DioException e) → String
The default implementation of building a readable string of DioException.
FToastBuilder() → TransitionBuilder
Simple builder method to create a TransitionBuilder and for the use in MaterialApp builder method

Typedefs

CustomErrorMapper<T> = APIResponse<T> Function(Response response)
Error Mapper
DefaultTransformer = SyncTransformer
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.
DioExceptionReadableStringBuilder = String Function(DioException e)
The readable string builder's signature of DioException.readableStringBuilder.
DioMediaType = MediaType
The type (alias) for specifying the content-type of the MultipartFile.
HeaderForEachCallback = void Function(String name, List<String> values)
The signature that iterates header fields.
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.
JsonMapper<T> = T Function(Map<String, dynamic>)
generic json mapper
ListJsonMapper<T> = T Function(List)
generic list json mapper
PositionedToastBuilder = Widget Function(BuildContext context, Widget child, ToastGravity? gravity)
Signature for a function to buildCustom Toast
ProgressCallback = void Function(int count, int total)
The type of a progress listening callback when sending or receiving data.
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.
ResponseMapper = JwtToken Function(dynamic responseData)
ToastPositionMapping = Widget? Function(Widget child, ToastGravity? gravity)
Signature for a function that defines custom position mapping for a toast
ValidateStatus = bool Function(int? status)
The type of a response status code validate callback.

Exceptions / Errors

DioException
DioException describes the exception info when a request failed.
NotNullableError<T>
A TypeError thrown by _checkNotNullable.