window.fastdocShell · review

Review: comments, tracked changes, display modes. Methods on this page: 15.

Internal API

window.fastdocShell is only available inside the desktop SumDoc window. For external integration, use the Rust Session Protocol or the browser surface interface.

How to read the line under the signature

Under each method is a line of four values — for example web_to_host_request_response · invoke · fastdoc-shell:get-state · capability=document.

Value	What it means
web_to_host_request_response	The editor window asks the application shell and waits for a response
web_to_host_event	The editor window notifies the shell and doesn’t wait for a response
host_to_web_event	The shell notifies the editor window; you subscribe to these methods
invoke, send, on	Exchange method: request with a response, send without a response, subscription
fastdoc-shell:…	The name of the channel the message travels on
capability=…	The capability group the method belongs to

All three sets of values are declared in the shell contract: directions in BridgeDirection, domains in ShellContractDomain, capabilities in ShellCapability. The last set doesn’t match the domains: smoke runs and the release center have no capability of their own, so their methods are assigned to internal or document.

The first word of the name tells you what the method does

Start of the name	What happens
apply…	Performs an action and changes the document. The response says what happened
compute…CommandState	Changes nothing: answers whether the action can be performed now (canApply) and why not (disabledReason). The shell uses this response to decide whether to enable the button
run…	Runs an entire scenario — a compatibility check or a release-readiness check
get…, list…	Read state and change nothing
set…, update…	Change a setting, not the document’s content
create…, delete…	Create and delete — a version, a comment, a checkpoint
open…	Opens — the document, one of its versions, a link in an external program
resolve…	Two different meanings, visible from the rest of the name: for comments, it marks one resolved; for recovery and external changes, it resolves a conflict by choosing whose edit to keep
notify…	Notifies the shell of an event and doesn’t wait for a response
on…	Subscription: the shell calls you when the event happens

The apply… and compute…CommandState pairs go together: first you ask for the state, then you apply. A method ending in Copy is a special case, covered below.

What Copy at the end of a name means

This kind of method doesn’t change the open document. It creates a file next to it and applies the action to that copy: the open document and its history stay as they were. Where to write it is set by the outputPath field; without it, the shell picks a path itself, next to the source file.

So “accepting a change” with Copy isn’t an in-place edit — it produces a second file with the change accepted. Editing the open document goes through a different path — session commands, mutate and apply-text-transaction: Rust Session Protocol.

Methods on this page — 15

• acceptReviewTrackedChangeCopy
• applyReviewToolsWriteback
• createReviewModeNewDocumentCopy
• deleteReviewCommentCopy
• insertReviewCommentCopy
• previewReviewAction
• rejectReviewTrackedChangeCopy
• replyReviewCommentCopy
• resolveAllReviewCommentsCopy
• resolveReviewCommentCopy
• resolveReviewCommentsAuthorCopy
• resolveReviewMyCommentsCopy
• setReviewCommentResolvedCopy
• setReviewModeCopy
• setTrackedChangeMarkupMode

acceptReviewTrackedChangeCopy

acceptReviewTrackedChangeCopy(request: ShellReviewAcceptChangeCopyRequest): Promise<ShellReviewAcceptChangeCopyResult>

web_to_host_request_response · invoke · fastdoc-shell:accept-review-tracked-change-copy · capability=review

applyReviewToolsWriteback

applyReviewToolsWriteback(request: ShellReviewToolsWritebackRequest): Promise<ShellReviewToolsWritebackResult>

web_to_host_request_response · invoke · fastdoc-shell:apply-review-tools-writeback · capability=review

createReviewModeNewDocumentCopy

createReviewModeNewDocumentCopy(request?: ShellReviewNewDocumentCopyRequest): Promise<ShellReviewNewDocumentCopyResult>

web_to_host_request_response · invoke · fastdoc-shell:create-review-mode-new-document-copy · capability=review

deleteReviewCommentCopy

deleteReviewCommentCopy(request: ShellReviewDeleteCommentCopyRequest): Promise<ShellReviewDeleteCommentCopyResult>

web_to_host_request_response · invoke · fastdoc-shell:delete-review-comment-copy · capability=review

insertReviewCommentCopy

insertReviewCommentCopy(request: ShellReviewInsertCommentCopyRequest): Promise<ShellReviewInsertCommentCopyResult>

web_to_host_request_response · invoke · fastdoc-shell:insert-review-comment-copy · capability=review

previewReviewAction

previewReviewAction(request: ShellReviewActionPreviewRequest): Promise<ShellReviewActionPreviewResult>

web_to_host_request_response · invoke · fastdoc-shell:preview-review-action · capability=review

rejectReviewTrackedChangeCopy

rejectReviewTrackedChangeCopy(request: ShellReviewRejectChangeCopyRequest): Promise<ShellReviewRejectChangeCopyResult>

web_to_host_request_response · invoke · fastdoc-shell:reject-review-tracked-change-copy · capability=review

replyReviewCommentCopy

replyReviewCommentCopy(request: ShellReviewReplyCommentCopyRequest): Promise<ShellReviewReplyCommentCopyResult>

web_to_host_request_response · invoke · fastdoc-shell:reply-review-comment-copy · capability=review

resolveAllReviewCommentsCopy

resolveAllReviewCommentsCopy(request?: ShellReviewResolveAllCommentsCopyRequest): Promise<ShellReviewResolveAllCommentsCopyResult>

web_to_host_request_response · invoke · fastdoc-shell:resolve-all-review-comments-copy · capability=review

resolveReviewCommentCopy

resolveReviewCommentCopy(request: ShellReviewResolveCommentCopyRequest): Promise<ShellReviewResolveCommentCopyResult>

web_to_host_request_response · invoke · fastdoc-shell:resolve-review-comment-copy · capability=review

resolveReviewCommentsAuthorCopy

resolveReviewCommentsAuthorCopy(request: ShellReviewResolveCommentsAuthorCopyRequest): Promise<ShellReviewResolveCommentsAuthorCopyResult>

web_to_host_request_response · invoke · fastdoc-shell:resolve-review-comments-author-copy · capability=review

resolveReviewMyCommentsCopy

resolveReviewMyCommentsCopy(request: ShellReviewResolveMyCommentsCopyRequest): Promise<ShellReviewResolveMyCommentsCopyResult>

web_to_host_request_response · invoke · fastdoc-shell:resolve-review-my-comments-copy · capability=review

setReviewCommentResolvedCopy

setReviewCommentResolvedCopy(request: ShellReviewSetCommentResolvedCopyRequest): Promise<ShellReviewSetCommentResolvedCopyResult>

web_to_host_request_response · invoke · fastdoc-shell:set-review-comment-resolved-copy · capability=review

setReviewModeCopy

setReviewModeCopy(request: ShellReviewModeCopyRequest): Promise<ShellReviewModeCopyResult>

web_to_host_request_response · invoke · fastdoc-shell:set-review-mode-copy · capability=review

setTrackedChangeMarkupMode

setTrackedChangeMarkupMode(request?: ShellTrackedChangeMarkupModeRequest): Promise<ShellTrackedChangeMarkupModeResult>

web_to_host_request_response · invoke · fastdoc-shell:set-tracked-change-markup-mode · capability=review