CommentThread

CommentThread:

{
  id: string;
  resolved: boolean;
  anchor: CommentThreadAnchor;
  comment: CommentThreadComment;
  replies: CommentThreadReply[];
  reply(body: string): CommentThreadReply | undefined;
  edit(body: string): void;
  resolve(): void;
  unresolve(): void;
  remove(): void;
}

A top-level comment, its flat replies, and the inferred document anchor.

Remarks

CommentThread is the object you work with after querying or creating comments. It exposes the top-level comment separately from flat replies so callers do not need to treat the first item in an array as special.

The mutation methods operate on the underlying document. If you call a method on a queried or newly created thread, a later CommentThreadCollection.all call observes the updated state.

Comment thread mutations apply directly, including inside review transactions. They do not create tracked-change revisions. Use document transactions when you need to batch multiple comment operations with other document edits.

Examples

Reply to an open thread and resolve it:

const [thread] = draft.commentThreads().all({ status: 'open' });

if (thread) {
  thread.reply('Updated the surrounding text.');
  thread.resolve();
}

Edit and then remove a reply:

const [thread] = draft.commentThreads().all();
const [reply] = thread?.replies ?? [];

if (reply) {
  reply.edit('Corrected reply text.');
  reply.remove();
}

Properties

id

id: string

Stable identifier for the top-level comment thread.

---

resolved

resolved: boolean

Whether the top-level comment thread is resolved.

---

anchor

anchor: CommentThreadAnchor

Inferred anchor reconstructed from document content.

---

comment

comment: CommentThreadComment

Top-level comment for this thread.

---

replies

replies: CommentThreadReply[]

Flat replies for this thread, ordered deterministically.

Methods

reply()

reply(body): CommentThreadReply | undefined

Adds a flat reply to this comment thread.

Parameters

body

string

Plain text reply body

Returns

CommentThreadReply | undefined

The created reply, or undefined when no reply can be added

Remarks

Reply bodies are plain text. The SDK assigns author and timestamp metadata from the current author context and clock.

Replying to a resolved comment thread returns undefined and leaves the document unchanged.

---

edit()

edit(body): void

Replaces the top-level comment body’s plain text.

Parameters

body

string

New plain text body for the top-level comment

Returns

void

Remarks

Editing keeps the original creation timestamp metadata. The public API does not expose edit timestamps.

---

resolve()

resolve(): void

Marks this comment thread as resolved.

Returns

void

Remarks

Resolution is explicit and idempotent. Calling resolve() on an already resolved thread leaves it resolved.

---

unresolve()

unresolve(): void

Marks this comment thread as open.

Returns

void

Remarks

Resolution is explicit and idempotent. Calling unresolve() on an already open thread leaves it open.

---

remove()

remove(): void

Removes the whole comment thread.

Returns

void

Remarks

Removing a thread removes its top-level comment, all flat replies, and every text anchor reference for that thread. The removed thread no longer appears in CommentThreadCollection.all results.