masamune_model_firebase_data_connect_annotation library
Define annotations to use the masamune builder. Build with masamune_builder using this annotation.
To use, import package:masamune_model_firebase_data_connect_annotation/masamune_model_firebase_data_connect_annotation.dart
.
Classes
- Api
- Provides static methods for making HTTP requests.
- CollectionModelPath
- Annotation to create a collection model.
- Controller
- Annotation for creating queries for controllers.
- ControllerGroup
- Annotation to create a query for a group of controllers.
- DateDuration
- A class that represents a date period.
- DateFormat
- DateFormat is for formatting and parsing dates in a locale-sensitive manner.
- DocumentModelPath
- Annotation for creating a documentation model.
- FirebaseDataConnect
- Annotation for use as a data scheme for FirebaseDataConnect.
- FirebaseDataConnectAdapter
- Annotation to generate a ModelAdapter for use with FirebaseDataConnect.
- FormValue
- Create a query to retrieve form controllers.
- GoogleSpreadSheetDataSource
- Create a data source adapter based on a Google spreadsheet.
- Immutable
- Used to annotate a class.
- JsonParam
- Ensure that serializable parameters can be successfully serialized to Json.
- ModelDatabaseQuery
- Base class for creating queries to access the database.
- ModelDatabaseQueryGroup
- A query group that summarizes ModelDatabaseQuery.
- ModelPermissionQuery
- Define a query to validate data permissions.
-
NumRange<
TNum extends num> - A class that represents a range of numbers.
- ParamComment
- When specifying each field in CollectionModelPath or DocumentModelPath, it is possible to annotate the field with a comment.
-
RectRange<
TNum extends num> - A class that represents a range of numbers.
- 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.
- Required
-
Used to annotate a named parameter
p
in a method or functionf
. - SearchParam
- When specifying each field in CollectionModelPath or DocumentModelPath, you can annotate the field to make it a search target.
- UseResult
- See useResult for more details.
Enums
- DayOfWeek
- Day of the week.
- GoogleSpreadSheetDataSourceDirection
- Orientation for using data source for documents at GoogleSpreadSheetDataSource.
- ModelDatabaseQueryFilterType
- Define the filter type for ModelDatabaseQuery.
- ModelPermissionQueryType
- Specifies the permission type for validation.
- ModelPermissionQueryUserType
- Specify the target user for which you want to specify ModelPermissionQueryType.
Extensions
- BooleanExtensions on bool
- Provides extended methods for bool.
- 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.
-
DynamicMapExtensions
on Map<
String, dynamic> - Provides extended methods for DynamicMap.
-
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.
-
ListExtensions
on List<
T> -
Provides extended methods for List in
T
. -
MapExtensions
on Map<
K, V> - Provides extended methods for Map.
- NullableDoubleExtensions on double?
- Provides an extension method for double 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.
- 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.
- RandomExtensions on Random
- Provides extended methods for Random.
-
SetExtensions
on Set<
T> - Provides extended methods for Set.
- StringExtensions on String
- Provides extended methods for String.
- UriExtensions on Uri
- Provides extended methods for Uri.
Constants
- firebaseDataConnect → const FirebaseDataConnect
- Annotation for use as a data scheme for FirebaseDataConnect.
- firebaseDataConnectAdapter → const FirebaseDataConnectAdapter
- Annotation to generate a ModelAdapter for use with FirebaseDataConnect.
- formValue → const FormValue
- Create a query to retrieve form controllers.
- jsonParam → const JsonParam
- Ensure that serializable parameters can be successfully serialized to Json.
- 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? - 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).
- zeroOfNum → const num
-
A
0
object with a defined type of num?
Properties
- sprintf ↔ PrintFormat
-
getter/setter pair
Functions
-
generateCode(
int length, {int seed = 0, String charSet = "23456789abcdefghjkmnpqrstuvwxy"}) → String -
Generates and returns a random string with the number of characters given by
length
. -
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 thelocale
andignored
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 -
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. -
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>? -
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.
- DynamicList = List
- Represents the type of List<dynamic>.
-
DynamicMap
= Map<
String, dynamic> - Represents the type of Map<String, dynamic>.