CollabPayload class

Constructors

CollabPayload({Map<String, String> content = const {}, String? source_, Map<String, String> updates = const {}})

Returns a new CollabPayload instance.

Properties

content ↔ Map<String, String>

Content maps a document field to its ProseMirror markup JSON.

getter/setter pair

hashCode → int

The hash code for this object.

no setter, override

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

source_ ↔ String?

Source is the blob ref a getContent reads the snapshot from. Absent means there is no snapshot to read, which answers empty content.

getter/setter pair

updates ↔ Map<String, String>

Updates carries, per field, a base64 Y.js state update encoding the SAME markup — the front computes it (markupToYDoc → encodeStateAsUpdate) so a createContent seeds the live-editing lane's update log, not just the snapshot blob. Without it a dialog-created description is invisible in the collaborative editor, which replays the ydoc log, never the snapshot.

getter/setter pair

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toJson() → Map<String, dynamic>

toString() → String

A string representation of this object.

override

Operators

operator ==(Object other) → bool

The equality operator.

override

Static Methods

fromJson(dynamic value) → CollabPayload?

Returns a new CollabPayload instance and imports its values from value if it's a Map, null otherwise.

listFromJson(dynamic json, {bool growable = false}) → List<CollabPayload>

mapFromJson(dynamic json) → Map<String, CollabPayload>

mapListFromJson(dynamic json, {bool growable = false}) → Map<String, List<CollabPayload>>

Constants

requiredKeys → const Set<String>

The list of required keys that must be present in a JSON.