CommandPayloadDefinition class abstract

Available extensions

• CommandPayloadDefinitionPatterns

Annotations

• @freezed

Constructors

CommandPayloadDefinition({required String parameter, String? description, @CommandPayloadDataTypeConverter() required CommandPayloadDataType dataType, bool? isRequired, num? minValue, num? maxValue, int? minLength, int? maxLength, List<String>? choices, @RegExpOrNullConverter() RegExp? regexPattern, List<CommandPayloadDefinition>? nested, int? maxQuantity})

const

factory

CommandPayloadDefinition.fromJson(Map<String, dynamic> json)

factory

Properties

choices → List<String>?

choices is the list of choices of the parameter. Only for CommandPayloadDataType.choice

no setter, inherited

copyWith → $CommandPayloadDefinitionCopyWith<CommandPayloadDefinition>

Create a copy of CommandPayloadDefinition with the given fields replaced by the non-null parameter values.

no setter, inherited

dataType → CommandPayloadDataType

dataType is the data type of the parameter.

no setter, inherited

description → String?

description is the fallback name of the parameter, when the translation is not available.

no setter, inherited

hashCode → int

The hash code for this object.

no setter, inherited

isRequired → bool?

isRequired is the parameter is required.

no setter, inherited

maxLength → int?

maxLength is the maximum length of the parameter. Only for CommandPayloadDataType.string

no setter, inherited

maxQuantity → int?

maxQuantity is the maximum quantity of the nested parameters.

no setter, inherited

maxValue → num?

maxValue is the maximum value of the parameter. Only for CommandPayloadDataType.integer and CommandPayloadDataType.float

no setter, inherited

minLength → int?

minLength is the minimum length of the parameter. Only for CommandPayloadDataType.string

no setter, inherited

minValue → num?

minValue is the minimum value of the parameter. Only for CommandPayloadDataType.integer and CommandPayloadDataType.float

no setter, inherited

nested → List<CommandPayloadDefinition>?

nested is the nested object of the parameter. Only for CommandPayloadDataType.nested

no setter, inherited

parameter → String

parameter is the name of the parameter, this is also the translation key.

no setter, inherited

regexPattern → RegExp?

regexPattern is the regex pattern of the parameter.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

map<TResult extends Object?>(TResult $default(_CommandPayloadDefinition value)) → TResult

Available on CommandPayloadDefinition, provided by the CommandPayloadDefinitionPatterns extension

A switch-like method, using callbacks.

mapOrNull<TResult extends Object?>(TResult? $default(_CommandPayloadDefinition value)?) → TResult?

Available on CommandPayloadDefinition, provided by the CommandPayloadDefinitionPatterns extension

A variant of map that fallback to returning null.

maybeMap<TResult extends Object?>(TResult $default(_CommandPayloadDefinition value)?, {required TResult orElse()}) → TResult

Available on CommandPayloadDefinition, provided by the CommandPayloadDefinitionPatterns extension

A variant of map that fallback to returning orElse.

maybeWhen<TResult extends Object?>(TResult $default(String parameter, String? description, CommandPayloadDataType dataType, bool? isRequired, num? minValue, num? maxValue, int? minLength, int? maxLength, List<String>? choices, RegExp? regexPattern, List<CommandPayloadDefinition>? nested, int? maxQuantity)?, {required TResult orElse()}) → TResult

Available on CommandPayloadDefinition, provided by the CommandPayloadDefinitionPatterns extension

A variant of when that fallback to an orElse callback.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toJson() → Map<String, dynamic>

Serializes this CommandPayloadDefinition to a JSON map.

inherited

toString() → String

A string representation of this object.

inherited

when<TResult extends Object?>(TResult $default(String parameter, String? description, CommandPayloadDataType dataType, bool? isRequired, num? minValue, num? maxValue, int? minLength, int? maxLength, List<String>? choices, RegExp? regexPattern, List<CommandPayloadDefinition>? nested, int? maxQuantity)) → TResult

Available on CommandPayloadDefinition, provided by the CommandPayloadDefinitionPatterns extension

A switch-like method, using callbacks.

whenOrNull<TResult extends Object?>(TResult? $default(String parameter, String? description, CommandPayloadDataType dataType, bool? isRequired, num? minValue, num? maxValue, int? minLength, int? maxLength, List<String>? choices, RegExp? regexPattern, List<CommandPayloadDefinition>? nested, int? maxQuantity)?) → TResult?

Available on CommandPayloadDefinition, provided by the CommandPayloadDefinitionPatterns extension

A variant of when that fallback to returning null

Operators

operator ==(Object other) → bool

The equality operator.

inherited