MessageOptions class
Inheritance
Object GeneratedMessage
MessageOptions
Properties
deprecated ↔ bool
Is this message deprecated?
Depending on the target platform, this can emit Deprecated annotations
for the message, or it will be completely ignored; in the very least,
this is a formalization for deprecating messages.
getter/setter pair
eventPlugin → EventPlugin?
Subclasses can override this getter to be notified of changes
to protobuf fields.
no setter inherited
hashCode → int
Calculates a hash code based on the contents of the protobuf.
no setter inherited
info_ → BuilderInfo
no setter override
isFrozen → bool
Returns true if this message is marked read-only. Otherwise false.
no setter inherited
mapEntry ↔ bool
Whether the message is an automatically generated map entry type for the
maps field.
getter/setter pair
messageSetWireFormat ↔ bool
Set true to use the old proto1 MessageSet wire format for extensions.
This is provided for backwards-compatibility with the MessageSet wire
format. You should not use this for any other reason: It's less
efficient, has fewer features, and is more complicated.
getter/setter pair
noStandardDescriptorAccessor ↔ bool
Disables the generation of the standard "descriptor()" accessor, which can
conflict with a field of the same name. This is meant to make migration
from proto1 easier; new code should avoid fields named "descriptor".
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setter inherited
uninterpretedOption → List <UninterpretedOption
The parser stores options it doesn't recognize here. See above.
no setter
unknownFields → UnknownFieldSet
no setter inherited
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
clearDeprecated ()
→ 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
clearMapEntry ()
→ void
clearMessageSetWireFormat ()
→ void
clearNoStandardDescriptorAccessor ()
→ void
clone ()
→ MessageOptions
Creates a deep copy of the fields in this message.
(The generated code uses mergeFromMessage .)
override
copyWith (void updates (MessageOptions → MessageOptions
Apply updates to a copy of this message.
override
createEmptyInstance ()
→ MessageOptions
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
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
hasDeprecated ()
→ bool
hasExtension (Extension extension → bool
Returns true if a value of extension is present.
inherited
hasField (int tagNumber → bool
Whether this message has a field associated with tagNumber.
inherited
hasMapEntry ()
→ bool
hasMessageSetWireFormat ()
→ bool
hasNoStandardDescriptorAccessor ()
→ bool
hasRequiredFields ()
→ bool
Whether the message has required fields.
inherited
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 by
GeneratedMessage.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 other into 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
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
