GetDeferredPaymentsQuery class

List or search the wallet's deferred payments. Answered with DeferredPaymentsResponse (or an ErrorEvent with source getDeferredPayments).

By default only outstanding payments (still held, not known to be on the network), newest first, 50 per page. Use olderThan or createdBefore to find the payments whose recipient has not broadcast them yet, and includeResolved (or states) to include seen, mined, failed and cancelled ones: nothing is ever deleted.

Inheritance

Constructors

GetDeferredPaymentsQuery({required String walletId, Set<DeferredPaymentState>? states, bool includeResolved = false, DateTime? createdBefore, DateTime? createdAfter, Duration? olderThan, Set<String>? lastNetworkStatuses, String? invoiceId, String? recipientAddress, DateTime? dueBefore, int limit = 50, String? cursor, bool oldestFirst = false, bool includeBeef = true, String? requestId})

Properties

correlationId → String
The correlation ID of the message.
no setterinherited
createdAfter → DateTime?
Only payments recorded at or after this instant.
final
createdBefore → DateTime?
Only payments recorded strictly before this instant.
final
cursor → String?
DeferredPaymentsResponse.nextCursor of the previous page.
final
dueBefore → DateTime?
Only payments with a deadline at or before this instant (bead libspiffy-8442).
final
hashCode → int
The hash code for this object.
no setterinherited
includeBeef → bool
Rebuild each payment's BEEF from the stored ancestors and proofs.
final
includeResolved → bool
List every state (outstanding, seen, mined, failed, cancelled).
final
invoiceId → String?
final
lastNetworkStatuses → Set<String>?
Only payments whose last recorded network status is one of these (ARC names such as SEEN_ON_NETWORK, NOT_FOUND, or DeferredNetworkStatus.unchecked for never checked).
final
limit → int
Page size (1 to 1000).
final
metadata → Map<String, dynamic>
The metadata of the message.
no setter
olderThan → Duration?
Only payments recorded more than this long ago (combined with createdBefore: the earlier bound wins).
final
oldestFirst → bool
final
recipientAddress → String?
Only payments paying this address.
final
replyTimeout → Duration
How long WalletCoordinator.ask waits for the reply when the caller gives no timeout. A request that is still running then is not cancelled: its reply arrives on the event stream later.
no setterinherited
replyTo → ActorRef?
The actor to reply to.
no setterinherited
requestId → String
Identifies this request; its reply carries it back.
finalinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
states → Set<DeferredPaymentState>?
States to list; overrides includeResolved. Default: outstanding only.
final
timestamp → DateTime
The timestamp of the message.
finalinherited
walletId → String
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toStorageQuery({DateTime? now}) → DeferredPaymentQuery
The storage query this message asks for, evaluated at now.
toString() → String
A string representation of this object.
inherited

Operators

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