PlanLimit class sealed

Usage limits attached to the current API plan.

Implemented types
Available extensions
Annotations
  • @freezed

Constructors

PlanLimit({required int total, required int spent, required int left, @JsonKey.new(name: 'key_total') int? keyTotal, @JsonKey.new(name: 'key_spent') @Default.new(0) int keySpent, @JsonKey.new(name: 'key_left') int? keyLeft, @JsonKey.new(name: 'limited_by', unknownEnumValue: PlanLimitAllowance.unknown) @Default.new(PlanLimitAllowance.subject) PlanLimitAllowance limitedBy})
factory
PlanLimit.fromJson(Map<String, dynamic> json)
Used to build the object from the response of the ISBNdb API.
factory

Properties

copyWith → $PlanLimitCopyWith<PlanLimit>
Create a copy of PlanLimit with the given fields replaced by the non-null parameter values.
no setterinherited
hashCode → int
The hash code for this object.
no setterinherited
keyLeft → int?
Requests remaining for this key, or null when it has no cap.
no setterinherited
keySpent → int
Requests charged today to this key.
no setterinherited
keyTotal → int?
Daily allowance attached to this key, or null when it has no cap.
no setterinherited
left → int
Requests remaining under the more restrictive active allowance.
no setterinherited
limitedBy → PlanLimitAllowance
Allowance that currently determines left.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
spent → int
Requests charged today across the subscription.
no setterinherited
total → int
Daily request allowance shared by every key in the subscription.
no setterinherited

Methods

debugDescribeChildren() → List<DiagnosticsNode>
Returns a list of DiagnosticsNode objects describing this node's children.
inherited
debugFillProperties(DiagnosticPropertiesBuilder properties) → void
Add additional properties associated with the node.
inherited
map<TResult extends Object?>(TResult $default(_PlanLimit value)) → TResult

Available on PlanLimit, provided by the PlanLimitPatterns extension

A switch-like method, using callbacks.
mapOrNull<TResult extends Object?>(TResult? $default(_PlanLimit value)?) → TResult?

Available on PlanLimit, provided by the PlanLimitPatterns extension

A variant of map that fallback to returning null.
maybeMap<TResult extends Object?>(TResult $default(_PlanLimit value)?, {required TResult orElse()}) → TResult

Available on PlanLimit, provided by the PlanLimitPatterns extension

A variant of map that fallback to returning orElse.
maybeWhen<TResult extends Object?>(TResult $default(int total, int spent, int left, int? keyTotal, int keySpent, int? keyLeft, PlanLimitAllowance limitedBy)?, {required TResult orElse()}) → TResult

Available on PlanLimit, provided by the PlanLimitPatterns 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
toDiagnosticsNode({String? name, DiagnosticsTreeStyle? style}) → DiagnosticsNode
Returns a debug representation of the object that is used by debugging tools and by DiagnosticsNode.toStringDeep.
inherited
toJson() → Map<String, dynamic>
Serializes this PlanLimit to a JSON map.
inherited
toString({DiagnosticLevel minLevel = DiagnosticLevel.info}) → String
A string representation of this object.
inherited
toStringDeep({String prefixLineOne = '', String? prefixOtherLines, DiagnosticLevel minLevel = DiagnosticLevel.debug, int wrapWidth = 65}) → String
Returns a string representation of this node and its descendants.
inherited
toStringShallow({String joiner = ', ', DiagnosticLevel minLevel = DiagnosticLevel.debug}) → String
Returns a one-line detailed description of the object.
inherited
toStringShort() → String
A brief description of this object, usually just the runtimeType and the hashCode.
inherited
when<TResult extends Object?>(TResult $default(int total, int spent, int left, int? keyTotal, int keySpent, int? keyLeft, PlanLimitAllowance limitedBy)) → TResult

Available on PlanLimit, provided by the PlanLimitPatterns extension

A switch-like method, using callbacks.
whenOrNull<TResult extends Object?>(TResult? $default(int total, int spent, int left, int? keyTotal, int keySpent, int? keyLeft, PlanLimitAllowance limitedBy)?) → TResult?

Available on PlanLimit, provided by the PlanLimitPatterns extension

A variant of when that fallback to returning null

Operators

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