RpcCommandOptions class

RpcCommandOptions specifies options for commands generated from protobuf rpc methods.

Inheritance
  • Object
  • GeneratedMessage
  • RpcCommandOptions

Constructors

RpcCommandOptions.new({String? rpcMethod, String? use, String? long, String? short, String? example, Iterable<String>? alias, Iterable<String>? suggestFor, String? deprecated, String? version, Map<String, FlagOptions>? flagOptions, Iterable<PositionalArgDescriptor>? positionalArgs, bool? skip})
factory
RpcCommandOptions.fromBuffer(List<int> i, [ExtensionRegistry r = $pb.ExtensionRegistry.EMPTY])
factory
RpcCommandOptions.fromJson(String i, [ExtensionRegistry r = $pb.ExtensionRegistry.EMPTY])
factory

Properties

alias → List<String>
alias is an array of aliases that can be used instead of the first word in Use.
no setter
deprecated ↔ String
deprecated defines, if this command is deprecated and should print this string when used.
getter/setter pair
eventPlugin → EventPlugin?
Subclasses can override this getter to be notified of changes to protobuf fields.
no setterinherited
example ↔ String
example is examples of how to use the command.
getter/setter pair
flagOptions → Map<String, FlagOptions>
flag_options are options for flags generated from rpc request fields. By default all request fields are configured as flags. They can also be configured as positional args instead using positional_args.
no setter
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
long ↔ String
long is the long message shown in the 'help
getter/setter pair
positionalArgs → List<PositionalArgDescriptor>
positional_args specifies positional arguments for the command.
no setter
rpcMethod ↔ String
rpc_method is short name of the protobuf rpc method that this command is generated from.
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
short ↔ String
short is the short description shown in the 'help' output.
getter/setter pair
skip ↔ bool
skip specifies whether to skip this rpc method when generating commands.
getter/setter pair
suggestFor → List<String>
suggest_for is an array of command names for which this command will be suggested - similar to aliases but only suggests.
no setter
unknownFields → UnknownFieldSet
no setterinherited
use ↔ String
use is the one-line usage method. It also allows specifying an alternate name for the command as the first word of the usage text.
getter/setter pair
version ↔ String
version defines the version for this command. If this value is non-empty and the command does not define a "version" flag, a "version" boolean flag will be added to the command and, if specified, will print content of the "Version" variable. A shorthand "v" flag will also be added if the command does not define one.
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
clearDeprecated() → void
clearExample() → 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
clearLong() → void
clearRpcMethod() → void
clearShort() → void
clearSkip() → void
clearUse() → void
clearVersion() → void
clone() → RpcCommandOptions
Creates a deep copy of the fields in this message. (The generated code uses mergeFromMessage.)
override
copyWith(void updates(RpcCommandOptions)) → RpcCommandOptions
Apply updates to a copy of this message.
override
createEmptyInstance() → RpcCommandOptions
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
hasExample() → 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
hasLong() → bool
hasRequiredFields() → bool
Whether the message has required fields.
inherited
hasRpcMethod() → bool
hasShort() → bool
hasSkip() → bool
hasUse() → bool
hasVersion() → 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

Operators

operator ==(Object other) → bool
The equality operator.
inherited