Collaboration

Roles and Sharing

var collaboration = new CollaborationService();
collaboration.RegisterUser(new CollaborationUser { Id = "alice", DisplayName = "Alice" });
collaboration.RegisterUser(new CollaborationUser { Id = "bob", DisplayName = "Bob" });

collaboration.Share("diagram", ownerId: "alice", ("bob", CollaborationRole.Commenter));
collaboration.Grant("diagram", requesterId: "alice", userId: "bob", role: CollaborationRole.Editor);
collaboration.SetPublic("diagram", requesterId: "alice", isPublic: true);   // read-only link

Comments and Pins

Comments can be anchored to a component, which makes them review notes rather than chat. Anchored comments are drawn as numbered pins on the component's corner through CommentPinLayer, and resolved comments disappear from the canvas.

var comment = collaboration.AddComment("diagram", "bob", "This step needs a guard", "DecisionNode");
collaboration.ResolveComment("diagram", comment.Id, "alice");

// pins follow component geometry automatically
pinLayer.Rebuild(manager.GetComponents(), collaboration.GetComments("diagram"));
pinLayer.Draw(canvas);

Presence

Presence records who is active on a document and what they are doing. Entries expire automatically, so a crashed client does not appear online forever:

collaboration.SetPresence("diagram", "bob", "editing");
foreach (var entry in collaboration.GetPresence("diagram", TimeSpan.FromMinutes(2)))
    Console.WriteLine($"{entry.UserId} {entry.Activity} ({entry.LastSeen:HH:mm:ss})");

Audit Trail

Every share, grant, revoke, comment and resolve is recorded with the user and timestamp, which gives reviewers a history of the document's access and review decisions.

Persistence

Collaboration state is saved next to the diagram with CollaborationSerializer. Presence is intentionally excluded (it is ephemeral); everything else — users, shares, comments, audit — round-trips.

CollaborationSerializer.Save(collaboration, "diagram.collaboration.json");
var restored = CollaborationSerializer.Load("diagram.collaboration.json");

Collaboration Types

Review data is stored as plain records so it can be persisted and audited: users and shares, presence, comment pins and the audit trail.

UserRecord

JSON-friendly user record (color stored as 0xAARRGGBB).

CollaborationSnapshot

Serializable collaboration state (users, shares, comments, audit). Presence is intentionally excluded — it is ephemeral.

PresenceEntry

Live presence for a user on a document.

DocumentShare

Sharing state of a diagram document.

AuditEntry

An audit-trail entry for a collaboration action.

CommentPin

A comment pin anchored to a component in the diagram.