masamune library

An application development framework centered on automatic code generation using build_runner.

To use, import package:masamune/masamune.dart.

Classes

AccessTokenValue
Returns the result of an access token.
AllowCreateModelPermissionQuery
Define a query to validate data permissions.
AllowCreateModelValidationQuery
Define the validation query to be used by DatabaseValidator.
AllowDeleteModelPermissionQuery
Define a query to validate data permissions.
AllowDeleteModelValidationQuery
Allows only document deletion.
AllowReadCollectionModelPermissionQuery
Define a query to validate data permissions.
AllowReadCollectionModelValidationQuery
Allows reading (collections only).
AllowReadDocumentModelPermissionQuery
Define a query to validate data permissions.
AllowReadDocumentModelValidationQuery
Allows reading (documents).
AllowReadModelPermissionQuery
Define a query to validate data permissions.
AllowReadModelValidationQuery
Allow all reads (documents and collections).
AllowUpdateModelPermissionQuery
Define a query to validate data permissions.
AllowUpdateModelValidationQuery
Allows only document updates.
AllowWriteModelPermissionQuery
Define a query to validate data permissions.
AllowWriteModelValidationQuery
Allows only document creation.
AnimatedImageProvider
A custom ImageProvider that periodically switches between and displays multiple ImageProviders.
AnimatedImageStreamCompleter
ImageStreamCompleter for AnimatedImageProvider.
AnonymouslyAuthQuery
An AuthQuery for anonymous authentication.
AnonymouslySignInAuthProvider
AuthProvider for performing Authentication.signIn.
Api
Provides static methods for making HTTP requests.
ApiMultipartFile
A file to be uploaded as part of a ApiMultipartFile.
AppBarThemeExtension
Extended theme to extend the AppBar theme.
AppCupertinoLocalizationsDelegate
Class of LocalizationsDelegate for Cupertino.
AppLocalizationSettings
Class for retrieving the default LocalizationsDelegate.
AppLocalizeBase
Base class for building the localized configuration of the application.
AppMaterialLocalizationsDelegate
Class of LocalizationsDelegate for Material.
AppPageRoute<T>
Default PageRoute.
AppRef
ScopedValue in the scope of the application.
AppRoute
Automatically generates routing for the entire application.
AppRouter
Controller to define routing for the entire app.
AppRouteScope
InheritedWidget for placing AppRouter on the widget tree.
AppScoped
Place it close to the route (e.g., on top of MaterialApp) to use state management in the app.
AppScopedQuery<Result>
ScopedQuery available at app scope.
AppScopedQueryFamily<Result, Param>
You can pass one parameter AppScopedQuery.
AppScopedValueListener
ScopedValueListener that targets the app.
AppScopedValueOrAppRef
AppRef or AppScopedValueRef to store state in App scope.
AppScopedValueRef
ScopedValueRef of the application.
AppTheme
Annotation to be given to the theme of the application.
AppThemeData
Set the theme of the application.
AppThemeScope
InheritedWidget for placing AppThemeData on the widget tree.
AppWidgetsLocalizationsDelegate
Class of LocalizationsDelegate for Widget.
Asset
A class that provides utilities for handling assets without much awareness of their source location (on the network, on the terminal, in the asset folder).
AssetTextProvider
Provider to load text files from assets and display them in widgets, etc.
AssetThemeData
Defines a list of asset paths.
AssetVideoProvider
Provider to load video files from assets and display them in widgets.
AsyncAggregateValue<T>
This class is used to asynchronously retrieve values returned from CollectionBase.aggregate, etc.
AsyncSavingManager
Manages asynchronous saving operations with a queue system.
AsyncVectorConverter
An asynchronous vector value converter.
AuthAction
Base class that allows callbacks to be planted for sign-in and sign-out.
AuthActionQuery
Class for implementing callbacks from Authentication or AuthAdapter during authentication.
AuthAdapter
Adapters to change the behavior of authentication on different platforms.
AuthAdapterScope
Place it on top of MaterialApp, etc., and set AuthAdapter for the entire app.
AuthDatabase
A database for managing authentication information locally.
Authentication
Authentication implemented by AuthAdapter.
AuthExporter
Import and export DynamicMap data used in AuthDatabase to external files.
AuthInitialValue
Class for entering initial values for authentication information.
AuthProvider
An adapter used to execute various methods of Authentication.
AvatarTile
A tile widget for displaying profile cards and user overviews.
BooleanModelQuerySelector<TQuery extends ModelQueryBase<Listenable>>
ModelQuerySelector for bool.
BootRef
Class for special processing at boot time, which can be obtained from BootRouteQueryBuilder.
BootRouteQuery
Query to register actions on the Boot screen.
BootRouteQueryBuilder
RouteQueryBuilder for building the boot page (the page that is displayed only when the application is launched).
CachedImageBuilder
Cached image widget.
CachedRestApiModelAdapter
Defines ModelAdapter to define builders and make them work accordingly.
CardTile
A customizable card widget that overlays images or widgets with ListTile content.
ChangeAuthProvider
AuthProvider for performing Authentication.change.
ChangeEmailAuthProvider
AuthProvider for performing Authentication.change.
ChangeNotifierAppScopedQuery<Result extends Listenable?>
ChangeNotifierScopedQuery available at app scope.
ChangeNotifierAppScopedQueryFamily<Result extends Listenable?, Param>
You can pass one parameter ChangeNotifierAppScopedQuery.
ChangeNotifierPageScopedQuery<Result extends Listenable?>
ChangeNotifierScopedQuery available at page scope.
ChangeNotifierPageScopedQueryFamily<Result extends Listenable?, Param>
You can pass one parameter ChangeNotifierPageScopedQuery.
ChangeNotifierScopedQuery<Result extends Listenable?>
ChangeNotifierScopedQuery makes it possible to define values globally and manage states individually and safely.
ChangeNotifierScopedQueryBase<Result, TRef extends Ref>
Base class that can specify the type of the provider part of ScopedQuery.
ChangeNotifierScopedQueryFamily<Result extends Listenable?, Param>
You can pass one parameter ChangeNotifierScopedQuery.
ChangeNotifierScopedQueryFamilyBase<Result extends Listenable?, TRef extends Ref, Param>
You can pass one parameter ChangeNotifierScopedQuery.
ChangeNotifierWidgetScopedQuery<Result extends Listenable?>
ChangeNotifierScopedQuery available in the widget scope.
ChangeNotifierWidgetScopedQueryFamily<Result extends Listenable?, Param>
You can pass one parameter ChangeNotifierWidgetScopedQuery.
ChangePasswordAuthProvider
AuthProvider for performing Authentication.change.
ChangePhoneNumberAuthProvider
AuthProvider for performing Authentication.change.
ChatTile
A customizable chat bubble widget for messaging interfaces.
Clock
A class that can be used instead of DateTime.
CollectionBase<TModel extends DocumentBase>
Define a collection model that includes DocumentBase as an element.
CollectionModelPath
Annotation to create a collection model.
CollectionModelQuery
Query class for defining Model.
CollectionModelRestApiBuilder
Builder for creating collection model adapters using REST APIs.
CollectionModelRestApiQuery
Builder for creating collection model adapters using REST APIs.
ColorThemeData
Define a color scheme.
ConfirmChangeAuthProvider
AuthProvider for performing Authentication.confirmChange.
ConfirmChangePhoneNumberAuthProvider
AuthProvider for performing Authentication.confirmChange.
ConfirmSignInAuthProvider
AuthProvider for performing Authentication.confirmSignIn.
ConsoleLoggerAdapter
LoggerAdapter for outputting logs to the console.
Controller
Annotation for creating queries for controllers.
ControllerGroup
Annotation to create a query for a group of controllers.
ControllerQueryBase<TController extends Listenable>
Base class for creating state-to-state usage queries for controllers that are code-generated by the builder.
CreateAuthProvider
AuthProvider for performing Authentication.create.
Credential
Interface that represents the credentials returned by an auth provider. Implementations specify the details about each auth provider's credential requirements.
CsvCollectionSourceModelAdapter
A database adapter that uses CSV files as a data source.
CsvDocumentSourceModelAdapter
A database adapter that uses CSV files as a data source.
CsvSourceModelAdapter
A database adapter that uses CSV files as a data source.
CsvSourceModelBatchRef
ModelBatchRef for CsvSourceModelAdapter.
CsvSourceModelTransactionRef
ModelTransactionRef for CsvSourceModelAdapter.
DatabaseExporter
Import and export DynamicMap data used in NoSqlDatabase to external files.
DatabaseValidator
An object that validates information in the database.
DateDuration
A class that represents a date period.
DateFormat
DateFormat is for formatting and parsing dates in a locale-sensitive manner.
DeleteDocumentModelRestApiBuilder
Builder for creating document model adapters for deleting documents using a REST API.
DeleteDocumentModelRestApiQuery
Builder for creating document model adapters for deleting documents using a REST API.
DirectAuthQuery
An AuthQuery for debugging authentication.
DirectSignInAuthProvider
AuthProvider for performing Authentication.signIn.
DocumentBase<T>
Define a document model for storing T types that inherit from ChangeNotifier.
DocumentImageProviderBuilder
Class for providing implementation of Asset.image.
DocumentModelPath
Annotation for creating a documentation model.
DocumentModelQuery
Query class for defining Model.
DocumentModelRestApiBuilder
Builder for creating document model adapters using REST APIs.
DocumentTextProviderBuilder
Class for providing implementation of Asset.text.
DynamicModelInitialCollection
ModelInitialCollection using DynamicMap.
DynamicModelInitialDocument
ModelInitialDocument using DynamicMap.
EmailAndPasswordAuthQuery
An AuthQuery to authenticate by email and password.
EmailAndPasswordChangeEmailAuthProvider
AuthProvider for performing Authentication.change.
EmailAndPasswordChangePasswordAuthProvider
AuthProvider for performing Authentication.change.
EmailAndPasswordCreateAuthProvider
AuthProvider for performing Authentication.create.
EmailAndPasswordReAuthProvider
AuthProvider for performing Authentication.reauth.
EmailAndPasswordRegisterAuthProvider
AuthProvider for performing Authentication.register.
EmailAndPasswordResetAuthProvider
AuthProvider for performing Authentication.reset.
EmailAndPasswordSignInAuthProvider
AuthProvider for performing Authentication.signIn.
EmailAndPasswordVerifyAuthProvider
AuthProvider for performing Authentication.verify.
EmailLinkAuthQuery
An AuthQuery for link authentication via email.
EmailLinkChangeEmailAuthProvider
AuthProvider for performing Authentication.change.
EmailLinkConfirmSignInAuthProvider
AuthProvider for performing Authentication.confirmSignIn.
EmailLinkSignInAuthProvider
AuthProvider for performing Authentication.signIn.
EmailLinkVerifyAuthProvider
AuthProvider for performing Authentication.verify.
Empty
Creates a box that will become as small as its parent allows.
FileStorage
Class for using storage functions in local storage.
FileTextProvider
Provider to load text files from local and display them in widgets, etc.
FontThemeData
Define font themes.
FormAddPageScopedWidget
Abstract class for implementing a new add page for form widgets used for both adding new ones and editing existing ones.
FormAffixStyle
Class for defining prefix and suffix of text form.
FormBuilder<T, TValue>
A builder that can freely change the UI within a form.
FormBuilderRef<T, TValue>
Controller class for FormBuilder.
FormButton
Create buttons for forms.
FormCheckbox<TValue>
This widget is used to display a check box and save the check or not.
FormChipsField<TValue>
Form to allow text to be entered and saved separately as Chip.
FormChipsInputRef<T>
Class for adding and removing Chip.
FormContainer
Provides a container with FormStyle applied.
FormController<TValue>
Context for using the form.
FormControllerQueryBase<TModel>
Base class for creating state-to-state usage queries for FormController that are code-generated by the builder.
FormDateField<TValue>
A form to have the date (month and day) selected.
FormDateFieldPicker
Class that defines a picker style for selecting dates.
FormDateTimeField<TValue>
A form to have the date and time selected.
FormDateTimeFieldDatePicker
Let the user select only dates FormDateTimeFieldPicker.
FormDateTimeFieldDateTimePicker
Let the date and time be selected together FormDateTimeFieldPicker.
FormDateTimeFieldPicker
A delegate where the form picker and formatter are defined.
FormDateTimeRangeField<TValue>
Form to have a range of dates selected.
FormDateTimeRangeFieldCustomPicker
FormDateTimeRangeFieldPicker that allows specifying pickers that can be selected by pickerBuilder.
FormDateTimeRangeFieldDatePicker
Let the user select only dates FormDateTimeRangeFieldPicker.
FormDateTimeRangeFieldPicker
A delegate where the form picker and formatter are defined.
FormDurationField<TValue>
Form to have the duration selected.
FormDurationFieldPicker
Class that defines the picker style for selecting spacing.
FormEditableToggleBuilder
Combined with FormTextField, it can be used to control whether or not editing is allowed.
FormEditableToggleBuilderRef
Reference for FormEditableToggleBuilder.
FormEditPageScopedWidget
Abstract class to implement the existing edit page of a form widget used to both add new and edit existing.
FormEnumDropdownField<TEnum extends Enum, TValue>
Drop-down form to select from all elements in TEnum.
FormEnumDropdownFieldPicker<TEnum extends Enum>
Class that defines the picker style for selecting TEnum.
FormEnumModalField<TEnum extends Enum, TValue>
Form to select from all elements in TEnum.
FormEnumModalFieldPicker<TEnum extends Enum>
Class that defines the picker style for selecting TEnum.
FormFocusNodeBuilder
Builder to hold and provide FocusNode.
FormFutureField<T extends Object, TValue>
A form that waits for another process to complete and updates the value of the form based on that value.
FormFutureFieldRef<T extends Object, TValue>
You can perform various operations used in FormFutureField.builder.
FormLabel
Displays the label for each item on the form.
FormListBuilder<T, TValue>
A builder that can add and delete forms.
FormListBuilderRef<T, TValue>
Controller class for FormListBuilder.
FormMapDropdownField<TValue>
Drop down form to select from there with Map as an option.
FormMapDropdownFieldPicker
Class that defines the picker style for selection from Map.
FormMapModalField<TValue>
Form to select from there with Map as an option.
FormMapModalFieldPicker
Class that defines the picker style for selection from Map.
FormMapTagDropdownField<TValue>
Drop down form to select from there with Map as an option.
FormMapTagDropdownFieldPicker
Class that defines a picker style to select from Map for tags.
FormMapTagDropdownFieldRef<T>
Class that defines the reference for FormMapTagDropdownField.
FormMedia<TValue>
Form for submitting images and videos. Single media can be submitted.
FormMediaRef<TValue>
Class for controlling FormMedia.
FormMediaValue
Class for values when handling media in forms.
FormMonthModalField<TValue>
A form to have the date (year and month) selected.
FormMonthModalFieldPicker
Class that defines a picker style for selecting dates.
FormMultiMedia<TValue>
Form for submitting images and videos. Multiple media can be submitted.
FormMultiMediaDelegate
A delegate to determine the design of FormMultiMedia.
FormMultiMediaInlineDelegate
A delegate to build FormMultiMedia with a type design that fits inline with the form.
FormMultiMediaListTileDelegate
A delegate to build a FormMultiMedia with a design of the type arranged in a list.
FormMultiMediaRef<TValue>
Class for controlling FormMultiMedia.
FormNumModalField<TValue>
A form to let you select a numerical value.
FormNumModalFieldPicker
Class that defines a picker style for selecting numbers.
FormPasswordBuilder
Combined with FormTextField, it can be used to control the visibility of passwords.
FormPinField<TValue>
Widget for Pin text field for forms.
FormRatingBar<TValue>
Widget to display & edit by number of stars by passing double.
FormRef
A reference scoped to the form passed from FormScopedWidget.build.
FormScopedWidget
Abstract class to implement the View portion of the form widget used to both add new and edit existing forms.
FormStyle
Class for defining styles for Form.
FormStyleScope
Scope for FormStyle.
FormSwitch<TValue>
This widget is used to display switches and save ON/OFF of switches.
FormTextEditingControllerBuilder
Builder to hold and provide TextEditingController.
FormTextField<TValue>
Widgets for text fields for forms.
FormValue
Create a query to retrieve form controllers.
Functions
An interface for executing server-side processing.
FunctionsAction<TResponse>
Actions used in Functions.
FunctionsActionResponse
Class for defining the value returned when executed by FunctionsAction.
FunctionsAdapter
An adapter to provide an interface to perform server-side processing.
FunctionsAdapterScope
FunctionsAdapter for the entire app by placing it on top of MaterialApp, etc.
FunctionStub
Class for stubbing specific functions used in RuntimeFunctionsAdapter.
FutureContext<T>
Object returned when future is executed.
GeoValue
Data to store location information.
GoogleSpreadSheetDataSource
Create a data source adapter based on a Google spreadsheet.
GoogleSpreadSheetLocalize
Annotation for automatic creation of multilingualization codes based on Google spreadsheets.
GradientColor
You can add gradient elements to the theme's color settings.
GridBuilder<T>
Draw a grid list with elements generated from builder given source.
HiddenPage
Pages to be used in nested navigators instead of at the top level or to intentionally not set URLs.
ImageMemoryCache
Memory cache for images.
ImageProviderBuilder
Class for providing implementation of Asset.image.
Immutable
Used to annotate a class.
Indent
A padded column widget that simplifies vertical layouts with consistent padding.
InitialRouteInformation
InitialRouteInformation is a class that contains the initial route information.
JsonCollectionSourceModelAdapter
A database adapter that uses Json files as a data source.
JsonDocumentSourceModelAdapter
A database adapter that uses Json files as a data source.
JsonParam
Ensure that serializable parameters can be successfully serialized to Json.
JsonSourceModelAdapter
A database adapter that uses Json files as a data source.
JsonSourceModelBatchRef
ModelBatchRef for JsonSourceModelBatchRef.
JsonSourceModelTransactionRef
ModelTransactionRef for JsonSourceModelTransactionRef.
Label
A customizable label widget for displaying section headers and titles.
LineTile
An enhanced ListTile with a text widget positioned to the right of the title.
LineTileGroup
A container widget that groups multiple ListTile and LineTile widgets together.
ListBuilder<T>
If source is given, each of its elements is displayed side by side in builder.
ListenableListener<T extends Listenable>
A widget that monitors changes in Listenable and updates the contents of builder when there is a change.
ListModelQuerySelector<TValue, TQuery extends ModelQueryBase<Listenable>>
ModelQuerySelector for List.
LoadDocumentModelRestApiBuilder
Builder for creating model adapters for loading documents using a REST API.
LoadDocumentModelRestApiQuery
Builder for creating model adapters for loading documents using a REST API.
LoadingBuilder
A builder widget that displays loading indicators while waiting for multiple futures.
LocalAuthAdapter
Authentication adapter that stores data on the local terminal.
Locale
An identifier used to select a user's language and formatting preferences.
LocalFile
Class for handling local files and real data.
LocalizationsDelegate<T>
A factory for a set of localized resources of type T, to be loaded by a Localizations widget.
LocalizedLocaleValue<T>
Class for restricting the types of values that can be stored in LocalizedValue.
LocalizedValue<T>
Class for storing translation data.
LocalizeScope
Widget to detect localization changes.
LocalLoggerAdapter
Logging can be done locally on the terminal LoggerAdapter.
LocalModelAdapter
A database adapter that stores data on a local terminal.
LocalModelBatchRef
ModelBatchRef for LocalModelAdapter.
LocalModelTransactionRef
ModelTransactionRef for LocalModelAdapter.
LocalPlatformInfoAdapter
A PlatformInfoAdapter that actually acquires OS-specific information.
LocalRestApiModelAsyncSavingManager
Manages asynchronous saving operations with a queue system.
LocalStorageAdapter
StorageAdapter for handling files in local storage.
Loggable
Interface for objects that can be passed directly to Logger.send.
Logger
Used for active logging.
LoggerAdapter
Base class for defining platform adapters for storing logs.
LoggerAdapterScope
Place it on top of MaterialApp, etc., and set LoggerAdapter for the entire app.
LoggerDatabase
A simple database for logging information.
LoggerExporter
Import and export DynamicMap data used in LoggerDatabase to external files.
LoggerTrace
Base class for tracing logs and measuring performance.
LoggerTraceValue
Base class for tracing logs and measuring performance.
LogValue
Class for defining log values for viewing.
MapModelQuerySelector<TValue, TQuery extends ModelQueryBase<Listenable>>
ModelQuerySelector for Map.
MasamuneAdapter
Adapter for easily adding functions to Masamune Framework.
MasamuneAdapterScope<TAdapter extends MasamuneAdapter>
MasamuneAdapter for the entire app by placing it on top of MaterialApp, etc.
MasamuneApp
MaterialApp for Masamune Framework.
MasamuneControllerBase<TValue, TAdapter extends MasamuneAdapter>
Abstract class to inherit when you want to create a controller using MasamuneAdapter.
MasamuneRef
runMasamuneAppで返されるオブジェクト。
MeasuredCircularProgressIndicator
A circular progress indicator whose visible lifetime is logged as an indicator performance trace.
MeasuredLinearProgressIndicator
A linear progress indicator whose visible lifetime is logged as an indicator performance trace.
MemoizedAssetSvgImageProvider
Class that can handle Svg files as ImageProvider.
MemoizedFileSvgImageProvider
Class that can handle Svg files as ImageProvider.
MemoizedNetworkSvgImageProvider
Class that can handle Svg files as ImageProvider.
MemoryStorage
Class for using storage functions on runtime memory.
MessageBox
An informational message box widget with icon, label, and optional actions.
MimeTypeValue
Class that defines the MimeType.
Provides easy modal functionality.
ModalRef<T>
Class for controlling Modal.
ModelAccessQuery
Stores information for accessing the server.
ModelAdapter
You can implement adapters that define the internal specifications of the model.
ModelAdapterCollectionQuery
Query class to be passed when executing each function of ModelAdapter.
ModelAdapterDocumentQuery
Query class to be passed when executing each function of ModelAdapter.
ModelAdapterScope
Widget for setting ModelAdapter.
ModelAggregateQuery<TValue extends AsyncAggregateValue>
A query to output an aggregate of the documents in a collection.
ModelBatchCollectionBuilder<TModel extends DocumentBase>
Builder for batch processing.
ModelBatchDocument<T>
Documentation class for batch.
ModelBatchDocumentBuilder<T>
Builder for batch processing.
ModelBatchRef
Reference class for batching.
ModelCounter
Define the field as a counter.
ModelCounterConverter
ModelFieldValueConverter to enable automatic conversion of ModelCounter as ModelFieldValue.
ModelCounterFilter
Filter class to make ModelCounter available to ModelQuery.filters.
ModelCounterModelQuerySelector<TQuery extends ModelQueryBase<Listenable>>
ModelQuerySelector for ModelCounter.
ModelDatabaseConditionQuery
Base class for creating queries to access the database.
ModelDatabaseQuery
Base class for creating queries to access the database.
ModelDatabaseQueryGroup
A query group that summarizes ModelDatabaseQuery.
ModelDate
Define the field as a date.
ModelDateConverter
ModelFieldValueConverter to enable automatic conversion of ModelDate as ModelFieldValue.
ModelDateFilter
Filter class to make ModelDate available to ModelQuery.filters.
ModelDateModelQuerySelector<TQuery extends ModelQueryBase<Listenable>>
ModelQuerySelector for ModelDate.
ModelDateRange
Define the field as a range of dates.
ModelDateRangeConverter
ModelFieldValueConverter to enable automatic conversion of ModelDateRange as ModelFieldValue.
ModelDateRangeFilter
Filter class to make ModelDateRange available to ModelQuery.filters.
ModelDateRangeModelQuerySelector<TQuery extends ModelQueryBase<Listenable>>
ModelQuerySelector for ModelDateRange.
ModelFieldValue<T>
Class for defining special field values.
ModelFieldValueConverter<T extends ModelFieldValue>
Use this when registering special classes in ModelFieldValue.
ModelFieldValueFilter<T extends ModelFieldValue>
Adapter class for determining the behavior of ModelFieldValue in ModelQuery.filters.
ModelGeoValue
Define a model GeoValue that stores location information.
ModelGeoValueConverter
ModelFieldValueConverter to enable automatic conversion of ModelGeoValue as ModelFieldValue.
ModelGeoValueFilter
Filter class to make ModelGeoValue available to ModelQuery.filters.
ModelGeoValueModelQuerySelector<TQuery extends ModelQueryBase<Listenable>>
ModelQuerySelector for ModelGeoValue.
ModelImageUri
Define the field as an image URI.
ModelImageUriConverter
ModelFieldValueConverter to enable automatic conversion of ModelImageUri as ModelFieldValue.
ModelImageUriFilter
Filter class to make ModelImageUri available to ModelQuery.filters.
ModelImageUriModelQuerySelector<TQuery extends ModelQueryBase<Listenable>>
ModelQuerySelector for ModelImageUri.
ModelInitialCollection<T>
Data to be passed to data of various ModelAdapter.
ModelInitialDocument<T>
Data to be passed to data of various ModelAdapter.
ModelInitialValue<T>
Base class for data to be passed to various ModelAdapter data.
ModelLocale
Define a model Locale that stores the locale.
ModelLocaleConverter
ModelFieldValueConverter to enable automatic conversion of ModelLocale as ModelFieldValue.
ModelLocaleFilter
Filter class to make ModelLocale available to ModelQuery.filters.
ModelLocaleModelQuerySelector<TQuery extends ModelQueryBase<Listenable>>
ModelQuerySelector for ModelLocale.
ModelLocalizedValue
Define a model LocalizedValue that stores locale and text pairs.
ModelLocalizedValueConverter
ModelFieldValueConverter to enable automatic conversion of ModelLocalizedValue as ModelFieldValue.
ModelLocalizedValueFilter
Filter class to make ModelLocalizedValue available to ModelQuery.filters.
ModelLocalizedValueModelQuerySelector<TQuery extends ModelQueryBase<Listenable>>
ModelQuerySelector for ModelLocalizedValue.
ModelPermissionQuery
Define a query to validate data permissions.
ModelQuery
Query class for defining Model.
ModelQueryBase<TModel extends Listenable>
Base class for creating state-to-state usage queries for the model to be code-generated by the builder.
ModelQueryFilter
Definition class for filtering data.
ModelQuerySelector<T, TQuery extends ModelQueryBase<Listenable>>
Class for type-safe handling of collection queries.
ModelRefBase<T>
Class for defining relationships between models.
ModelRefBuilder<TSource, TResult>
Builder for granting relationships between models and loading data.
ModelRefBuilderBase<TSource>
Base class for defining ModelRefBuilder.
ModelRefConverter
ModelFieldValueConverter to enable automatic conversion of ModelRefBase as ModelFieldValue.
ModelRefDocumentBase<T>
Define a document base including ModelRefBase and DocumentBase.
ModelRefFilter
Filter class to make ModelRefBase available to ModelQuery.filters.
ModelRefListBuilder<TSource, TResult>
Builder for granting relationships between models and loading data.
ModelRefMapBuilder<TSource, TResult>
Builder for granting relationships between models and loading data.
ModelRefModelQuerySelector<TModelRef, TQuery extends ModelQueryBase<Listenable>>
ModelQuerySelector for ModelRefBase.
ModelRefPath<T>
Class for generating ModelRefBase by specifying the path.
ModelRestApiBuilder
Builder for creating model adapters using REST APIs.
ModelRestApiQuery
Builder for creating model adapters using REST APIs.
ModelSearch
Define searchable fields.
ModelSearchConverter
ModelFieldValueConverter to enable automatic conversion of ModelSearch as ModelFieldValue.
ModelSearchFilter
Filter class to make ModelSearch available to ModelQuery.filters.
ModelSearchModelQuerySelector<TQuery extends ModelQueryBase<Listenable>>
ModelQuerySelector for ModelSearch.
ModelServerCommandBase
Define commands to work with the server.
ModelServerCommandBaseConverter
ModelFieldValueConverter to enable automatic conversion of ModelServerCommandBase as ModelFieldValue.
ModelServerCommandBaseFilter
Filter class to make ModelServerCommandBase available to ModelQuery.filters.
ModelServerCommandCondition
Condition class used in ModelServerCommandBase.
ModelServerCommandField
Field specification class used in ModelServerCommandBase.
ModelTime
Define the field as a time.
ModelTimeConverter
ModelFieldValueConverter to enable automatic conversion of ModelTime as ModelFieldValue.
ModelTimeFilter
Filter class to make ModelTime available to ModelQuery.filters.
ModelTimeModelQuerySelector<TQuery extends ModelQueryBase<Listenable>>
ModelQuerySelector for ModelTime.
ModelTimeRange
Define the field as a time range.
ModelTimeRangeConverter
ModelFieldValueConverter to enable automatic conversion of ModelTimeRange as ModelFieldValue.
ModelTimeRangeFilter
Filter class to make ModelTime available to ModelQuery.filters.
ModelTimeRangeModelQuerySelector<TQuery extends ModelQueryBase<Listenable>>
ModelQuerySelector for ModelTimeRange.
ModelTimestamp
Define the field as a timestamp.
ModelTimestampConverter
ModelFieldValueConverter to enable automatic conversion of ModelTimestamp as ModelFieldValue.
ModelTimestampFilter
Filter class to make ModelTimestamp available to ModelQuery.filters.
ModelTimestampModelQuerySelector<TQuery extends ModelQueryBase<Listenable>>
ModelQuerySelector for ModelTimestamp.
ModelTimestampRange
Define the field as a range of timestamps.
ModelTimestampRangeConverter
ModelFieldValueConverter to enable automatic conversion of ModelTimestampRange as ModelFieldValue.
ModelTimestampRangeFilter
Filter class to make ModelTimestampRange available to ModelQuery.filters.
ModelTimestampRangeModelQuerySelector<TQuery extends ModelQueryBase<Listenable>>
ModelQuerySelector for ModelTimestampRange.
ModelToken
Class for storing multiple tokens.
ModelTokenConverter
ModelFieldValueConverter to enable automatic conversion of ModelToken as ModelFieldValue.
ModelTokenFilter
Filter class to make ModelToken available to ModelQuery.filters.
ModelTokenModelQuerySelector<TQuery extends ModelQueryBase<Listenable>>
ModelQuerySelector for ModelToken.
ModelTransactionCollectionBuilder<TModel extends DocumentBase>
Builder for transactions.
ModelTransactionDocument<T>
Document class for transactions.
ModelTransactionDocumentBuilder<T>
Builder for transactions.
ModelTransactionRef
Reference class for performing transactions.
ModelUpdateNotification
This class contains data for change notifications.
ModelUri
Define the field as a URI.
ModelUriConverter
ModelFieldValueConverter to enable automatic conversion of ModelUri as ModelFieldValue.
ModelUriFilter
Filter class to make ModelUri available to ModelQuery.filters.
ModelUriModelQuerySelector<TQuery extends ModelQueryBase<Listenable>>
ModelQuerySelector for ModelUri.
ModelValidationQuery
Define the validation query to be used by DatabaseValidator.
ModelVectorValue
ModelFieldValue for storing vector embeddings.
ModelVectorValueConverter
ModelFieldValueConverter to enable automatic conversion of ModelVectorValue as ModelFieldValue.
ModelVectorValueFilter
Filter class to make ModelVectorValue available to ModelQuery.filters.
ModelVectorValueModelQuerySelector<TQuery extends ModelQueryBase<Listenable>>
ModelQuerySelector for ModelVectorValue.
ModelVideoUri
Define the field as a video URI.
ModelVideoUriConverter
ModelFieldValueConverter to enable automatic conversion of ModelVideoUri as ModelFieldValue.
ModelVideoUriFilter
Filter class to make ModelVideoUri available to ModelQuery.filters.
ModelVideoUriModelQuerySelector<TQuery extends ModelQueryBase<Listenable>>
ModelQuerySelector for ModelVideoUri.
NestedAppRouter
Class for creating nested AppRouter.
NetworkTextProvider
Provider to load text files from the network and display them in widgets, etc.
NoSqlDatabase
Class for building a NoSql database model within an application.
NumModelQuerySelector<TQuery extends ModelQueryBase<Listenable>>
ModelQuerySelector for num.
NumRange<TNum extends num>
A class that represents a range of numbers.
ObjectModelQuerySelector<TQuery extends ModelQueryBase<Listenable>>
ModelQuerySelector for Object.
OnContext
Object returned when executing on.
PageOrAppScopedValueOrAppRef
AppScopedValueOrAppRef that stores state in page scope and App scope.
PageOrWidgetScopedValueRef
ScopedValueRef of the Page or Widget (whose state can be monitored).
PageParam
Annotation to map each widget parameter to a variable in the page root.
PagePath
Annotation defining the page.
PageRef
A page-scoped reference passed from PageScopedWidget.build.
PageRouteQuery
Annotation to define the RouteQuery of the page.
PageScopedQuery<Result>
ScopedQuery available at page scope.
PageScopedQueryFamily<Result, Param>
You can pass one parameter PageScopedQuery.
PageScopedValueListener
ScopedValueListener that targets the page.
PageScopedValueRef
Page's ScopedValueRef.
PageScopedWidget
Abstract class for creating widgets for use on pages.
ParamComment
When specifying each field in CollectionModelPath or DocumentModelPath, it is possible to annotate the field with a comment.
PassVectorConverter
A converter that passes data through without performing any conversion.
PeriodicScope
A widget that automatically rebuilds at regular intervals.
PickerDateTimeType
Picker date time type.
PlatformInfo
A class that provides platform information.
PlatformInfoAdapter
An adapter to modify authentication behavior for each platform.
PlatformInfoAdapterScope
Place it on top of MaterialApp, etc., and set PlatformInfoAdapter for the entire app.
ProgressIndicatorBuilder<T extends Listenable>
Progress indicator to show progress via ChangeNotifier.
QueryParam
Annotation to map each widget parameter to a query parameter in the page path.
QueryScopedValue<TResult, TRef extends Ref>
Class for extensions to manage state.
QueryScopedValueRef<TRef extends Ref>
Ref used inside ScopedQuery.
QueryScopedValueState<TResult, TRef extends Ref, TScopedValue extends QueryScopedValue<TResult, TRef>>
State created by ScopedValue.
ReAuthProvider
AuthProvider for performing Authentication.reauth.
RectRange<TNum extends num>
A class that represents a range of numbers.
RedirectQuery
Class for defining the page to be displayed in different locations depending on conditions.
Ref
Base class for References passed from ScopedWidget, etc.
RefHasAny
RefHasApp or RefHasPage, RefHasWidget.
RefHasApp
Reference with ScopedValueRef in the application scope.
RefHasPage
Reference with page scope Ref.
RefHasWidget
Reference with widget scope Ref.
RefOrRefHasAny
Ref or RefHasApp, RefHasPage, RefHasWidget.
RefParam
When specifying a CollectionModelPath or DocumentModelPath field, you can load the referenced document together by specifying it in the field when referencing other documents.
RegisterAuthProvider
AuthProvider for performing Authentication.register.
RemoteFile
Class for handling remote files and real data.
ReorderableListBuilder<T>
You can configure reorderable lists in a similar fashion to ListBuilder.
ResetAuthProvider
AuthProvider for performing Authentication.reset.
RestApiFunctionsAction<TResponse extends RestApiFunctionsActionResponse>
A function action that uses Rest API.
RestApiFunctionsActionResponse
A response of the functions action that uses Rest API.
RestApiFunctionsAdapter
Adapter to execute functions using Rest API.
RestApiModelAdapter
Defines ModelAdapter to define builders and make them work accordingly.
RouteQuery
Base class for creating queries to perform page transitions.
RouteQueryBuilder
Class for building page queries.
RuntimeAuthAdapter
Authentication adapter using a database that runs only in the app's memory.
RuntimeFunctionsAdapter
FunctionsAdapter] that only returns a normal system without communicating with the server side.
RuntimeLoggerAdapter
Logging in memory LoggerAdapter.
RuntimeModelAdapter
Model adapter that uses a database that runs only in the memory of the application. All data will be reset when the application is re-launched.
RuntimeModelBatchRef
ModelBatchRef for RuntimeModelAdapter.
RuntimeModelTransactionRef
ModelTransactionRef for RuntimeModelAdapter.
RuntimePlatformInfoAdapter
PlatformInfoAdapter to pre-configure and retrieve platform information.
RuntimeStorageAdapter
StorageAdapter for handling files at runtime.
RuntimeVectorConverter
A converter for easy, runtime vector conversion.
SaveDocumentModelRestApiBuilder
Builder for creating document model adapters for saving documents using a REST API.
SaveDocumentModelRestApiQuery
Builder for creating document model adapters for saving documents using a REST API.
ScaffoldThemeExtension
Extended theme to extend the Scaffold theme.
ScheduleContext
Object returned when schedule is executed.
Scoped
Widgets for state management within a page or widget.
ScopedQuery<Result>
ScopedQuery makes it possible to define values globally and manage state individually and safely.
ScopedQueryBase<Result, TRef extends Ref>
Base class that can specify the type of the provider part of ScopedQuery.
ScopedQueryFamily<Result, Param>
You can pass one parameter ScopedQuery.
ScopedQueryFamilyBase<Result, TRef extends Ref, Param>
Base class that allows specifying the type of the provider part of ScopedQuery that allows passing a single parameter.
ScopedValue<TResult>
Class for extensions to manage state.
ScopedValueContainer
Container object for storing ScopedValue.
ScopedValueListener
An object to monitor ScopedValue in the widget.
ScopedValueRef
Ref associated with the widget.
ScopedValueState<TResult, TScopedValue extends ScopedValue<TResult>>
State created by ScopedValue.
ScopedWidget
Abstract class for creating widgets that can perform state management under the page.
ScopedWidgetBase
Base class from which widgets can be retrieved with ScopedWidgetScope.of.
ScopedWidgetScope
InheritedWidget for making ScopedWidgetBase retrievable from descendant widgets.
ScrollBuilder
A builder widget that adds RefreshIndicator and Scrollbar to scrollable widgets.
SearchParam
When specifying each field in CollectionModelPath or DocumentModelPath, you can annotate the field to make it a search target.
ShimmerBox
A container widget that displays a shimmer loading effect.
ShimmerMultiLine
A multi-line shimmer effect widget for paragraph-style loading placeholders.
SignInAuthProvider
AuthProvider for performing Authentication.signIn.
SmsAuthQuery
An AuthQuery for SMS code authentication.
SmsChangePhoneNumberAuthProvider
AuthProvider for performing Authentication.change.
SmsConfirmChangePhoneNumberAuthProvider
AuthProvider for performing Authentication.confirmChange.
SmsConfirmSignInAuthProvider
AuthProvider for performing Authentication.confirmSignIn.
SmsSignInAuthProvider
AuthProvider for performing Authentication.signIn.
SnsContentTile
A widget for displaying social media-style content with profile layout.
SnsImage
A widget for displaying multiple images in SNS-style layouts.
SnsReAuthProvider
An AuthQuery for OAuth re-authentication of SNS.
SnsSignInAuthProvider
An AuthQuery for OAuth authentication for SNS.
SquareAvatar
A square avatar widget that works as a rectangular alternative to CircleAvatar.
Storage
Provides access to file storage.
StorageAdapter
Adapter for storage functions.
StorageAdapterScope
StorageAdapter for the entire app by placing it on top of MaterialApp, etc.
StorageBase
Abstract class for implementing internal storage functionality.
StorageFile
Abstract class for defining files for storage.
StorageQuery
Query to specify the path of storage on the remote side.
StorageValue
Define storage values.
StringModelQuerySelector<TQuery extends ModelQueryBase<Listenable>>
ModelQuerySelector for String.
SuggestionConfig
Configuration for suggestions.
SuggestionStyle
Class that defines the design for suggestions.
SyncedVectorConverter
A synchronous vector value converter.
SynchronousFuture<T>
A Future whose then implementation calls the callback immediately.
TemporaryImageProviderBuilder
Class for providing implementation of Asset.image.
TemporaryTextProviderBuilder
Class for providing implementation of Asset.text.
TestAppScoped
Test scope for AppScoped.
TestAuthAdapterScope
Test scope for AuthAdapter.
TestFunctionsAdapterScope
Test scope for FunctionsAdapter.
TestLoggerAdapterScope
Test scope for LoggerAdapter.
TestMasamuneAdapterScope
Test scope for MasamuneAdapter.
TestModelAdapterScope
Test scope for ModelAdapter.
TestPlatformInfoAdapterScope
Test scope for PlatformInfoAdapter.
TestStorageAdapterScope
Test scope for StorageAdapter.
TextProvider
Provider for loading text data and displaying it in widgets, etc.
TextProviderBuilder
Class for providing implementation of Asset.text.
TextStyleThemeData
Class for retrieving text styles.
TextThemeData
Define a text theme.
TransitionQuery
Route queries for page transitions.
UnknownRouteQueryBuilder
RouteQueryBuilder for building a page (404 page) to display if the page passed to AppRouter is not a hit for the entered path (URL).
UseResult
See useResult for more details.
ValueModelQuerySelector<TValue, TQuery extends ModelQueryBase<Listenable>>
ModelQuerySelector for TValue.
VectorConverter
A vector value converter.
VectorParam
It is possible to make a field eligible for similarity search by annotating it when specifying each field of CollectionModelPath or DocumentModelPath.
VectorValue
Value for storing vector embeddings in models.
VerifyAuthProvider
AuthProvider for performing Authentication.verify.
VideoProvider
Provider to load video data and display it in widgets.
WidgetRef
A reference scoped to the widget passed from ScopedWidget.build or Scoped.builder.
WidgetScopedQuery<Result>
ScopedQuery available in the widget scope.
WidgetScopedQueryFamily<Result, Param>
You can pass one parameter WidgetScopedQuery.
WidgetScopedValueRef
Widget's ScopedValueRef.
WidgetThemeData
Defines the theme of the widget.
YamlLocalize
This is an annotation for automatically generating multilingual code from a Yaml file.

Enums

ApiMethod
An HTTP method.
ApiMultipartFileType
The type of the multipart file.
AuthLoggerEvent
Authentication events for logging.
DayOfWeek
Day of the week.
FileImageDirType
Directory type of the file.
FormInputBorderStyle
Defines the style of the outer border of InputBorder.
FormMediaType
The type of media handled by the form.
FormTextFieldSelectionOnFocus
Specifies the behavior when focused.
GoogleSpreadSheetDataSourceDirection
Orientation for using data source for documents at GoogleSpreadSheetDataSource.
ModelAccessQueryType
Define the type of access to the server.
ModelAggregateQueryType
Query type for outputting an aggregate of the documents in a collection.
ModelDatabaseQueryFilterType
Define the filter type for ModelDatabaseQuery.
ModelFieldValueSource
Defines where the source of the ModelFieldValue is located.
ModelPermissionQueryType
Specifies the permission type for validation.
ModelPermissionQueryUserType
Specify the target user for which you want to specify ModelPermissionQueryType.
ModelQueryFilterType
Define the filter type for ModelQuery.
ModelUpdateNotificationStatus
Defines the change status of each model.
ModelValidationQueryPermissionType
Specifies the permission type for validation.
ModelValidationQueryUserType
Specify the target user for which you want to specify ModelValidationQueryPermissionType.
PlatformType
A type that represents the platform type.
RouteLoggerEvent
Routing events for logging.
ScopedLoggerEvent
Status management events for logging.
ScopedLoggerScope
State management scope for logging.
VectorDistanceMeasure
Distance measure for vector similarity calculations.
VectorValueStoreType
Types of vector value storage.

Mixins

ConnectControllerMixin
Provides the ability to load data into the controller.
DeletableControllerMixin
Provides the ability to delete data from the controller.
DisconnectControllerMixin
Provides the ability to load data into the controller.
FilterableCollectionMixin<TModel extends DocumentBase, TModelQuery extends ModelQueryBase<Listenable>>
Mix-in to do CollectionBase.replaceQuery by ModelQueryBase.
InitializableControllerMixin
Provides the ability to initialize data from the controller.
LoadableControllerMixin<T>
Provides the ability to load data into the controller.
ModelFieldValueAsMapMixin<T>
Mix-in to allow Json serialization and deserialization of ModelFieldValue.
ModelRefLoaderMixin<T>
It is available by mixing in when using ModelRefBase in DocumentBase.value.
ModelRefMixin<T>
A mix-in to define that it is a relationship between models in DocumentBase, etc.
PurchasableControllerMixin
Provides the ability to purchase data from the controller.
SalableControllerMixin
Provides the ability to sell data from the controller.
SavableControllerMixin
Provides the ability to load data into the controller.
SearchableCollectionMixin<TModel extends SearchableDocumentMixin>
Mix-ins to create collections for which search functions are available.
SearchableDocumentMixin<T>
Mix-in to make documents searchable.
SearchableInitialCollectionMixin<T>
Mix-in to search for ModelInitialCollection.
StartAndStoppableControllerMixin
Provides the controller with the functionality to start and stop data.
VectorCollectionMixin<TModel extends VectorDocumentMixin>
A mixin for creating collections that enable vector-based similarity search.
VectorDocumentMixin<T>
A mixin for making documents searchable by similarity.
VectorInitialCollectionMixin<T>
A mixin for enabling similarity search on ModelInitialCollection.

Extensions

BooleanExtensions on bool
Provides extended methods for bool.
BorderRadiusShortenExtensions on num
Extension to allow BorderRadius to be easily described in num.
BuildContextLocaleExtensions on BuildContext
Extension to extend BuildContext.
ClockExtensions on Clock
Provides extended methods for Clock.
ClockIterableExtensions on Iterable<Clock>
Provides extended methods for Clock arrays.
ControllerQueryBaseExtensions on ControllerQueryBase<TController>
This is an extension method of ControllerQueryBase.
DateTimeExtensions on DateTime
Provides extended methods for DateTime.
DateTimeIterableExtensions on Iterable<DateTime>
Provides extended methods for DateTime arrays.
DoubleExtensions on double
Provides extended methods for double.
DoubleIterableExtensions on Iterable<double>
Provides extended methods for double arrays.
DurationExtensions on Duration
Provides extended methods for Duration.
DurationShortenExtensions on num
Extension to allow Duration to be easily described in num.
DynamicListModelExtensions on DynamicList
Extension methods for DynamicList.
DynamicMapExtensions on Map<String, dynamic>
Provides extended methods for DynamicMap.
DynamicMapModelExtensions on DynamicMap
Extension methods for DynamicMap.
DynamicMapModelFieldValueExtensions on DynamicMap
Provides extension methods for DynamicMap for ModelFieldValue.
EdgeInsetsShortenExtensions on num
Extension to allow EdgeInsets to be easily described in num.
FormControllerQueryBaseExtensions on FormControllerQueryBase<TModel>
Extension methods for ControllerQueryBase<FormController>.
FormMediaValueExtensions on FormMediaValue
Extension methods for FormMediaValue.
FutureIndicatorExtensions on FutureOr<T>
Extension to display Indicator in FutureOr.
ImageProviderExtensions on ImageProvider<Object>
Extensions for ImageProvider.
InterableOfIterableExtensions on Iterable<Iterable<T>>
Provides extended methods for Iterable arrays.
IntExtensions on int
Provides extended methods for int.
IntIterableExtensions on Iterable<int>
Provides extended methods for int arrays.
IterableExtensions on Iterable<T>
Provides extended methods for T arrays.
JsonDynamicListExtensions on DynamicList
Provides Json extension methods for DynamicList.
JsonDynamicMapExtensions on DynamicMap
Provides Json extension methods for DynamicMap.
ListenableIterableExtensions on Iterable<T>
Provides an extension method for Iterable that includes Listenable as an element.
ListExtensions on List<T>
Provides extended methods for List in T.
LocalizeLocaleExtensions on Locale
Extension to extend Locale.
MapExtensions on Map<K, V>
Provides extended methods for Map.
MasamuneBuildContextExtensions on BuildContext
Extension methods for BuildContext.
MasamuneControllerPageOrAppScopedValueOrAppRefExtensions on PageOrAppScopedValueOrAppRef
Create an extension method for PageOrAppScopedValueOrAppRef to handle Query for controllers and controller groups.
MasamuneControllerQueryScopedValueRefExtensions on QueryScopedValueRef<PageOrAppScopedValueOrAppRef>
Create an extension method for QueryScopedValueRef to handle Query for controllers and controller groups.
MasamuneFormPageScopedValueRefExtensions on PageOrAppScopedValueOrAppRef
Create an extension method for PageOrAppScopedValueOrAppRef to handle Query for form.
MasamuneModelAppScopedValueOrAppRefExtensions on AppScopedValueOrAppRef
Create an extension method for AppScopedValueOrAppRef to handle the Query for the model.
MasamuneModelQueryScopedValueRefExtensions on QueryScopedValueRef<AppScopedValueOrAppRef>
Create an extension method for QueryScopedValueRef to handle the Query for the model.
MasamuneRouterPageScopedValueRefExtensions on PageScopedValueRef
Create an extension method for PageScopedValueRef to create nested routers.
ModelImageUriExtensions on ModelImageUri
Extension methods for ModelImageUri.
ModelQueryBaseExtensions on ModelQueryBase<TModel>
This is an extension method of ModelQueryBase.
ModelQueryFilterListExtension on List<ModelQueryFilter>
Extension method for a list of ModelQueryFilter.
ModelStringExtensions on String
Extension methods for String.
ModelVideoUriExtensions on ModelVideoUri
Extension methods for ModelVideoUri.
NullableDoubleExtensions on double?
Provides an extension method for double that is nullable.
NullableFormMeidaValueExtension on FormMediaValue?
Provides an extension method for FormMediaValue that is nullable.
NullableIntExtensions on int?
Provides an extension method for int that is nullable.
NullableIterableExtensions on Iterable<T>?
Provides an extension method for Iterable that is nullable.
NullableListExtensions on List<T>?
Provides an extension method for List that is nullable.
NullableMapExtensions on Map<K, V>?
Provides an extension method for Map that is nullable.
NullableNumExtensions on num?
Provides an extension method for num that is nullable.
NullableObjectExtensions on Object?
Provides an extension method for List that is nullable.
NullableSetExtensions on Set<T>?
Provides an extension method for Set that is nullable.
NullableStringExtensions on String?
Provides an extension method for String that is nullable.
NullableTExtensions on T?
Provides an extension method for T? that is nullable.
NullableUriExtensions on Uri?
Provides an extension method for Uri that is nullable.
NullableValueIterableExtensions on Iterable<T?>
Provides an extension method for Iterable whose value is nullable.
PageOrWidgetScopedValueRefCacheExtensions on PageOrWidgetScopedValueRef
Provides an extension method for PageOrWidgetScopedValueRef to perform caching.
PageOrWidgetScopedValueRefFutureExtensions on PageOrWidgetScopedValueRef
Provides an extended method for PageOrWidgetScopedValueRef to monitor Future.
PageOrWidgetScopedValueRefOnExtensions on PageOrWidgetScopedValueRef
Provides extension methods for PageOrWidgetScopedValueRef for processing in the lifecycle.
PageOrWidgetScopedValueRefPeriodicExtensions on PageOrWidgetScopedValueRef
Provides extension methods for PageOrWidgetScopedValueRef to perform periodic processing.
PageOrWidgetScopedValueRefRefreshExtensions on PageOrWidgetScopedValueRef
Provides an extension method for PageOrWidgetScopedValueRef to update the widget.
PageOrWidgetScopedValueRefScheduleExtensions on PageOrWidgetScopedValueRef
Provides an extension method for PageOrWidgetScopedValueRef to perform scheduling.
PageOrWidgetScopedValueRefTimerExtensions on PageOrWidgetScopedValueRef
Provides an extension method for PageOrWidgetScopedValueRef to process Timer.
PageOrWidgetScopedValueRefWatchExtensions on PageOrWidgetScopedValueRef
Provides an extended method for PageOrWidgetScopedValueRef to monitor ChangeNotifier.
PageScopedValueRefAncestorExtensions on PageOrWidgetScopedValueRef
Provides an extension method for PageOrWidgetScopedValueRef to retrieve a ScopedValue that already exists in the page or widget scope.
QueryScopedValueRefMasamuneFormPageScopedValueRefExtensions on QueryScopedValueRef<PageOrAppScopedValueOrAppRef>
Create an extension method for QueryScopedValueRef to handle Query for form.
QueryScopedValueRefPageOrWidgetScopedValueRefCacheExtensions on QueryScopedValueRef<PageOrWidgetScopedValueRef>
Provides an extension method for QueryScopedValueRef to perform caching.
QueryScopedValueRefPageOrWidgetScopedValueRefWatchExtensions on QueryScopedValueRef<PageOrWidgetScopedValueRef>
Provides an extended method for QueryScopedValueRef to monitor ChangeNotifier.
QueryScopedValueRefQueryExtensions on QueryScopedValueRef<TRef>
Provides an extension method for QueryScopedValueRef to manage state using ScopedQuery.
RandomExtensions on Random
Provides extended methods for Random.
RefQueryExtensions on Ref
Provides an extension method for Ref to manage state using ScopedQuery.
RouteQueryRouterExtensions on RouteQuery
Provides extension methods for RouteQuery.
RoutingBuildContedxtExtensions on BuildContext
Provides extension methods for BuildContext.
RoutingNavigatorStateExtensions on NavigatorState
Provides extension methods for NavigatorState.
ScopedWidgetBuildContextExtensions on BuildContext
ScopedWidget related extensions for BuildContext.
SetExtensions on Set<T>
Provides extended methods for Set.
SpaceShortenExtensions on num
Extension to make it easier to describe spaces in num.
StringExtensions on String
Provides extended methods for String.
StringToColorExtensions on String
Extensions for String.
ThemeBuildContextExtensions on BuildContext
Define a theme extension for BuildContext.
ThemeColorExtensions on Color
Define a theme extension for Color.
ThemeDataExtensions on ThemeData
Define a theme extension for ThemeData.
ThemeExtensionExtensions on ThemeExtension<T>
Define a theme extension for ThemeExtension.
ThemeTextStyleExtensions on TextStyle
Define a theme extension for TextStyle.
UriExtensions on Uri
Provides extended methods for Uri.

Constants

appRoute → const AppRoute
Automatically generates routing for the entire application.
appTheme → const AppTheme
Annotation to be given to the theme of the application.
formValue → const FormValue
Create a query to retrieve form controllers.
hiddenPage → const HiddenPage
Pages to be used in nested navigators instead of at the top level or to intentionally not set URLs.
jsonParam → const JsonParam
Ensure that serializable parameters can be successfully serialized to Json.
katanaIndicatorTracePrefix → const String
Prefix used for indicator visibility performance traces.
katanaModelLoadTracePrefix → const String
Prefix used for model loading performance traces.
kAvatarTileHeight → const double
Default height of AvatarTile.
kBlackColor → const Color
Black for design.
kBlackSurfaceColor → const Color
Bright black color for design.
kDefaultCheckboxBorderWidth → const double
Width of the border outside the default checkbox.
kDefaultLocales → const List<Locale>
Default locale.
kDefaultSearchableFieldKey → const String
Default field key to form a searchable field.
kFormMultiMediaInlineHeight → const double
Default height of the form when using FormMultiMediaInlineDelegate.
kPinLength → const int
Default maximum pin length.
kSplashColor → const Color
Splash color.
kTimeFieldKey → const String
Field key to store the document update time.
kTransitionDuration → const Duration
Duration of page transitions.
kTypeFieldKey → const String
Field key to save the type of the special object in the field.
kUidFieldKey → const String
Field key to store the last part of the document path (ddd for aaa/bbb/ccc/ddd).
kWhiteColor → const Color
White for design.
kWhiteSurfaceColor → const Color
Dark white for design.
nullOfBool → const bool?
A null object with a defined type of bool?
nullOfDouble → const double?
A null object with a defined type of double?
nullOfDynamicList → const DynamicList?
A null object with a defined type of DynamicList?
nullOfDynamicMap → const DynamicMap?
A null object with a defined type of DynamicMap?
nullOfInt → const int?
A null object with a defined type of int?
nullOfNum → const num?
A null object with a defined type of num?
nullOfString → const String?
A null object with a defined type of String?
pageParam → const PageParam
Annotation to map each widget parameter to a variable in the page root.
pageRouteQuery → const PageRouteQuery
Annotation to define the RouteQuery of the page.
queryParam → const QueryParam
Annotation to map each widget parameter to a query parameter in the page path.
refParam → const RefParam
When specifying a CollectionModelPath or DocumentModelPath field, you can load the referenced document together by specifying it in the field when referencing other documents.
searchParam → const SearchParam
When specifying each field in CollectionModelPath or DocumentModelPath, you can annotate the field to make it a search target.
useResult → const UseResult
Used to annotate a method, field, or getter within a class, mixin, or extension, or a or top-level getter, variable or function to indicate that the value obtained by invoking it should be used. A value is considered used if it is assigned to a variable, passed to a function, or used as the target of an invocation, or invoked (if the result is itself a function).
vectorParam → const VectorParam
It is possible to make a field eligible for similarity search by annotating it when specifying each field of CollectionModelPath or DocumentModelPath.
zeroOfNum → const num
A 0 object with a defined type of num?

Properties

sprintf ↔ PrintFormat
getter/setter pair

Functions

executeGuarded(BuildContext context, FutureOr<void> process(), {Color? barrierColor = Colors.black54, Widget? indicator, void onError(Object error, StackTrace stackTrace)?}) → Future<void>
process and display the indicator during the process.
generateCode(int length, {int seed = 0, String charSet = "23456789abcdefghjkmnpqrstuvwxy"}) → String
Generates and returns a random string with the number of characters given by length.
generateRandomMaterialColor({List<Color>? ignoreColors, int? seed}) → MaterialColor
Get one at random from the major MaterialColor.
initializeDateFormatting([String? locale, String? ignored]) → Future<void>
This should be called for at least one locale before any date formatting methods are called. It sets up the lookup for date symbols. Both the locale and ignored parameter are ignored, as the data for all locales is directly available.
jsonDecodeAsList<T extends Object?>(String json, [List<T> defaultValue = const []]) → List<T>
Converts json to a Json-decoded List<dynamic> object.
jsonDecodeAsMap<T extends Object?>(String json, [Map<String, T> defaultValue = const {}]) → Map<String, T>
Converts json to a Json-decoded Map<String, dynamic> object.
jsonEncodable(Object? o) → bool
If this object is Json encodable, true is returned.
masamuneApplyTestMocks({bool ensureInitialized = true, ScopedValueContainer? scopedValueContainer, AuthAdapter? authAdapter, StorageAdapter? storageAdapter, FunctionsAdapter? functionsAdapter, PlatformInfoAdapter? platformInfoAdapter, List<LoggerAdapter> loggerAdapters = const [], List<MasamuneAdapter> masamuneAdapters = const [], ModelAdapter? modelAdapter, DateTime? testCurrentTime}) → void
Test adapters and containers can be specified and replaced.
nullOfList<T>() → List<T>?
A null object with a defined type of List<T>?
nullOfMap<K, V>() → Map<K, V>?
A null object with a defined type of Map<K, V>?
nullOfSet<T>() → Set<T>?
A null object with a defined type of Set<T>?
runMasamuneApp(MasamuneApp masamuneApp(MasamuneRef ref), {List<MasamuneAdapter> masamuneAdapters = const [], List<LoggerAdapter> loggerAdapters = const []}) → Future<void>
Function to apply MasamuneAdapter for Masamune Framework just before runApp, etc.
showIndicator(BuildContext context, FutureOr<void> process(), {Color? barrierColor = Colors.black54, Widget? indicator}) → Future<void>
process and display the indicator during the process.
uuid({DateTime? baseTime, bool reverse = false}) → String
Generate and retrieve the UUID for Version 7.
wait(Iterable futures) → Future<void>
Wait until all Futures given in futures are completed.

Typedefs

ApiResponse = Response
An HTTP response where the entire response body is known in advance.
ApiResquest = Request
An HTTP request where the entire request body is known in advance.
ChipBuilder<T> = Widget Function(BuildContext context, FormChipsInputRef<T> ref, T item)
Builder for use with FormChipsField.
DynamicList = List
Represents the type of List<dynamic>.
DynamicMap = Map<String, dynamic>
Represents the type of Map<String, dynamic>.
ListBuilderCallback<T> = List<Widget>? Function(BuildContext context, T item, int index)
Callbacks used by ListBuilder.
ListTileGroup = LineTileGroup
A widget that groups ListTile and LineTile for display.
ModelQueryFilterCallback = Object? Function(String key, Object? value)
Callback function for filtering objects.
ModelRef<T> = ModelRefBase<T>?
Class for defining relationships between models.
PickerItemBuilder = Widget? Function(BuildContext context, String? text, Widget? child, bool selected, int col, int index)
Picker item builder.

Exceptions / Errors

DatabaseValidationExcepction
Defines errors during database validation.
RestApiFunctionsAdapterException
Exception raised when execution fails.
RestApiModelAdapterException
Exception raised when execution fails.