Module class
- Inheritance
-
- Object
- GeneratedMessage
- Module
Constructors
-
Module({String? moduleId, String? name, Visibility? visibility, Iterable<VersionHistory>? versions, String? url, String? description, Iterable<Model>? models, Int64? totalRobotUsage, Int64? totalOrganizationUsage, String? organizationId, String? entrypoint, String? publicNamespace, String? firstRun})
-
factory
-
Module.fromBuffer(List<int> i, [ExtensionRegistry r = $pb.ExtensionRegistry.EMPTY])
-
factory
-
Module.fromJson(String i, [ExtensionRegistry r = $pb.ExtensionRegistry.EMPTY])
-
factory
Properties
-
description
↔ String
-
A short description of the module that explains its purpose
getter/setter pair
-
entrypoint
↔ String
-
The executable to run to start the module program
getter/setter pair
-
eventPlugin
→ EventPlugin?
-
Subclasses can override this getter to be notified of changes
to protobuf fields.
no setterinherited
-
firstRun
↔ String
-
The path to a setup script that is run before a newly downloaded module starts.
getter/setter pair
-
hashCode
→ int
-
Calculates a hash code based on the contents of the protobuf.
no setterinherited
-
info_
→ BuilderInfo
-
no setteroverride
-
isFrozen
→ bool
-
Returns
true if this message is marked read-only. Otherwise false.
no setterinherited
-
models
→ List<Model>
-
A list of models that are available in the module
no setter
-
moduleId
↔ String
-
The id of the module (formatted as prefix:name where prefix is the module owner's orgid or namespace)
getter/setter pair
-
name
↔ String
-
The name of the module
getter/setter pair
-
organizationId
↔ String
-
The id of the organization that owns the module
getter/setter pair
-
publicNamespace
↔ String
-
The public namespace of the organization that owns the module
This is empty if no public namespace is set
getter/setter pair
-
runtimeType
→ Type
-
A representation of the runtime type of the object.
no setterinherited
-
totalOrganizationUsage
↔ Int64
-
The total number of organizations using this module
getter/setter pair
-
totalRobotUsage
↔ Int64
-
The total number of robots using this module
getter/setter pair
-
unknownFields
→ UnknownFieldSet
-
no setterinherited
-
url
↔ String
-
The url to reference for documentation, code, etc.
getter/setter pair
-
versions
→ List<VersionHistory>
-
The versions of the module that are available
When this is returned from the backend, the versions are sorted in ascending order by the semver version
no setter
-
visibility
↔ Visibility
-
The visibility of the module
getter/setter pair
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
-
clearDescription()
→ void
-
-
clearEntrypoint()
→ 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
-
clearFirstRun()
→ void
-
-
clearModuleId()
→ void
-
-
clearName()
→ void
-
-
clearOrganizationId()
→ void
-
-
clearPublicNamespace()
→ void
-
-
clearTotalOrganizationUsage()
→ void
-
-
clearTotalRobotUsage()
→ void
-
-
clearUrl()
→ void
-
-
clearVisibility()
→ void
-
-
clone()
→ Module
-
Creates a deep copy of the fields in this message.
(The generated code uses mergeFromMessage.)
override
-
copyWith(void updates(Module))
→ Module
-
Apply
updates to a copy of this message.
override
-
createEmptyInstance()
→ Module
-
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
-
hasDescription()
→ bool
-
-
hasEntrypoint()
→ 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
-
hasFirstRun()
→ bool
-
-
hasModuleId()
→ bool
-
-
hasName()
→ bool
-
-
hasOrganizationId()
→ bool
-
-
hasPublicNamespace()
→ bool
-
-
hasRequiredFields()
→ bool
-
Whether the message has required fields.
inherited
-
hasTotalOrganizationUsage()
→ bool
-
-
hasTotalRobotUsage()
→ bool
-
-
hasUrl()
→ bool
-
-
hasVisibility()
→ 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 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
