Value class
A message that can hold any of the supported value types.
- Inheritance
-
- Object
- GeneratedMessage
- Value
Constructors
-
Value({bool? booleanValue, Int64? integerValue, double? doubleValue, String? referenceValue, MapValue? mapValue, LatLng? geoPointValue, ArrayValue? arrayValue, Timestamp? timestampValue, NullValue? nullValue, String? stringValue, List<
int> ? bytesValue}) -
factory
-
Value.fromBuffer(List<
int> i, [ExtensionRegistry r = $pb.ExtensionRegistry.EMPTY]) -
factory
- Value.fromJson(String i, [ExtensionRegistry r = $pb.ExtensionRegistry.EMPTY])
-
factory
Properties
- arrayValue ↔ ArrayValue
-
An array value.
getter/setter pair
- booleanValue ↔ bool
-
A boolean value.
getter/setter pair
-
bytesValue
↔ List<
int> -
A bytes value.
getter/setter pair
- doubleValue ↔ double
-
A double value.
getter/setter pair
- eventPlugin → EventPlugin?
-
Subclasses can override this getter to be notified of changes
to protobuf fields.
no setterinherited
- geoPointValue ↔ LatLng
-
A geo point value representing a point on the surface of Earth.
getter/setter pair
- hashCode → int
-
Calculates a hash code based on the contents of the protobuf.
no setterinherited
- info_ → BuilderInfo
-
no setteroverride
- integerValue ↔ Int64
-
An integer value.
getter/setter pair
- isFrozen → bool
-
Returns
trueif this message is marked read-only. Otherwisefalse.no setterinherited - mapValue ↔ MapValue
-
A map value.
getter/setter pair
- nullValue ↔ NullValue
-
A null value.
getter/setter pair
- referenceValue ↔ String
-
A reference to a document. For example:
projects/{project_id}/databases/{database_id}/documents/{document_path}.getter/setter pair - runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- stringValue ↔ String
-
A string value.
getter/setter pair
- timestampValue ↔ Timestamp
-
A timestamp value.
getter/setter pair
- unknownFields → UnknownFieldSet
-
no setterinherited
Methods
-
addExtension(
Extension extension, Object? value) → void -
Adds an extension field value to a repeated field.
inherited
-
check(
) → void -
inherited
-
clear(
) → void -
Clears all data that was set in this message.
inherited
-
clearArrayValue(
) → void -
clearBooleanValue(
) → void -
clearBytesValue(
) → void -
clearDoubleValue(
) → void -
clearExtension(
Extension extension) → void -
Clears an extension field and also removes the extension.
inherited
-
clearField(
int tagNumber) → void -
Clears the contents of a given field.
inherited
-
clearGeoPointValue(
) → void -
clearIntegerValue(
) → void -
clearMapValue(
) → void -
clearNullValue(
) → void -
clearReferenceValue(
) → void -
clearStringValue(
) → void -
clearTimestampValue(
) → void -
clearValueType(
) → void -
clone(
) → Value -
Creates a deep copy of the fields in this message.
(The generated code uses mergeFromMessage.)
override
-
copyWith(
void updates(Value)) → Value -
Apply
updatesto a copy of this message.override -
createEmptyInstance(
) → Value -
Creates an empty instance of the same message type as this.
override
-
createMapField<
K, V> (int tagNumber, MapFieldInfo< K, V> fi) → Map<K, V> -
Creates a Map representing a map field.
inherited
-
createRepeatedField<
T> (int tagNumber, FieldInfo< T> fi) → List<T> -
Creates List implementing a mutable repeated field.
inherited
-
ensureArrayValue(
) → ArrayValue -
ensureGeoPointValue(
) → LatLng -
ensureMapValue(
) → MapValue -
ensureTimestampValue(
) → Timestamp -
extensionsAreInitialized(
) → bool -
inherited
-
freeze(
) → GeneratedMessage -
Make this message read-only.
inherited
-
getDefaultForField(
int tagNumber) → dynamic -
Returns the default value for the given field.
inherited
-
getExtension(
Extension extension) → dynamic -
Returns the value of
extension.inherited -
getField(
int tagNumber) → dynamic -
Returns the value of the field associated with
tagNumber, or the default value if it is not set.inherited -
getFieldOrNull(
int tagNumber) → dynamic -
Returns the value of a field, ignoring any defaults.
inherited
-
getTagNumber(
String fieldName) → int? -
inherited
-
hasArrayValue(
) → bool -
hasBooleanValue(
) → bool -
hasBytesValue(
) → bool -
hasDoubleValue(
) → bool -
hasExtension(
Extension extension) → bool -
Returns
trueif a value ofextensionis present.inherited -
hasField(
int tagNumber) → bool -
Whether this message has a field associated with
tagNumber.inherited -
hasGeoPointValue(
) → bool -
hasIntegerValue(
) → bool -
hasMapValue(
) → bool -
hasNullValue(
) → bool -
hasReferenceValue(
) → bool -
hasRequiredFields(
) → bool -
Whether the message has required fields.
inherited
-
hasStringValue(
) → bool -
hasTimestampValue(
) → bool -
isInitialized(
) → bool -
Whether all required fields in the message and embedded messages are set.
inherited
-
mergeFromBuffer(
List< int> input, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void -
Merges serialized protocol buffer data into this message.
inherited
-
mergeFromCodedBufferReader(
CodedBufferReader input, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void -
inherited
-
mergeFromJson(
String data, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void -
Merges field values from
data, a JSON object, encoded as described byGeneratedMessage.writeToJson.inherited -
mergeFromJsonMap(
Map< String, dynamic> json, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void -
Merges field values from a JSON object represented as a Dart map.
inherited
-
mergeFromMessage(
GeneratedMessage other) → void -
Merges the contents of the
otherinto this message.inherited -
mergeFromProto3Json(
Object? json, {TypeRegistry typeRegistry = const TypeRegistry.empty(), bool ignoreUnknownFields = false, bool supportNamesWithUnderscores = true, bool permissiveEnums = false}) → void -
Merges field values from
json, a JSON object using proto3 encoding.inherited -
mergeUnknownFields(
UnknownFieldSet unknownFieldSet) → void -
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
setExtension(
Extension extension, Object value) → void -
Sets the value of a non-repeated extension field to
value.inherited -
setField(
int tagNumber, Object value) → void -
Sets the value of a field by its
tagNumber.inherited -
toBuilder(
) → GeneratedMessage -
Creates a writable, shallow copy of this message.
inherited
-
toDebugString(
) → String -
Returns a String representation of this message.
inherited
-
toProto3Json(
{TypeRegistry typeRegistry = const TypeRegistry.empty()}) → Object? -
Returns an Object representing Proto3 JSON serialization of
this.inherited -
toString(
) → String -
Returns a String representation of this message.
inherited
-
whichValueType(
) → Value_ValueType -
writeToBuffer(
) → Uint8List -
inherited
-
writeToCodedBufferWriter(
CodedBufferWriter output) → void -
inherited
-
writeToJson(
) → String -
Returns a JSON string that encodes this message.
inherited
-
writeToJsonMap(
) → Map< String, dynamic> -
Returns the JSON encoding of this message as a Dart Map.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Methods
-
create(
) → Value -
createRepeated(
) → PbList< Value> -
getDefault(
) → Value