Payload class

An owner registers a data room with a host. 0.2 adds recordRetention: how long the room keeps its records by age, stated at creation so that no record is ever removed under a rule its readers could not have read.

Constructors

Payload({required String roomId, required Visibility visibility, required String ownerDid, RetentionPolicy? retentionPolicy, int? retentionDays, AnchorCadence? anchorCadence, RecordRetention? recordRetention, Ext? ext})
const
Payload.fromJson(Map<String, dynamic> json)
Read this payload from a decoded JSON object.
factory

Properties

anchorCadence → AnchorCadence?
What this room intends about anchoring. OPTIONAL; absent reads as manual, which draws no expectation and is the honest default for a room whose owner has not decided. A host stores it and serves it back — it constrains nothing the host does.
final
ext → Ext?
Ecosystem-defined extension members per SPEC.md §4.5.1.
final
hashCode → int
The hash code for this object.
no setterinherited
ownerDid → String
The room's accountable party: the controller of the room's identifier, the issuer of every credential in it, and the party a host addresses about quota, abuse, or lifecycle. Visible at every visibility, including private — a room has someone answerable for it.
final
recordRetention → RecordRetention?
How long the room keeps its records, by age: which records rooms/records/prune may remove. OPTIONAL; absent means no record is ever eligible by age. Unlike retentionPolicy it is not fixed: a holder of admin changes it with rooms/records/retention/set.
final
retentionDays → int?
How long the host will hold the room after its epoch lapses without renewal, before storage may be reclaimed. Stated at creation rather than discovered: reclamation that surprises a member is a failure of the design, not of the member.
final
retentionPolicy → RetentionPolicy?
Whether this room keeps its history readable across a membership change. Absent means chained, which is the choice a room wants unless it has a reason not to: joining a room should mean being able to read it. A host MUST reject an epoch link for a room whose policy is fromJoin rather than storing one it declared it would not have.
final
roomId → String
The room's identifier, minted by its owner before this call. A host is told the identifier; it does not assign one, because a room whose identity the host chose could not move to another host.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
visibility → Visibility
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