base_core
library
Classes
AbstractConnectableStream <T , S extends Subject <T > , R extends Stream <T > >
Base class for implementations of ConnectableStream .
S is type of the forwarding Subject .
R is return type of autoConnect and refCount (type constraint: S extends R).
ActiveNotification
Details of an active notification.
AnalyticsCallOptions
Additional options that can be passed to Analytics method calls.
Note; these options are only used on the web.
AnalyticsEventItem
Interface that defines the required attributes of an analytics Item.
https://firebase.google.com/docs/reference/android/com/google/firebase/analytics/FirebaseAnalytics.Param
https://developers.google.cn/analytics/devguides/collection/ga4/reference/events
AndroidBitmap <T >
Represents a bitmap on Android.
AndroidFlutterLocalNotificationsPlugin
Android implementation of the local notifications plugin.
AndroidInitializationSettings
Plugin initialization settings for Android.
AndroidNotification
Android specific properties of a RemoteNotification .
AndroidNotificationAction
Mirrors the Action class in AndroidX.
AndroidNotificationActionInput
Mirrors the RemoteInput functionality available in NotificationCompat.
AndroidNotificationChannel
Settings for Android notification channels.
AndroidNotificationChannelGroup
A group of related Android notification channels.
AndroidNotificationDetails
Contains notification details specific to Android.
AndroidNotificationSound
Represents an Android notification sound.
AppleNotification
Apple specific properties of a RemoteNotification .
AppleNotificationSound
Represents the sound property for AppleNotification
AssetsLinuxIcon
Represents an icon from the Flutter Assets directory.
Currently the assets directory is data/flutter_assets
which is located on the path relative to the executable file.
AssetsLinuxSound
Represents a sound from the Flutter Assets directory.
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 .
BasePath <T >
Utility class to define a route path.
BehaviorSubject <T >
A special StreamController that captures the latest item that has been
added to the controller, and emits that as the first item to any new
listener.
BigPictureStyleInformation
Used to pass the content for an Android notification displayed using the
big picture style.
BigTextStyleInformation
Used to pass the content for an Android notification displayed using the
big text style.
BitmapFilePathAndroidIcon
Represents a file path to a bitmap that should be used for as an icon on
Android.
BufferCountStreamTransformer <T >
Buffers a number of values from the source Stream by count then
emits the buffer and clears it, and starts a new buffer each
startBufferEvery values. If startBufferEvery is not provided,
then new buffers are started immediately at the start of the source
and when each buffer closes and is emitted.
BufferStreamTransformer <T >
Creates a Stream where each item is a List containing the items
from the source sequence.
BufferTestStreamTransformer <T >
Creates a Stream where each item is a List containing the items
from the source sequence, batched whenever test passes.
ByteArrayAndroidBitmap
Represents a base64 encoded AndroidBitmap.
ByteArrayAndroidIcon
Represents a bitmap asset belonging to the Flutter application that should
be used for as an icon on Android.
ByteDataLinuxIcon
Represents an icon from a raw image data bytes, see LinuxRawIconData .
CancelToken
Controls cancellation of Dio 's requests.
CombineLatestStream <T , R >
Merges the given Streams into one Stream sequence by using the
combiner function whenever any of the source stream sequences emits an
item.
CompositeSubscription
Acts as a container for multiple subscriptions that can be canceled at once
e.g. view subscriptions in Flutter that need to be canceled on view disposal
ConcatEagerStream <T >
Concatenates all of the specified stream sequences, as long as the
previous stream sequence terminated successfully.
ConcatStream <T >
Concatenates all of the specified stream sequences, as long as the
previous stream sequence terminated successfully.
ConnectableStream <T >
A ConnectableStream resembles an ordinary Stream, except that it
can be listened to multiple times and does not begin emitting items when
it is listened to, but only when its connect method is called.
ConnectableStreamSubscription <T >
A special StreamSubscription that not only cancels the connection to
the source Stream , but also closes down a subject that drives the Stream.
Connectivity
Discover network connectivity configurations: Distinguish between WI-FI and cellular, check WI-FI status and more.
ConnectivityDriver
ConnectivityPlusLinuxPlugin
The Linux implementation of ConnectivityPlatform.
ConnectivityService
ContentUriAndroidIcon
Represents a content URI that should be used for as an icon on Android.
CrashLog
CustomController <E , S >
CustomDioLogger
CustomListenableBuilder <T , E , S >
CustomRouterObserver
DarwinInitializationSettings
Plugin initialization settings for Darwin-based operating systems
such as iOS and macOS
DarwinNotificationAction
Describes the notification action itself.
DarwinNotificationAttachment
Represents an attachment for a notification on Darwin-based operation
systems such as iOS and macOS
DarwinNotificationAttachmentThumbnailClippingRect
Represents the clipping rectangle used for the thumbnail image.
DarwinNotificationCategory
Corresponds to the UNNotificationCategory type which is used to configure
notification categories and accompanying options.
DarwinNotificationDetails
Configures notification details specific to Darwin-based operation systems
such as iOS and macOS
DatabaseEvent
DatabaseEvent encapsulates a DataSnapshot and possibly also the key of its
previous sibling, which can be used to order the snapshots.
DataNotification <T >
A notification representing a data event from a Stream .
DataSnapshot
A DataSnapshot contains data from a Firebase Database location.
Any time you read Firebase data, you receive the data as a DataSnapshot.
DateFormat
DebounceStreamTransformer <T >
Transforms a Stream so that will only emit items from the source sequence
if a window has completed, without the source sequence emitting
another item.
DefaultIfEmptyStreamTransformer <S >
Emit items from the source Stream , or a single default item if the source
Stream emits nothing.
DefaultStyleInformation
The default Android notification style.
DeferStream <T >
The defer factory waits until a listener subscribes to it, and then it
creates a Stream with the given factory function.
DelayStreamTransformer <S >
The Delay operator modifies its source Stream by pausing for
a particular increment of time (that you specify) before emitting
each of the source Stream’s items.
This has the effect of shifting the entire sequence of items emitted
by the Stream forward in time by that specified increment.
DelayWhenStreamTransformer <T >
Delays the emission of items from the source Stream by a given time span
determined by the emissions of another Stream .
DematerializeStreamTransformer <S >
Converts the onData, onDone, and onError StreamNotification objects from a
materialized stream into normal onData, onDone, and onError events.
DeviceInfoEntity
Dio
Dio enables you to make HTTP requests easily.
DioClientDriver
DioMixin
DistinctUniqueStreamTransformer <S >
Create a Stream which implements a HashSet under the hood, using
the provided equals as equality.
DoneNotification
A notification representing a done event from a Stream .
DoStreamTransformer <S >
Invokes the given callback at the corresponding point the the stream
lifecycle. For example, if you pass in an onDone callback, it will
be invoked when the stream finishes emitting items.
DrawableResourceAndroidBitmap
Represents a drawable resource belonging to the Android application that
should be used as a bitmap on Android.
DrawableResourceAndroidIcon
Represents a drawable resource belonging to the Android application that
should be used as an icon on Android.
Either <TLeft , TRight >
EndWithManyStreamTransformer <S >
Appends a sequence of values to the source Stream .
EndWithStreamTransformer <S >
Appends a value to the source Stream before closing.
Equatable
A base class to facilitate operator == and hashCode overrides.
ErrorAndStackTrace
An Object which acts as a tuple containing both an error and the
corresponding stack trace.
ErrorInterceptorHandler
The handler for interceptors to handle error occurred during the request.
ErrorNotification
A notification representing an error event from a Stream .
ExhaustMapStreamTransformer <S , T >
Converts events from the source stream into a new Stream using a given
mapper. It ignores all items from the source stream until the new stream
completes.
FilePathAndroidBitmap
Represents a file path that should be used for a bitmap on Android.
FilePathLinuxIcon
Represents an icon located at the path in the file system.
It сan be either an absolute UNIX path or a file:// URI scheme, for example:
FirebaseAnalytics
Firebase Analytics API.
FirebaseAnalyticsDriver
FirebaseAnalyticsObserver
A NavigatorObserver that sends events to Firebase Analytics when the
currently active ModalRoute changes.
FirebaseAnalyticsService
FirebaseAuth
The entry point of the Firebase Authentication SDK.
FirebaseAuthDriver
FirebaseAuthService
FirebaseCrashlytics
The entry point for accessing a FirebaseCrashlytics .
FirebaseCrashlyticsDriver
FirebaseCrashlyticsService
FirebaseDatabase
The entry point for accessing a Firebase Database. You can get an instance
by calling FirebaseDatabase.instance or FirebaseDatabase.instanceFor().
FirebaseDatabaseDriver
FirebaseDatabaseService
FirebaseDriver
FirebaseFirestore
The entry point for accessing a FirebaseFirestore .
FirebaseInAppMessaging
FirebaseMessaging
The FirebaseMessaging entry point.
FirebaseNotificationsDriver
FirebaseNotificationsService
FirebaseRemoteConfig
The entry point for accessing Remote Config.
FirebaseRemoteConfigDriver
FirebaseRemoteConfigService
FirebaseStorageDriver
FirebaseStorageService
FlatMapStreamTransformer <S , T >
Converts each emitted item into a new Stream using the given mapper function,
while limiting the maximum number of concurrent subscriptions to these Stream s.
The newly created Stream will be listened to and begin emitting items downstream.
FlutterBitmapAssetAndroidIcon
Represents a bitmap asset belonging to the Flutter application that should
be used for as an icon on Android.
FlutterLocalNotificationsPlatform
The interface that all implementations of flutter_local_notifications must
implement.
FlutterLocalNotificationsPlugin
Provides cross-platform functionality for displaying local notifications.
FlutterLocalNotificationsWindows
The Windows implementation of package:flutter_local_notifications.
ForkJoinStream <T , R >
This operator is best used when you have a group of streams
and only care about the final emitted value of each.
One common use case for this is if you wish to issue multiple
requests on page load (or some other event)
and only want to take action when a response has been received for all.
FormData
A class to create readable "multipart/form-data" streams.
It can be used to submit forms and file uploads to http server.
FromCallableStream <T >
Returns a Stream that, when listening to it, calls a function you specify
and then emits the value returned from that function.
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
GroupByStreamTransformer <T , K >
The GroupBy operator divides a Stream that emits items into
a Stream that emits GroupedStream ,
each one of which emits some subset of the items
from the original source Stream .
GroupedStream <T , K >
The Stream used by GroupByStreamTransformer , it contains events
that are grouped by a key value.
The headers class for requests and responses.
HttpClientAdapter
HttpAdapter is a bridge between Dio and HttpClient .
HttpDriverOptions
HttpDriverResponse
IAppTrackingDriver
IAppTrackingService
IConnectivityDriver
IConnectivityService
ICrashLogDriver
ICrashLogService
IDependencyManagerDriver
Utility class to manage dependencies
IFirebaseAnalyticsDriver
IFirebaseAnalyticsService
IFirebaseAuthDriver
IFirebaseAuthService
IFirebaseCrashlyticsService
IFirebaseDatabaseDriver
IFirebaseDatabaseService
IFirebaseDriver
IFirebaseNotificationsDriver
IFirebaseNotificationsService
IFirebaseRemoteConfigDriver
IFirebaseRemoteConfigService
IFirebaseStorageDriver
IFirebaseStorageService
IgnoreElementsStreamTransformer <S >
Creates a Stream where all emitted items are ignored, only the
error / completed notifications are passed
IHttpDriver
ILocalAuthDriver
ILocalAuthService
ILocalNotificationsDriver
ILocalNotificationsService
ILocationDriver
ILocationService
INavigationArgumentsDriver
Object that clusters all arguments and parameters retrieved or
produced during a route search.
INavigationDriver
Interface for navigation
InboxStyleInformation
Used to pass the content for an Android notification displayed using the
inbox style.
InitializationSettings
Settings for initializing the plugin for each platform.
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.
IntervalStreamTransformer <S >
Creates a Stream that emits each item in the Stream after a given
duration.
IOSFlutterLocalNotificationsPlugin
iOS implementation of the local notifications plugin.
IPermissionService
IPreferencesStorageDriver
IPreferencesStorageService
ISecureStorageDriver
ISecureStorageService
IShareDriver
IShareService
LinuxFlutterLocalNotificationsPlugin
A stub implementation to satisfy compilation of multi-platform packages that
depend on flutter_local_notifications_linux.
This should never actually be created.
LinuxInitializationSettings
Plugin initialization settings for Linux.
LinuxNotificationAction
Represents an action, that send a request message back to the notification
client when invoked. This functionality may not be implemented by the
notification server, conforming clients should check if it's available using
LinuxServerCapabilities .
For more information, please see Desktop Notifications Specification https://specifications.freedesktop.org/notification-spec/latest/ar01s02.html
LinuxNotificationDetails
Configures notification details specific to Linux.
The system may not support all features.
LinuxNotificationIcon
Represents Linux notification icon.
LinuxNotificationLocation
Represents the location on the screen that the notification should point to.
LinuxNotificationSound
Represents Linux notification sound.
LinuxNotificationTimeout
The timeout of the Linux notification.
LinuxRawIconData
Represents an icon in the raw image data.
LinuxServerCapabilities
Represents capabilities, implemented by the Linux notification server.
ListParam <T >
Indicates a param being used as queries or form data,
and how does it gets formatted.
LoadMock
LocalAuthDriver
LocalAuthService
LocalNotificationsDriver
LocalNotificationsService
LocationDriver
LocationService
LogEventEntity
LogEventModel
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.
MacOSFlutterLocalNotificationsPlugin
macOS implementation of the local notifications plugin.
MapNotNullStreamTransformer <T , R extends Object >
Create a Stream containing only the non-null results
of applying the given transform function to each element of the Stream.
MapToStreamTransformer <S , T >
Emits the given constant value on the output Stream every time the source
Stream emits a value.
MaskTextInputFormatter
MaterializeStreamTransformer <S >
Converts the onData, on Done, and onError events into StreamNotification
objects that are passed into the downstream onData listener.
MediaStyleInformation
Used to pass the content for an Android notification displayed using the
media style.
MergeStream <T >
Flattens the items emitted by the given streams into a single Stream
sequence.
Message
Represents a message used in Android messaging style notifications.
MessagingStyleInformation
Used to pass the content for an Android notification displayed using the
messaging style.
MsixUtils
Helpful methods to support MSIX and package identity.
MultipartFile
An upload content that is a part of MultipartRequest.
This doesn't need to correspond to a physical file.
NeverStream <T >
Returns a non-terminating stream sequence, which can be used to denote
an infinite duration.
NotificationAppLaunchDetails
Contains details on the notification that launched the application.
NotificationDetails
Contains notification details specific to each platform.
NotificationResponse
Details of a Notification Action that was triggered.
NotificationsEnabledOptions
Data class that represent current state of notification options.
NotificationSettings
Represents the devices notification settings.
NumberFormat
OnErrorResumeStreamTransformer <S >
Intercepts error events and switches to a recovery stream created by the
provided recoveryFn Function.
Options
The configuration for a single request.
BaseOptions and Options will be merged into one RequestOptions before
sending the requests. See Options.compose .
PackageInfo
Application metadata. Provides application bundle information on iOS and
application package information on Android.
PackageInfoEntity
PackageInfoModel
PackageInfoPlusLinuxPlugin
The Linux implementation of PackageInfoPlatform.
PackageInfoPlusWindowsPlugin
The Windows implementation of PackageInfoPlatform.
PairwiseStreamTransformer <T >
Emits the n-th and n-1th events as a pair.
The first event won't be emitted until the second one arrives.
PendingNotificationRequest
Details of a pending notification that has not been delivered.
Permission
Defines the permissions which can be checked and requested.
PermissionService
PermissionWithService
A special kind of permission, used to access a service.
Person
Details of a person e.g. someone who sent a message.
PositionEntity
PositionModel
PreferencesStorageDriver
PreferencesStorageService
PublishConnectableStream <T >
A ConnectableStream that converts a single-subscription Stream into
a broadcast Stream .
PublishSubject <T >
Exactly like a normal broadcast StreamController with one exception:
this class is both a Stream and Sink.
QueryParamsEntity
QuerySnapshotFiltersEntity
QueuedInterceptor
Interceptor in queue.
QueuedInterceptorsWrapper
A helper class to create QueuedInterceptor in ease.
RaceStream <T >
Given two or more source streams, emit all of the items from only
the first of these streams to emit an item or notification.
RangeStream
Returns a Stream that emits a sequence of Integers within a specified
range.
RawResourceAndroidNotificationSound
Represents a raw resource belonging to the Android application that should
be used for the notification sound.
ReceivedNotificationEntity
ReceivedNotificationModel
RedirectRecord
A record that records the redirection happens during requests,
including status code, request method, and the location.
RemoteConfigSettings
Defines the options for the corresponding Remote Config instance.
RemoteConfigUpdate
Used by Remote Config real-time config update service, this class represents changes between the newly fetched config and the current one.
RemoteConfigValue
RemoteConfigValue encapsulates the value and source of a Remote Config
parameter.
RemoteMessage
A class representing a message sent from Firebase Cloud Messaging.
RemoteNotification
A class representing a notification which has been constructed and sent to the
device via FCM.
RepeatStream <T >
Creates a Stream that will recreate and re-listen to the source
Stream the specified number of times until the Stream terminates
successfully.
ReplayConnectableStream <T >
A ConnectableStream that converts a single-subscription Stream into
a broadcast Stream that replays emitted items to any new listener, and
provides synchronous access to the list of emitted values.
ReplayStream <T >
An Stream that provides synchronous access to the emitted values
ReplaySubject <T >
A special StreamController that captures all of the items that have been
added to the controller, and emits those as the first items to any new
listener.
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.
RetryStream <T >
Creates a Stream that will recreate and re-listen to the source
Stream the specified number of times until the Stream terminates
successfully.
RetryWhenStream <T >
Creates a Stream that will recreate and re-listen to the source
Stream when the notifier emits a new value. If the source Stream
emits an error or it completes, the Stream terminates.
RouterObserver
Rx
A utility class that provides static methods to create the various Streams
provided by RxDart.
SampleStreamTransformer <T >
A StreamTransformer that, when the specified window Stream emits
an item or completes, emits the most recently emitted item (if any)
emitted by the source Stream since the previous emission from
the sample Stream .
ScanStreamTransformer <S , T >
Applies an accumulator function over an stream sequence and returns
each intermediate result. The seed value is used as the initial
accumulator value.
SecureStorageDriver
SecureStorageService
SequenceEqualStream <S , T >
Determine whether two Streams emit the same sequence of items.
You can provide an optional equals handler to determine equality.
SharedPreferences
Wraps NSUserDefaults (on iOS) and SharedPreferences (on Android), providing
a persistent store for simple data.
SharedPreferencesAsync
Provides a persistent store for simple data.
SharedPreferencesOptions
Basic options for creating SharedPreferencesAsync classes.
SharedPreferencesWithCache
Provides a persistent store for simple data.
SharedPreferencesWithCacheOptions
Options necessary to create a SharedPreferencesWithCache .
ShareDriver
ShareService
SkipLastStreamTransformer <T >
Skip the last count items emitted by the source Stream
SkipUntilStreamTransformer <S , T >
Starts emitting events only after the given stream emits an event.
StartWithManyStreamTransformer <S >
Prepends a sequence of values to the source Stream .
StartWithStreamTransformer <S >
Prepends a value to the source Stream .
StreamNotification <T >
A class that encapsulates the NotificationKind of event, value of the event in case of
onData, or the Error in the case of onError.
A container object that wraps the NotificationKind of event (OnData, OnDone, OnError),
and the item or error that was emitted. In the case of onDone, no data is
emitted as part of the StreamNotification .
StyleInformation
Abstract class for defining an Android notification style
Subject <T >
The base for all Subjects. If you'd like to create a new Subject,
extend from this class.
SwitchIfEmptyStreamTransformer <S >
When the original stream emits no items, this operator subscribes to
the given fallback stream and emits items from that stream instead.
SwitchLatestStream <T >
Convert a Stream that emits Stream s (aka a 'Higher Order Stream') into a
single Stream that emits the items emitted by the most-recently-emitted of
those Stream s.
SwitchMapStreamTransformer <S , T >
Converts each emitted item into a new Stream using the given mapper
function. The newly created Stream will be be listened to and begin
emitting items, and any previously created Stream will stop emitting.
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 .
TakeLastStreamTransformer <T >
Emits only the final count values emitted by the source Stream .
TakeUntilStreamTransformer <S , T >
Returns the values from the source stream sequence until the other
stream sequence produces a value.
TakeWhileInclusiveStreamTransformer <S >
Emits values emitted by the source Stream so long as each value
satisfies the given test. When the test is not satisfied by a value, it
will emit this value as a final event and then complete.
ThemeLinuxIcon
Represents a system theme icon.
See https://www.freedesktop.org/wiki/Specifications/icon-naming-spec/ for more help.
ThemeLinuxSound
Represents a system theme sound.
See https://www.freedesktop.org/wiki/Specifications/sound-theme-spec/ for more help.
ThrottleStreamTransformer <T >
A StreamTransformer that emits a value from the source Stream ,
then ignores subsequent source values while the window Stream is open,
then repeats this process.
TimeInterval <T >
A class that represents a snapshot of the current value emitted by a
Stream , at a specified interval.
TimeIntervalStreamTransformer <S >
Records the time interval between consecutive values in an stream
sequence.
TimerStream <T >
Emits the given value after a specified amount of time.
Timestamped <T >
A class that represents a snapshot of the current value emitted by a
Stream , at a specified timestamp.
TimestampStreamTransformer <S >
Wraps each item emitted by the source Stream in a Timestamped object
that includes the emitted item and the time when the item was emitted.
Transformer
Transformer allows changes to the request/response data before
it is sent/received to/from the server.
Unit
UriAndroidNotificationSound
Represents a URI on the Android device that should be used for the
notification sound.
UsingStream <T , R >
When listener listens to it, creates a resource object from resource factory function,
and creates a Stream from the given factory function and resource as argument.
Finally when the stream finishes emitting items or stream subscription
is cancelled (call StreamSubscription.cancel or Stream.listen(cancelOnError: true)),
call the disposer function on resource object.
The disposer is called after the future returned from StreamSubscription.cancel completes.
ValueConnectableStream <T >
A ConnectableStream that converts a single-subscription Stream into
a broadcast Stream that replays the latest value to any new listener, and
provides synchronous access to the latest emitted value.
ValueStream <T >
A Stream that provides synchronous access to the last emitted value (aka. data event).
WebNotification
Web specific properties of a RemoteNotification .
WhereNotNullStreamTransformer <T extends Object >
Create a Stream which emits all the non-null elements of the Stream,
in their original emission order.
WhereTypeStreamTransformer <S , T >
This transformer is a shorthand for Stream.where followed by Stream.cast .
WindowCountStreamTransformer <T >
Buffers a number of values from the source Stream by count then emits the
buffer as a Stream and clears it, and starts a new buffer each
startBufferEvery values. If startBufferEvery is not provided, then new
buffers are started immediately at the start of the source and when each
buffer closes and is emitted.
WindowsAction
A button in a Windows notification.
WindowsColumn
A vertical column of text and images in a Windows notification.
A header that groups multiple Windows notifications.
WindowsImage
An image in a Windows notification.
WindowsInitializationSettings
Plugin initialization settings for Windows.
WindowsInput
A text or multiple choice input element in a Windows notification.
WindowsNotificationAudio
Specifies custom audio to play during a notification.
WindowsNotificationDetails
Contains notification details specific to Windows.
WindowsNotificationPart
A text or image element in a Windows notification.
WindowsNotificationText
Text in a Windows notification.
WindowsProgressBar
A progress bar in a Windows notification.
WindowsRow
A group of notification content that must be displayed as a whole row.
WindowsSelection
An option that can be selected by a WindowsSelectionInput .
WindowsSelectionInput
A multiple choice input.
WindowsTextInput
A text input.
WindowStreamTransformer <T >
Creates a Stream where each item is a Stream containing the items
from the source sequence.
WindowTestStreamTransformer <T >
Creates a Stream where each item is a Stream containing the items
from the source sequence, batched whenever test passes.
WithLatestFromStreamTransformer <S , T , R >
A StreamTransformer that emits when the source stream emits, combining
the latest values from the two streams using the provided function.
ZipStream <T , R >
Merges the specified streams into one stream sequence using the given
zipper Function whenever all of the stream sequences have produced
an element at a corresponding index.
Extensions
AddToCompositeSubscriptionExtension
on StreamSubscription <T >
Extends the StreamSubscription class with the ability to be added to CompositeSubscription container.
BufferExtensions
on Stream <T >
Extends the Stream class with the ability to buffer events in various ways
ConcatExtensions
on Stream <T >
Extends the Stream class with the ability to concatenate one stream with
another.
ConnectableStreamExtensions
on Stream <T >
Extends the Stream class with the ability to transform a single-subscription
Stream into a ConnectableStream.
DebounceExtensions
on Stream <T >
Extends the Stream class with the ability to debounce events in various ways
DefaultIfEmptyExtension
on Stream <T >
DelayExtension
on Stream <T >
Extends the Stream class with the ability to delay events being emitted
DelayWhenExtension
on Stream <T >
Extends the Stream class with the ability to delay events being emitted.
DematerializeExtension
on Stream <StreamNotification <T > >
Converts the onData, onDone, and onError StreamNotification s from a
materialized stream into normal onData, onDone, and onError events.
DistinctUniqueExtension
on Stream <T >
Extends the Stream class with the ability to skip items that have previously
been emitted.
DoExtensions
on Stream <T >
Extends the Stream class with the ability to execute a callback function
at different points in the Stream's lifecycle.
EndWithExtension
on Stream <T >
Extends the Stream class with the ability to emit the given value as the
final item before closing.
EndWithManyExtension
on Stream <T >
Extends the Stream class with the ability to emit the given value as the
final item before closing.
ErrorAndStackTracesReplayStreamExtension
on ReplayStream <T >
Extension method on ReplayStream to access the emitted ErrorAndStackTrace s.
ErrorAndStackTraceValueStreamExtension
on ValueStream <T >
Extension method on ValueStream to access the last emitted ErrorAndStackTrace .
ExhaustMapExtension
on Stream <T >
Extends the Stream class with the ability to transform the Stream into
a new Stream. The new Stream emits items and ignores events from the source
Stream until the new Stream completes.
FlatMapExtension
on Stream <T >
Extends the Stream class with the ability to convert the source Stream into
a new Stream each time the source emits an item.
FuturePermissionStatusGetters
on Future <PermissionStatus >
Utility getter extensions for the Future<PermissionStatus> type.
FutureServiceStatusGetters
on Future <ServiceStatus >
Utility getter extensions for the Future<ServiceStatus> type.
GroupByExtension
on Stream <T >
Extends the Stream class with the ability to convert events into Streams
of events that are united by a key.
IgnoreElementsExtension
on Stream <T >
Extends the Stream class with the ability to skip, or ignore, data events.
IntervalExtension
on Stream <T >
Extends the Stream class with the ability to emit each item after a given
duration.
LastEventValueStreamExtensions
on ValueStream <T >
Extension methods on ValueStream related to lastEventOrNull .
MapNotNullExtension
on Stream <T >
Extends the Stream class with the ability to convert the source Stream
to a Stream containing only the non-null results
of applying the given transform function to each element of this Stream.
MapToExtension
on Stream <S >
Extends the Stream class with the ability to convert each item to the same
value.
MaterializeExtension
on Stream <T >
Extends the Stream class with the ability to convert the onData, on Done,
and onError events into StreamNotification s that are passed into the
downstream onData listener.
MaxExtension
on Stream <T >
Extends the Stream class with the ability to transform into a Future
that completes with the largest item emitted by the Stream.
MergeExtension
on Stream <T >
Extends the Stream class with the ability to merge one stream with another.
MinExtension
on Stream <T >
Extends the Stream class with the ability to transform into a Future
that completes with the smallest item emitted by the Stream.
OnErrorExtensions
on Stream <T >
Extends the Stream class with the ability to recover from errors in various
ways
PairwiseExtension
on Stream <T >
Extends the Stream class with the ability to emit the nth and n-1th events
as a pair
PermissionActions
on Permission
Actions that can be executed on a permission.
PermissionCheckShortcuts
on Permission
Shortcuts for checking the status of a Permission .
PermissionListActions
on List <Permission >
Actions that can be taken on a List of Permission s.
PermissionStatusGetters
on PermissionStatus
Utility getter extensions for the PermissionStatus type.
PermissionStatusTypeExt
on PermissionStatusType
SampleExtensions
on Stream <T >
Extends the Stream class with the ability to sample events from the Stream
ScanExtension
on Stream <T >
Extends
ServicePermissionActions
on PermissionWithService
Actions that apply only to permissions that have an associated service.
ServiceStatusGetters
on ServiceStatus
Utility getter extensions for the ServiceStatus type.
SkipLastExtension
on Stream <T >
Extends the Stream class with the ability to skip the last count items
emitted by the source Stream
SkipUntilExtension
on Stream <T >
Extends the Stream class with the ability to skip events until another
Stream emits an item.
SortingOrderTypeExt
on SortingOrderType
StartWithExtension
on Stream <T >
Extends the Stream class with the ability to emit the given value as the
first item.
StartWithManyExtension
on Stream <T >
Extends the Stream class with the ability to emit the given values as the
first items.
StreamNotificationExtensions
on StreamNotification <T >
Provides extension methods on StreamNotification .
StringExt
on String
SwitchIfEmptyExtension
on Stream <T >
Extend the Stream class with the ability to return an alternative Stream
if the initial Stream completes with no items.
SwitchMapExtension
on Stream <T >
Extends the Stream with the ability to convert one stream into a new Stream
whenever the source emits an item. Every time a new Stream is created, the
previous Stream is discarded.
TakeLastExtension
on Stream <T >
Extends the Stream class with the ability receive only the final count
events from the source Stream .
TakeUntilExtension
on Stream <T >
Extends the Stream class with the ability receive events from the source
Stream until another Stream produces a value.
TakeWhileInclusiveExtension
on Stream <T >
Extends the Stream class with the ability to take events while they pass
the condition given and include last event that doesn't pass the condition.
ThrottleExtensions
on Stream <T >
Extends the Stream class with the ability to throttle events in various ways
TimeIntervalExtension
on Stream <T >
Extends the Stream class with the ability to record the time interval
between consecutive values in an stream
TimeStampExtension
on Stream <T >
Extends the Stream class with the ability to wrap each item emitted by the
source Stream in a Timestamped object that includes the emitted item and
the time when the item was emitted.
WhereNotNullExtension
on Stream <T? >
Extends the Stream class with the ability to convert the source Stream
to a Stream which emits all the non-null elements
of this Stream, in their original emission order.
WhereTypeExtension
on Stream <T >
Extends the Stream class with the ability to filter down events to only
those of a specific type.
WindowExtensions
on Stream <T >
Extends the Stream class with the ability to window
WithLatestFromExtensions
on Stream <T >
Extends the Stream class with the ability to merge the source Stream with
the last emitted item from another Stream.
ZipWithExtension
on Stream <T >
Extends the Stream class with the ability to zip one Stream with another.
Constants
unit
→ const _Unit
Typedefs
BackgroundMessageHandler
= Future <void > Function(RemoteMessage message )
Defines a handler for incoming remote message payloads.
DefaultTransformer
= SyncTransformer
DidReceiveBackgroundNotificationResponseCallback
= void Function(NotificationResponse details )
Signature of callback triggered on background isolate when a user taps on a
notification or a notification action.
DidReceiveLocalNotificationCallback
= void Function(int id , String ? title , String ? body , String ? payload )
Signature of the callback that is triggered when a notification is shown
whilst the app is in the foreground.
DidReceiveNotificationResponseCallback
= void Function(NotificationResponse details )
Signature of callback triggered on main isolate when a user taps on a
notification or a notification action.
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.
The signature that iterates header fields.
HttpAccessToken
= String
HttpBaseUrl
= String Function()
HttpCallbackType <T >
= T Function()
HttpCustomerId
= String Function()
HttpDriverProgressCallback
= void Function(int count , int total )
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.
NetworkManagerClientFactory
= NetworkManagerClient Function()
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.
ValidateStatus
= bool Function(int ? status )
The type of a response status code validate callback.