GeneratedMessage class

The base class for all protobuf message types.

The protoc plugin generates subclasses providing type-specific properties and methods.

Public properties and methods added here should also be added to GeneratedMessage_reservedNames and should be unlikely to be used in a proto file.

Constructors

GeneratedMessage()
GeneratedMessage.fromBuffer(List<int> input, ExtensionRegistry extensionRegistry)
GeneratedMessage.fromJson(String input, ExtensionRegistry extensionRegistry)

Properties

eventPlugin EventPlugin
Subclasses can override this getter to be notified of changes to protobuf fields.
read-only
hashCode → int
Calculates a hash code based on the contents of the protobuf. [...]
read-only
info_ BuilderInfo
read-only
isFrozen → bool
Returns true if this message is marked read-only. Otherwise false. [...]
read-only
unknownFields UnknownFieldSet
read-only
runtimeType → Type
A representation of the runtime type of the object.
read-only, inherited

Methods

$_ensure<T>(int index) → T
For generated code only.
$_get<T>(int index, T defaultValue) → T
For generated code only.
$_getB(int index, bool defaultValue) → bool
For generated code only.
$_getBF(int index) → bool
For generated code only.
$_getI(int index, int defaultValue) → int
For generated code only.
$_getI64(int index) Int64
For generated code only.
$_getIZ(int index) → int
For generated code only.
$_getList<T>(int index) → List<T>
For generated code only.
$_getMap<K, V>(int index) → Map<K, V>
For generated code only.
$_getN<T>(int index) → T
For generated code only.
$_getS(int index, String defaultValue) → String
For generated code only.
$_getSZ(int index) → String
For generated code only.
$_has(int index) → bool
For generated code only.
$_setBool(int index, bool value) → void
For generated code only.
$_setBytes(int index, List<int> value) → void
For generated code only.
$_setDouble(int index, double value) → void
For generated code only.
$_setFloat(int index, double value) → void
For generated code only.
$_setInt64(int index, Int64 value) → void
For generated code only.
$_setSignedInt32(int index, int value) → void
For generated code only.
$_setString(int index, String value) → void
For generated code only.
$_setUnsignedInt32(int index, int value) → void
For generated code only.
$_whichOneof(int oneofIndex) → int
addExtension(Extension extension, dynamic value) → void
Adds an extension field value to a repeated field. [...]
check() → void
clear() → void
Clears all data that was set in this message. [...]
clearExtension(Extension extension) → void
Clears an extension field and also removes the extension.
clearField(int tagNumber) → void
Clears the contents of a given field. [...]
clone() GeneratedMessage
Creates a deep copy of the fields in this message. (The generated code uses mergeFromMessage.)
copyWith(void updates(GeneratedMessage)) GeneratedMessage
Apply updates to a copy of this message. [...]
createEmptyInstance() GeneratedMessage
Creates an empty instance of the same message type as this.
createMapField<K, V>(int tagNumber, MapFieldInfo<K, V> fi) → Map<K, V>
Creates a Map representing a map field.
createRepeatedField<T>(int tagNumber, FieldInfo<T> fi) → List<T>
Creates List implementing a mutable repeated field. [...]
extensionsAreInitialized() → bool
freeze() GeneratedMessage
Make this message read-only. [...]
getDefaultForField(int tagNumber) → dynamic
Returns the default value for the given field. [...]
getExtension(Extension extension) → dynamic
Returns the value of extension. [...]
getField(int tagNumber) → dynamic
Returns the value of the field associated with tagNumber, or the default value if it is not set.
getFieldOrNull(int tagNumber) → dynamic
Returns the value of a field, ignoring any defaults. [...]
getTagNumber(String fieldName) → int
hasExtension(Extension extension) → bool
Returns true if a value of extension is present.
hasField(int tagNumber) → bool
Returns true if this message has a field associated with tagNumber.
hasRequiredFields() → bool
isInitialized() → bool
Returns true if all required fields in the message and all embedded messages are set, false otherwise.
mergeFromBuffer(List<int> input, [ ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY ]) → void
Merges serialized protocol buffer data into this message. [...]
mergeFromCodedBufferReader(CodedBufferReader input, [ ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY ]) → void
mergeFromJson(String data, [ ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY ]) → void
Merges field values from data, a JSON object, encoded as described by GeneratedMessage.writeToJson. [...]
mergeFromJsonMap(Map<String, dynamic> json, [ ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY ]) → void
Merges field values from a JSON object represented as a Dart map. [...]
mergeFromMessage(GeneratedMessage other) → void
Merges the contents of the other into this message. [...]
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. [...]
mergeUnknownFields(UnknownFieldSet unknownFieldSet) → void
setExtension(Extension extension, dynamic value) → void
Sets the value of a non-repeated extension field to value.
setField(int tagNumber, dynamic value) → void
Sets the value of a field by its tagNumber. [...]
toBuilder() GeneratedMessage
Returns a writable, shallow copy of this message. [...]
toDebugString() → String
Returns a String representation of this message. [...]
toProto3Json({TypeRegistry typeRegistry: const TypeRegistry.empty() }) → Object
Returns an Object representing Proto3 JSON serialization of this. [...]
toString() → String
Returns a String representation of this message. [...]
writeToBuffer() → Uint8List
writeToCodedBufferWriter(CodedBufferWriter output) → void
writeToJson() → String
Returns a JSON string that encodes this message. [...]
writeToJsonMap() → Map<String, dynamic>
Returns the JSON encoding of this message as a Dart Map. [...]
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed.
inherited

Operators

operator ==(dynamic other) → bool
The equality operator. [...]

Static Methods

$_defaultFor<T extends GeneratedMessage>(T createFn()) → T
For generated code only.