quick_flutter library

Classes

BaseListViewModel<T>

@author zavier @time 2021/4/15 10:22 @des

BaseOptions

The common config for the Dio instance. dio.options is a instance of BaseOptions

BaseView<T extends BaseViewModel>

@author zavier @time 2021/4/15 10:42 @des view 封装类

BaseViewModel

CancelToken

You can cancel a request by using a cancel token. One token can be shared with different requests. when a token's cancel method invoked, all requests with this token will be cancelled.

ChangeNotifierProvider<T extends ChangeNotifier?>

Listens to a ChangeNotifier, expose it to its descendants and rebuilds dependents whenever ChangeNotifier.notifyListeners is called.

ChangeNotifierProxyProvider<T, R extends ChangeNotifier?>

A ChangeNotifierProvider that builds and synchronizes a ChangeNotifier with external values.

ChangeNotifierProxyProvider0<R extends ChangeNotifier?>

A ChangeNotifierProvider that builds and synchronizes a ChangeNotifier with external values.

ChangeNotifierProxyProvider2<T, T2, R extends ChangeNotifier?>

A ChangeNotifierProvider that builds and synchronizes a ChangeNotifier with external values.

ChangeNotifierProxyProvider3<T, T2, T3, R extends ChangeNotifier?>

A ChangeNotifierProvider that builds and synchronizes a ChangeNotifier with external values.

ChangeNotifierProxyProvider4<T, T2, T3, T4, R extends ChangeNotifier?>

A ChangeNotifierProvider that builds and synchronizes a ChangeNotifier with external values.

ChangeNotifierProxyProvider5<T, T2, T3, T4, T5, R extends ChangeNotifier?>

A ChangeNotifierProvider that builds and synchronizes a ChangeNotifier with external values.

ChangeNotifierProxyProvider6<T, T2, T3, T4, T5, T6, R extends ChangeNotifier?>

A ChangeNotifierProvider that builds and synchronizes a ChangeNotifier with external values.

Consumer<T>

Obtains Provider<T> from its ancestors and passes its value to builder.

Consumer2<A, B>

Obtains Provider<T> from its ancestors and passes its value to builder.

Consumer3<A, B, C>

Obtains Provider<T> from its ancestors and passes its value to builder.

Consumer4<A, B, C, D>

Obtains Provider<T> from its ancestors and passes its value to builder.

Consumer5<A, B, C, D, E>

Obtains Provider<T> from its ancestors and passes its value to builder.

Consumer6<A, B, C, D, E, F>

Obtains Provider<T> from its ancestors and passes its value to builder.

DefaultHttpConfigImpl

默认的http配置,

DefaultTransformer

DeferredInheritedProvider<T, R>

An InheritedProvider where the object listened is not the object emitted.

Dio

A powerful Http client for Dart, which supports Interceptors, Global configuration, FormData, File downloading etc. and Dio is very easy to use.

DioMixin

DirectoryUtil

DirectoryUtil。

ErrorInterceptorHandler

Handler for error interceptor.

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)

FutureProvider<T>

Listens to a Future and exposes its result to child and its descendants.

Headers

Http

HttpClientAdapter

HttpAdapter is a bridge between Dio and HttpClient.

IHttpConfig

http配置

ImageUtil

Image Util.

InheritedContext<T>

A BuildContext associated to an InheritedProvider.

InheritedProvider<T>

A generic implementation of an InheritedWidget.

Interceptor

Dio instance may have interceptor(s) by which you can intercept requests/responses/errors before they are handled by then or catchError. See also:

Interceptors

Interceptors are a queue, and you can add any number of interceptors, All interceptors will be executed in first in first out order.

InterceptorsWrapper

InterceptorsWrapper is a helper class, which is used to conveniently create interceptor(s). See also:

IStateViewConfig

配置缺省页面

IToastConfig

ListenableProvider<T extends Listenable?>

Listens to a Listenable, expose it to its descendants and rebuilds dependents whenever the listener emits an event.

ListenableProxyProvider<T, R extends Listenable?>

A variation of ListenableProvider that builds its value from values obtained from other providers.

ListenableProxyProvider0<R extends Listenable?>

A variation of ListenableProvider that builds its value from values obtained from other providers.

ListenableProxyProvider2<T, T2, R extends Listenable?>

A variation of ListenableProvider that builds its value from values obtained from other providers.

ListenableProxyProvider3<T, T2, T3, R extends Listenable?>

A variation of ListenableProvider that builds its value from values obtained from other providers.

ListenableProxyProvider4<T, T2, T3, T4, R extends Listenable?>

A variation of ListenableProvider that builds its value from values obtained from other providers.

ListenableProxyProvider5<T, T2, T3, T4, T5, R extends Listenable?>

A variation of ListenableProvider that builds its value from values obtained from other providers.

ListenableProxyProvider6<T, T2, T3, T4, T5, T6, R extends Listenable?>

A variation of ListenableProvider that builds its value from values obtained from other providers.

ListParam<T>

Lock

Add lock/unlock API for interceptors.

LogConfig

LogInterceptor

LogInterceptor is used to print logs during network requests. It's better to add LogInterceptor to the tail of the interceptor queue, otherwise the changes made in the interceptor behind A will not be printed out. This is because the execution of interceptors is in the order of addition.

LogUtil

@author zavier @time 2021/4/14 13:41 @des 日志打印

MultipartFile

A file to be uploaded as part of a MultipartRequest. This doesn't need to correspond to a physical file.

MultiProvider

A provider that merges multiple providers into a single linear widget tree. It is used to improve readability and reduce boilerplate code of having to nest multiple layers of providers.

Options

Every request can pass an Options object which will be merged with Dio.options

Provider<T>

A Provider that manages the lifecycle of the value it provides by delegating to a pair of Create and Dispose.

ProviderBinding

ProxyProvider<T, R>

A provider that builds a value based on other providers.

ProxyProvider0<R>

A provider that builds a value based on other providers.

ProxyProvider2<T, T2, R>

A provider that builds a value based on other providers.

ProxyProvider3<T, T2, T3, R>

A provider that builds a value based on other providers.

ProxyProvider4<T, T2, T3, T4, R>

A provider that builds a value based on other providers.

ProxyProvider5<T, T2, T3, T4, T5, R>

A provider that builds a value based on other providers.

ProxyProvider6<T, T2, T3, T4, T5, T6, R>

A provider that builds a value based on other providers.

QueuedInterceptor

Serialize the request/response/error before they enter the interceptor.

QueuedInterceptorsWrapper

QueuedInterceptorsWrapper is a helper class, which is used to conveniently create QueuedInterceptor(s). See also:

QuickFlutter

ReassembleHandler

If you need your provider to be notified when 'Hot Reload' occurs, use this class

RedirectRecord

RequestInterceptorHandler

Handler for request interceptor.

RequestOptions

Response<T>

Response describes the http Response info.

ResponseBody

ResponseInterceptorHandler

Handler for response interceptor.

Selector<A, S>

An equivalent to Consumer that can filter updates by selecting a limited amount of values and prevent rebuild if they don't change.

Selector0<T>

A base class for custom Selector.

Selector2<A, B, S>

An equivalent to Consumer that can filter updates by selecting a limited amount of values and prevent rebuild if they don't change.

Selector3<A, B, C, S>

An equivalent to Consumer that can filter updates by selecting a limited amount of values and prevent rebuild if they don't change.

Selector4<A, B, C, D, S>

An equivalent to Consumer that can filter updates by selecting a limited amount of values and prevent rebuild if they don't change.

Selector5<A, B, C, D, E, S>

An equivalent to Consumer that can filter updates by selecting a limited amount of values and prevent rebuild if they don't change.

Selector6<A, B, C, D, E, F, S>

An equivalent to Consumer that can filter updates by selecting a limited amount of values and prevent rebuild if they don't change.

SharedPreferences

Wraps NSUserDefaults (on iOS) and SharedPreferences (on Android), providing a persistent store for simple data.

SpUtil

StreamProvider<T>

Listens to a Stream and exposes its content to child and descendants.

ToastStateFulState

State for _ToastStateFul

ToastUtil

Transformer

Transformer allows changes to the request/response data before it is sent/received to/from the server.

ValueListenableProvider<T>

Listens to a ValueListenable and exposes its current value.

ViewStateError

Enums

DioErrorType

ListFormat

ListFormat specifies the array format (a single parameter with multiple parameter or multiple parameters with the same name) and the separator for array items.

ResponseType

ResponseType indicates which transformation should be automatically applied to the response data by Dio.

StorageDirectory

Corresponds to constants defined in Androids android.os.Environment class.

Toast

Toast Length Only for Android Platform

ToastGravity

ToastGravity Used to define the position of the Toast on the screen

ViewState

ViewStateErrorType

错误类型

Mixins

OptionsMixin

Extensions

ReadContext on BuildContext

Exposes the read method.

SelectContext on BuildContext

Adds a select method on BuildContext.

WatchContext on BuildContext

Exposes the watch method.

Properties

disablePathProviderPlatformOverride ← bool

no getter

Functions

FToastBuilder() → TransitionBuilder

Simple builder method to create a TransitionBuilder and for the use in MaterialApp builder method

getApplicationCacheDirectory() → Future<Directory>

Path to a directory where the application may place application-specific cache files.

getApplicationDocumentsDirectory() → Future<Directory>

Path to a directory where the application may place data that is user-generated, or that cannot otherwise be recreated by your application.

getApplicationSupportDirectory() → Future<Directory>

Path to a directory where the application may place application support files.

getDownloadsDirectory() → Future<Directory?>

Path to the directory where downloaded files can be stored.

getExternalCacheDirectories() → Future<List<Directory>?>

Paths to directories where application specific cache data can be stored externally.

getExternalStorageDirectories({StorageDirectory? type}) → Future<List<Directory>?>

Paths to directories where application specific data can be stored externally.

getExternalStorageDirectory() → Future<Directory?>

Path to a directory where the application may access top level storage.

getLibraryDirectory() → Future<Directory>

Path to the directory where application can store files that are persistent, backed up, and not visible to the user, such as sqlite.db.

getTemporaryDirectory() → Future<Directory>

Path to the temporary directory on the device that is not backed up and is suitable for storing caches of downloaded files.

setInitDir({bool? initTempDir, bool? initAppDocDir, bool? initAppSupportDir, bool? initStorageDir}) → void

配置初始化Directory。

Typedefs

Create<T> = T Function(BuildContext context)

A function that creates an object of type T.

DeferredStartListening<T, R> = VoidCallback Function(InheritedContext<R> context, void setState(R value), T controller, R? value)

A callback used to handle the subscription of controller.

Dispose<T> = void Function(BuildContext context, T value)

A function that disposes an object of type T.

ErrorBuilder<T> = T Function(BuildContext context, Object? error)

A callback used to build a valid value from an error.

HeaderForEachCallback = void Function(String name, List<String> values)

InterceptorErrorCallback = void Function(DioError e, ErrorInterceptorHandler handler)

InterceptorSendCallback = void Function(RequestOptions options, RequestInterceptorHandler handler)

InterceptorSuccessCallback = void Function(Response e, ResponseInterceptorHandler handler)

JsonDecodeCallback = dynamic Function(String)

The default Transformer for Dio. If you want to custom the transformation of request/response data, you can provide a Transformer by your self, and replace the DefaultTransformer by setting the dio.Transformer.

Locator = T Function<T>()

A generic function that can be called to read providers, without having a reference on BuildContext.

PositionedToastBuilder = Widget Function(BuildContext context, Widget child)

Signature for a function to buildCustom Toast

ProgressCallback = void Function(int count, int total)

Callback to listen the progress for sending/receiving data.

ProviderBuilder<R> = Widget Function(BuildContext context, R value, Widget child)

ProxyProviderBuilder<T, R> = R Function(BuildContext context, T value, R? previous)

ProxyProviderBuilder2<T, T2, R> = R Function(BuildContext context, T value, T2 value2, R? previous)

ProxyProviderBuilder3<T, T2, T3, R> = R Function(BuildContext context, T value, T2 value2, T3 value3, R? previous)

ProxyProviderBuilder4<T, T2, T3, T4, R> = R Function(BuildContext context, T value, T2 value2, T3 value3, T4 value4, R? previous)

ProxyProviderBuilder5<T, T2, T3, T4, T5, R> = R Function(BuildContext context, T value, T2 value2, T3 value3, T4 value4, T5 value5, R? previous)

ProxyProviderBuilder6<T, T2, T3, T4, T5, T6, R> = R Function(BuildContext context, T value, T2 value2, T3 value3, T4 value4, T5 value5, T6 value6, R? previous)

RequestEncoder = List<int> Function(String request, RequestOptions options)

ResponseDecoder = String Function(List<int> responseBytes, RequestOptions options, ResponseBody responseBody)

ShouldRebuild<T> = bool Function(T previous, T next)

Used by providers to determine whether dependents needs to be updated when the value exposed changes

StartListening<T> = VoidCallback Function(InheritedContext<T> element, T value)

A callback used to start the listening of an object and return a function that cancels the subscription.

UpdateShouldNotify<T> = bool Function(T previous, T current)

A function that returns true when the update from previous to current should notify listeners, if any.

ValidateStatus = bool Function(int? status)

Exceptions / Errors

DioError

DioError describes the error info when request failed.

MissingPlatformDirectoryException

An exception thrown when a directory that should always be available on the current platform cannot be obtained.

NoNetWorkException

NotSuccessException

接口的code没有返回为true的异常

ProviderNotFoundException

The error that will be thrown if Provider.of fails to find a Provider as an ancestor of the BuildContext used.

UnAuthorizedException

用于未登录等权限不够,需要跳转授权页面