Rest class
An annotation used to specify how a field is serialized for a RestAdapter. Heavily inspired by JsonKey
Constructors
Properties
- defaultValue → String?
-
The value to use if the source does not contain this key or if the
value is
null
. Only applicable during deserialization.final - enumAsString → bool
-
By default, all enums from REST are assumed to be delivered as
int
. For APIs that deliver enums asString
(e.g.{"party", "baseball", ...}
). Works for Iterable and single field types ofenum
.final - fromGenerator → String?
-
Manipulates output for the field in the deserialize generator.
The instance's field name is automatically defined. While the build method is ultimately
responsible for how the output is applied, it is most often directly injected as the
value of the field in the deserialize adapter.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- ignore → bool
-
true
if the generator should ignore this field completely. Whentrue
, takes precedence over ignoreFrom and ignoreTo. Defaults tofalse
.final - ignoreFrom → bool
-
true
if this field should be ignored only during deserializization (when remote data is converted to Dart code). Defaults tofalse
.final - ignoreTo → bool
-
true
if this field should be ignored only during serializization (when Dart code is sent to a remote source). Defaults tofalse
.final - name → String?
-
The key name to use when reading and writing values corresponding
to the annotated field.
final
- nullable → bool
-
When
true
,null
fields are handled gracefully when encoding from JSON. This indicates that the payload from REST could benull
and is not related to Dart nullability. Defaults tofalse
.final - runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- toGenerator → String?
-
Manipulates output for the field in the serialize generator.
The serializing key is defined from name or the default naming of the field. While the build method is ultimately
responsible for how the output is applied, it is most often directly injected as the
value of the field in the serialize adapter.
final
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited