Payload class

A relying party asks a wallet (or other approval agent) to obtain user confirmation for an action. The wallet surfaces the reason to the user and returns a signed confirm/response.

Constructors

Payload({required String subject, required String challenge, required String reason, String? actionType, Map<String, dynamic>? actionDetails, int? ttl, Ext? ext})

const

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

Read this payload from a decoded JSON object.

factory

Properties

actionDetails → Ext?

Optional structured payload describing the action — amount, beneficiary, scope, etc. The wallet MAY surface fields to the user. Framework imposes no schema; consumer-defined.

final

actionType → String?

Optional machine-readable action category the wallet MAY use for UI styling, history grouping, or local policy. Free-form; ecosystems define the vocabulary (e.g. "payment.transfer", "acl.delete", "data.share").

final

challenge → String

base64url-encoded nonce ≥128 bits. Echoed and signed in the confirm-response.

final

ext → Ext?

final

hashCode → int

The hash code for this object.

no setter, inherited

reason → String

Human-readable action description shown to the user verbatim. SHOULD be specific ("Confirm transfer of $100 to bob.example" — not "Approve action").

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

subject → String

The VID whose consent the relying party is asking for. The wallet MUST verify it speaks for this VID.

final

ttl → int?

Seconds within which the relying party expects a response. The wallet SHOULD treat as advisory.

final

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toJson() → Map<String, dynamic>

Serialize to a JSON-encodable map, omitting absent members.

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited