antenna_app library

Classes

Alerted
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.com/analytics/devguides/collection/ga4/reference/events
AndroidNotification
Android specific properties of a RemoteNotification.
AppleNotification
Apple specific properties of a RemoteNotification.
AppleNotificationSound
Represents the sound property for AppleNotification
AppStarted
AppState<T extends StatefulWidget>
Bidi
This provides utility methods for working with bidirectional text. All of the methods are static, and are organized into a class primarily to group them together for documentation and discoverability.
BidiFormatter
Bidi stands for Bi-directional text. According to Wikipedia: Bi-directional text is text containing text in both text directionalities, both right-to-left (RTL) and left-to-right (LTR). It generally involves text containing different types of alphabets, but may also refer to boustrophedon, which is changing text directionality in each row.
DateFormat
DateFormat is for formatting and parsing dates in a locale-sensitive manner.
DotEnv
EnvInitialized
FailureResponse
Firebase
The entry point for accessing Firebase.
FirebaseAnalytics
Firebase Analytics API.
FirebaseAnalyticsAndroid
Android-specific analytics API.
FirebaseAnalyticsObserver
A NavigatorObserver that sends events to Firebase Analytics when the currently active ModalRoute changes.
FirebaseApp
Represents a single Firebase app instance.
FirebaseMessaging
The FirebaseMessaging entry point.
FirebaseOptions
The options used to configure a Firebase app.
Intl
The Intl class provides a common entry point for internationalization related tasks. An Intl instance can be created for a particular locale and used to create a date format via anIntl.date(). Static methods on this class are also used in message formatting.
MessageListenerAttached
MessageReceived
MessagingInitialized
MicroMoney
Used primarily for currency formatting, this number-like class stores millionths of a currency unit, typically as an Int64.
NotificationSettings
Represents the devices notification settings.
NumberFormat
Provides the ability to format a number in a locale-specific way.
Parser
Creates key-value pairs from strings formatted as environment variable definitions.
RemoteMessage
A class representing a message sent from Firebase Cloud Messaging.
RemoteNotification
A class representing a notification which has been construted and sent to the device via FCM.
Response
RouteState<T extends StatefulWidget>
Store<T>
StoreConsumer<T>
SuccessResponse
TextDirection
Represents directionality of text.
WebNotification
Web specific properties of a RemoteNotification.

Enums

AndroidNotificationPriority
An enum representing a notification priority on Android.
AndroidNotificationVisibility
An enum representing the visibility level of a notification on Android.
AppleNotificationSetting
An enum representing a notification setting for this app on the device.
AppleShowPreviewSetting
An enum representing the show previews notification setting for this app on the device.
AuthorizationStatus
Represents the current status of the platforms notification permissions.

Mixins

AntennaMixin<T extends StatefulWidget>

Constants

androidNotificationChannel → const AndroidNotificationChannel
defaultFirebaseAppName → const String
The default Firebase application name.
secureStorage → const FlutterSecureStorage
valueAndCurrencyMustBeTogetherError → const String

Properties

dotenv DotEnv
Loads environment variables from a .env file.
getter/setter pair
flutterLocalNotificationsPlugin → FlutterLocalNotificationsPlugin
final
numberFormat NumberFormat
final

Functions

bootstrap({required FirebaseOptions firebaseOptions, required Iterable<Store> stores, required Iterable<Effect> effects, Effect? listener}) Future<void>
connectStore<T>(Store<T> store) StreamSubscription
createStore<T>(Reducer<T> reducer) Store<T>
defaultNameExtractor(RouteSettings settings) String?
defaultRouteFilter(Route? route) bool
delete<T>(String uri, {Map<String, String>? headers, required dynamic body}) Future<Response>
deleteAccessToken() → void
deleteRefreshToken() Future<void>
dispatch(dynamic event) → void
endpoint(String value) String
filterOutNulls(Map<String, Object?> parameters) Map<String, Object>
Creates a new map containing all of the key/value pairs from parameters except those whose value is null.
findAccessToken() String?
findRefreshToken() Future<String?>
get<T>(String uri, {Map<String, String>? headers}) Future<Response>
listenEffect(void eventListener(dynamic event)) StreamSubscription
multipart(String uri, {Map<String, String>? headers, required File file}) Future<Response>
patch<T>(String uri, {Map<String, String>? headers, required dynamic body}) Future<Response>
post<T>(String uri, {Map<String, String>? headers, required dynamic body}) Future<Response>
put<T>(String uri, {Map<String, String>? headers, required dynamic body}) Future<Response>
report(Object object) → void
saveAccessToken(String value) → void
saveRefreshToken(String value) Future<void>
showNotification(RemoteNotification notification) Future<void>
toBeginningOfSentenceCase(String? input, [String? locale]) String?
Convert a string to beginning of sentence case, in a way appropriate to the locale.
when<T>(Effect<T> effect) Effect

Typedefs

BackgroundMessageHandler = Future<void> Function(RemoteMessage message)
Defines a handler for incoming remote message payloads.
Effect<T> = void Function(T event)
Reducer<T> = T Function({dynamic event, T state})
RouteFilter = bool Function(Route? route)
RouteFilter allows to filter out routes that should not be tracked.
ScreenNameExtractor = String? Function(RouteSettings settings)
Signature for a function that extracts a screen name from RouteSettings.

Exceptions / Errors

FirebaseException
A generic class which provides exceptions in a Firebase-friendly format to users.