window.fastdocShell · прочие методы

Методы, не вошедшие в тематические группы выше: история правок, работа с текущим документом и окнами, шаблоны, автосохранение и восстановление. Методов: 70.

Под каждым методом идёт строка из четырёх значений — например web_to_host_request_response · invoke · fastdoc-shell:get-state · capability=document.

Значение	Что означает
`web_to_host_request_response`	Окно редактора спрашивает оболочку приложения и ждёт ответа
`web_to_host_event`	Окно редактора сообщает оболочке и ответа не ждёт
`host_to_web_event`	Оболочка сообщает окну редактора; на такие методы подписываются
`invoke`, `send`, `on`	Способ обмена: запрос с ответом, отправка без ответа, подписка
`fastdoc-shell:…`	Имя канала, по которому идёт сообщение
`capability=…`	Группа прав, к которой отнесён метод
:::

Методы на этой странице — 70

applyCanonicalHistory
applyEditorV0HomeFormattingCommand
applyEditorV0MailMergeCommandAction
applyOutlineMasterDocumentAction
applyPersistentEditingComposition
applyPersistentEditingStructuralCommand
applyQuickPartsDocumentOperation
arrangeDocumentWindows
checkLocalProofingWords
clearRecentDocuments
closeCurrentDocument
commitAutosaveRecovery
commitUserTemplate
completeSaveBeforeDocumentSwitch
configureLocalProofingProvider
createDocumentWindow
createEditableOdtCopy
createFromBuiltinTemplate
createFromUserTemplate
createQuickPartsBuildingBlock
createVersionCheckpoint
deleteQuickPartsBuildingBlock
deleteUserTemplate
deleteVersion
finalizeAutosaveRecovery
focusDocumentWindow
getAutosaveRecoveryState
getDocumentWindowSession
getLocalProofingDocumentPolicy
getPathForFile
inspectEditorV0HomeFormatting
inspectExternalChange
invalidatePersistentEditingProductRoute
linkVersionHistorySaveAs
listDocumentWindows
listFileStartTemplates
listQuickPartsBuildingBlocks
listVersionHistory
materializeDocumentPageWindow
mutateLocalProofingDictionary
notifyCanonicalEditDropped
notifyEditKeyDropped
notifyPageHydrationDropped
notifyPersistentSaveRefused
notifyUserDocumentSaved
onDocumentSessionSnapshot
onSaveBeforeDocumentSwitch
openMostRecentDocument
openVersion
prepareAutosaveRecovery
preparePersistentSaveCopyTarget
prepareUserTemplate
publishDocumentSessionSnapshot
removeRecentDocument
requestDocumentWindowClose
resolveAutosaveRecovery
resolveExternalChange
resolveFileSessionRecovery
restoreVersion
rollbackSaveAsOwnershipReservation
runDocxCompatibility
runEditorV0MailMergeBusiness
saveOdtAsDocxCopy
savePersistentEditingCheckpoint
setPersistentEditingSelection
setRecentDocumentPinned
setRestoreLastDocument
updateAutosaveRecoverySettings
updateQuickPartsBuildingBlock
updateVersionMetadata

applyCanonicalHistory

applyCanonicalHistory(direction: "undo" | "redo"): Promise<{ owner: "rust-session";
  available: boolean;
  sessionId: string | null;
  documentId: string | null;
  transactionOrder: number;
  acceptedRevision: number;
  selectionRevision: number;
  publishedRevision: number;
  dirty: boolean;
  modelHash: string | null;
  undoDepth: number;
  redoDepth: number;
  direction: "undo" | "redo";
  projectionPath: string;
  historyPreservedBySave: boolean;
  sceneModelHash: string;
  visibleSceneMatchesCanonicalModel: boolean;
  residueCount: 0;
  structuralProjection?: boolean;
  structuralStartBodyBlockIndex?: number;
  bridgeState?: ShellBridgeState;
    transition: { transitionKind: string;
    transactionOrder: number;
    beforeModelHash: string;
    afterModelHash: string;
    paragraphIndex?: number;
    beforeCaretSlotIndex?: number;
    afterCaretSlotIndex?: number;
    beforeSelectionStartSlotIndex?: number;
    beforeSelectionEndSlotIndex?: number;
    paragraphOwner?: string;
    requestId?: string;
  };
  persistentReceipt?: BoundedLiveTextInsertResult["persistentReceipt"];
}>

web_to_host_request_response · invoke · fastdoc-shell:apply-canonical-history

applyEditorV0HomeFormattingCommand

applyEditorV0HomeFormattingCommand(request: EditorV0HomeFormattingRequest): Promise<EditorV0HomeFormattingResult>

web_to_host_request_response · invoke · fastdoc-shell:apply-editor-v0-home-formatting-command

applyEditorV0MailMergeCommandAction

applyEditorV0MailMergeCommandAction(request: EditorV0MailMergeCommandRequest): Promise<EditorV0MailMergeCommandResult>

снят с поддержки: всегда отвечает отказом · отказ приходит с кодом MAIL_MERGE_LEGACY_COMMAND_OWNER_RETIRED

applyOutlineMasterDocumentAction

applyOutlineMasterDocumentAction(request: OutlineMasterDocumentRequest): Promise<OutlineMasterDocumentResult>

web_to_host_request_response · invoke · fastdoc-shell:apply-outline-master-document-action

applyPersistentEditingComposition

applyPersistentEditingComposition(request: CompositionRequest): Promise<CompositionReceipt>

web_to_host_request_response · invoke · fastdoc-shell:apply-persistent-editing-composition

applyPersistentEditingStructuralCommand

applyPersistentEditingStructuralCommand(request: EditRequest, options?: { projectionRefresh?: "full" | "page-window" | "model-only";
  pageIndex?: number;
  }): Promise<{ receipt: EditReceipt;
  model: Record<string, unknown>;
  document: ShellLoadedDocument;
  canonicalHistory: CanonicalHistoryState;
  projectionRefresh: "full" | "page-window" | "model-only";
}>

web_to_host_request_response · invoke · fastdoc-shell:apply-persistent-editing-structural-command

applyQuickPartsDocumentOperation

web_to_host_request_response · invoke · fastdoc-shell:apply-quick-parts-document-operation

arrangeDocumentWindows

arrangeDocumentWindows(): Promise<{ arranged: number;
    bounds: Array<{ x: number;
    y: number;
    width: number;
  height: number }>;
  windows: ShellDocumentWindowDescriptor[];
}>

web_to_host_request_response · invoke · fastdoc-shell:arrange-document-windows

checkLocalProofingWords

checkLocalProofingWords(request: ShellProofingWordCheckRequest): Promise<ShellProofingWordCheckResult>

web_to_host_request_response · invoke · fastdoc-shell:check-local-proofing-words

clearRecentDocuments

clearRecentDocuments(): Promise<{ cleared: boolean; persisted: boolean; recentDocuments: string[]; }>

web_to_host_request_response · invoke · fastdoc-shell:clear-recent-documents

closeCurrentDocument

closeCurrentDocument(decision: "save" | "discard"): Promise<{ closed: boolean;
  path: string | null;
  decision: "save" | "discard";
}>

web_to_host_request_response · invoke · fastdoc-shell:close-current-document

commitAutosaveRecovery

commitAutosaveRecovery(request: { recoveryId: string; stagedPath: string }): Promise<ShellAutosaveRecoveryCandidate>

web_to_host_request_response · invoke · fastdoc-shell:commit-autosave-recovery

commitUserTemplate

commitUserTemplate(request: { id: string;
  title: string;
  sourcePath: string;
  previewText?: string;
}): ReturnType<FastDocShellApi["listFileStartTemplates"]>

web_to_host_request_response · invoke · fastdoc-shell:commit-user-template

completeSaveBeforeDocumentSwitch

completeSaveBeforeDocumentSwitch(result: { requestId: number;
  saved: boolean;
  savedPath: string | null;
  errorMessage: string | null;
}): void

web_to_host_event · send · fastdoc-shell:document-switch-save-result

configureLocalProofingProvider

configureLocalProofingProvider(): Promise<ShellProofingProviderState>

web_to_host_request_response · invoke · fastdoc-shell:configure-local-proofing-provider

createDocumentWindow

createDocumentWindow(): Promise<{ created: boolean;
  windowId: number | null;
  documentPath: string | null;
  error: string | null;
  windows: ShellDocumentWindowDescriptor[];
}>

web_to_host_request_response · invoke · fastdoc-shell:create-document-window

createEditableOdtCopy

createEditableOdtCopy(): Promise<OdtEditableCopyUiResult>

web_to_host_request_response · invoke · fastdoc-shell:create-editable-odt-copy

createFromBuiltinTemplate

createFromBuiltinTemplate(templateId: string): Promise<{ opened: boolean;
  canceled: boolean;
  path: string | null;
}>

web_to_host_request_response · invoke · fastdoc-shell:create-from-builtin-template

createFromUserTemplate

createFromUserTemplate(templateId: string): Promise<{ opened: boolean;
  canceled: boolean;
  path: string | null;
}>

web_to_host_request_response · invoke · fastdoc-shell:create-from-user-template

createQuickPartsBuildingBlock

web_to_host_request_response · invoke · fastdoc-shell:create-quick-parts-building-block

createVersionCheckpoint

createVersionCheckpoint(request: { reason: ShellVersionHistoryEntry["reason"];
  name?: string | null;
  pinned?: boolean;
  recoverySessionId?: string | null;
}): Promise<ShellVersionHistoryEntry>

web_to_host_request_response · invoke · fastdoc-shell:create-version-checkpoint

deleteQuickPartsBuildingBlock

web_to_host_request_response · invoke · fastdoc-shell:delete-quick-parts-building-block

deleteUserTemplate

deleteUserTemplate(templateId: string): ReturnType<FastDocShellApi["listFileStartTemplates"]>

web_to_host_request_response · invoke · fastdoc-shell:delete-user-template

deleteVersion

deleteVersion(request: { versionId: string; confirmed: boolean }): Promise<{ deleted: true }>

web_to_host_request_response · invoke · fastdoc-shell:delete-version

finalizeAutosaveRecovery

finalizeAutosaveRecovery(request: { recoveryId: string;
  action: "save" | "save-as" | "discard" | "cancel";
  savedPath?: string | null;
  }): Promise<{ finalized: boolean;
preserved: boolean }>

web_to_host_request_response · invoke · fastdoc-shell:finalize-autosave-recovery

focusDocumentWindow

focusDocumentWindow(windowId: number): Promise<{ focused: boolean;
  windows: ShellDocumentWindowDescriptor[];
}>

web_to_host_request_response · invoke · fastdoc-shell:focus-document-window

getAutosaveRecoveryState

getAutosaveRecoveryState(): Promise<{ sessionId: string;
  settings: ShellAutosaveRecoverySettings;
candidates: ShellAutosaveRecoveryCandidate[] }>

web_to_host_request_response · invoke · fastdoc-shell:get-autosave-recovery-state

getDocumentWindowSession

getDocumentWindowSession(): Promise<ShellDocumentWindowSession>

web_to_host_request_response · invoke · fastdoc-shell:get-document-window-session

getLocalProofingDocumentPolicy

getLocalProofingDocumentPolicy(request: { documentPath: string }): Promise<ShellProofingDocumentPolicy>

web_to_host_request_response · invoke · fastdoc-shell:get-local-proofing-document-policy

getPathForFile

getPathForFile(file: { readonly name: string }): string

прямой адаптер Electron, а не команда ядра · работает синхронно и до ядра не доходит

inspectEditorV0HomeFormatting

inspectEditorV0HomeFormatting(): Promise<EditorV0HomeFormattingSnapshot>

web_to_host_request_response · invoke · fastdoc-shell:inspect-editor-v0-home-formatting

inspectExternalChange

inspectExternalChange(request: { dirty: boolean }): Promise<ShellExternalChangePromptState>

web_to_host_request_response · invoke · fastdoc-shell:inspect-external-change

invalidatePersistentEditingProductRoute

invalidatePersistentEditingProductRoute(reason: string): Promise<{ invalidated: true }>

web_to_host_request_response · invoke · fastdoc-shell:invalidate-persistent-editing-product-route

linkVersionHistorySaveAs

linkVersionHistorySaveAs(request: { previousPath: string; nextPath: string }): Promise<{ linked: true }>

web_to_host_request_response · invoke · fastdoc-shell:link-version-history-save-as

listDocumentWindows

listDocumentWindows(): Promise<ShellDocumentWindowDescriptor[]>

web_to_host_request_response · invoke · fastdoc-shell:list-document-windows

listFileStartTemplates

listFileStartTemplates(): Promise<{ builtInTemplates: Array<{ id: "blank" | "letter" | "report" | "meeting-notes";
    title: string;
    description: string;
    previewText: string;
  }>;
    userTemplates: Array<{ id: string;
    title: string;
    sourcePath: string;
    previewText: string;
    createdAt: string;
  }>;
}>

web_to_host_request_response · invoke · fastdoc-shell:list-file-start-templates

listQuickPartsBuildingBlocks

web_to_host_request_response · invoke · fastdoc-shell:list-quick-parts-building-blocks

listVersionHistory

listVersionHistory(): Promise<ShellVersionHistoryResult>

web_to_host_request_response · invoke · fastdoc-shell:list-version-history

materializeDocumentPageWindow

materializeDocumentPageWindow(request: { path: string;
  pageIndex: number;
}): Promise<ShellDocumentPageWindowResult>

web_to_host_request_response · invoke · fastdoc-shell:materialize-document-page-window

mutateLocalProofingDictionary

mutateLocalProofingDictionary(request: { action: "add" | "remove" | "reset";
  word?: string | null;
}): Promise<ShellProofingDictionaryResult>

web_to_host_request_response · invoke · fastdoc-shell:mutate-local-proofing-dictionary

notifyCanonicalEditDropped

notifyCanonicalEditDropped(payload: { code: string; requestId: string; commandType: string; }): void

web_to_host_event · send · fastdoc-shell:canonical-edit-dropped

notifyEditKeyDropped

notifyEditKeyDropped(payload: { code: string;
  inputType: string;
  selectionShape: string;
  inputRoute: string;
  contextRefusal: string;
  pressIndex: number;
}): void

web_to_host_event · send · fastdoc-shell:edit-key-dropped

notifyPageHydrationDropped

notifyPageHydrationDropped(payload: { code: string; stage: string }): void

web_to_host_event · send · fastdoc-shell:page-hydration-dropped

notifyPersistentSaveRefused

notifyPersistentSaveRefused(payload: { code: string; requestId: string; saveAs: boolean; }): void

web_to_host_event · send · fastdoc-shell:persistent-save-refused

notifyUserDocumentSaved

notifyUserDocumentSaved(savedPath: string): Promise<{ recorded: boolean }>

web_to_host_request_response · invoke · fastdoc-shell:user-document-saved

onDocumentSessionSnapshot

onDocumentSessionSnapshot(callback: (snapshot: ShellDocumentSessionSnapshot) => void): () => void

host_to_web_event · on · fastdoc-shell:document-session-snapshot

onSaveBeforeDocumentSwitch

onSaveBeforeDocumentSwitch(callback: (request: { requestId: number }) => void): () => void

host_to_web_event · on · fastdoc-shell:save-before-document-switch

openMostRecentDocument

openMostRecentDocument(): Promise<{ opened: boolean; canceled: boolean; path: string | null; }>

web_to_host_request_response · invoke · fastdoc-shell:open-most-recent-document

openVersion

openVersion(request: { versionId: string;
  mode: "preview" | "read-only" | "compare";
  }): Promise<{ opened: true;
  mode: "preview" | "read-only" | "compare";
  snapshotPath: string;
sourceHash: string }>

web_to_host_request_response · invoke · fastdoc-shell:open-version

prepareAutosaveRecovery

prepareAutosaveRecovery(request: { recoveryId?: string | null;
  documentId?: string | null;
  displayName: string;
  sourcePath: string | null;
  serializationPath: string;
  }): Promise<{ recoveryId: string;
  documentId: string;
  stagingPath: string;
settings: ShellAutosaveRecoverySettings }>

web_to_host_request_response · invoke · fastdoc-shell:prepare-autosave-recovery

preparePersistentSaveCopyTarget

preparePersistentSaveCopyTarget(request?: { outputKind?: string;
  saveAsPath?: string | null;
  }): Promise<{ status: "canceled" | "reserved";
  canceled: boolean;
  path: string | null;
  reservationId: string | null;
}>

web_to_host_request_response · invoke · fastdoc-shell:prepare-persistent-save-copy-target

prepareUserTemplate

prepareUserTemplate(request: { title: string;
  previewText?: string }): Promise<{ id: string;
  title: string;
  targetPath: string;
  previewText: string;
}>

web_to_host_request_response · invoke · fastdoc-shell:prepare-user-template

publishDocumentSessionSnapshot

publishDocumentSessionSnapshot(snapshot: ShellDocumentSessionSnapshot): Promise<{ accepted: boolean;
  revision: number;
  recipients: number;
}>

web_to_host_request_response · invoke · fastdoc-shell:publish-document-session-snapshot

removeRecentDocument

removeRecentDocument(path: string): Promise<{ removed: boolean;
  persisted: boolean;
  recentDocuments: string[];
}>

web_to_host_request_response · invoke · fastdoc-shell:remove-recent-document

requestDocumentWindowClose

requestDocumentWindowClose(): Promise<{ requested: boolean; remaining: number; }>

web_to_host_request_response · invoke · fastdoc-shell:request-document-window-close

resolveAutosaveRecovery

resolveAutosaveRecovery(request: { recoveryId: string;
  action: "recover" | "open-copy" | "delete" | "dismiss";
  outputPath?: string | null;
  }): Promise<{ action: string;
  documentPath: string | null;
candidates: ShellAutosaveRecoveryCandidate[] }>

web_to_host_request_response · invoke · fastdoc-shell:resolve-autosave-recovery

resolveExternalChange

resolveExternalChange(request: { decision: "keep-current" | "keep-mine" | "reload-disk" | "save-mine-copy" | "compare" | "cancel";
  revision: number;
  }): Promise<{ resolved: boolean;
  stale: boolean;
  decision: string;
  requiresRendererSaveAs: boolean;
  documentPath: string | null;
}>

web_to_host_request_response · invoke · fastdoc-shell:resolve-external-change

resolveFileSessionRecovery

resolveFileSessionRecovery(request: { decision: "recover" | "decline" | "open-original";
  }): Promise<{ state: ShellFileSessionRecoveryState;
  recovered: boolean;
  declined: boolean;
  openedOriginal: boolean;
  documentPath: string | null;
}>

web_to_host_request_response · invoke · fastdoc-shell:resolve-file-session-recovery

restoreVersion

restoreVersion(request: { versionId: string;
  mode: "current" | "copy";
  outputPath?: string | null;
  }): Promise<{ restored: boolean;
  canceled: boolean;
  mode: "current" | "copy";
outputPath: string | null }>

web_to_host_request_response · invoke · fastdoc-shell:restore-version

rollbackSaveAsOwnershipReservation

rollbackSaveAsOwnershipReservation(request: { reservationId: string;
  targetPath: string;
}): Promise<{ rolledBack: boolean }>

web_to_host_request_response · invoke · fastdoc-shell:rollback-save-as-ownership-reservation

runDocxCompatibility

runDocxCompatibility(request: { action: "check" | "inspect" | "repair-copy";
  sourcePath?: string | null;
  selectSource?: boolean;
}): Promise<ShellDocxCompatibilityOperationResult>

web_to_host_request_response · invoke · fastdoc-shell:run-docx-compatibility

runEditorV0MailMergeBusiness

runEditorV0MailMergeBusiness(request: Record<string, unknown>): Promise<Record<string, unknown>>

web_to_host_request_response · invoke · fastdoc-shell:run-editor-v0-mail-merge-business

saveOdtAsDocxCopy

saveOdtAsDocxCopy(): Promise<OdtDocxConversionUiResult>

web_to_host_request_response · invoke · fastdoc-shell:save-odt-as-docx-copy

savePersistentEditingCheckpoint

savePersistentEditingCheckpoint(request?: { saveAs?: boolean;
  targetPath?: string;
  saveAsOwnershipReservationId?: string;
}): Promise< BoundedLiveTextInsertResult | null >

web_to_host_request_response · invoke · fastdoc-shell:save-persistent-editing-checkpoint

setPersistentEditingSelection

setPersistentEditingSelection(request: SelectionUpdateRequest): Promise<SelectionUpdateReceipt>
setPersistentEditingSelection(request: SelectionUpdateRequest): Promise<SelectionUpdateReceipt>

web_to_host_request_response · invoke · fastdoc-shell:set-persistent-editing-selection

setRecentDocumentPinned

setRecentDocumentPinned(path: string, pinned: boolean): Promise<{ pinned: boolean; persisted: boolean; }>

web_to_host_request_response · invoke · fastdoc-shell:set-recent-document-pinned

setRestoreLastDocument

setRestoreLastDocument(enabled: boolean): Promise<{ enabled: boolean; persisted: boolean; }>

web_to_host_request_response · invoke · fastdoc-shell:set-restore-last-document

updateAutosaveRecoverySettings

updateAutosaveRecoverySettings(request: Partial<Pick<ShellAutosaveRecoverySettings, "enabled" | "intervalSeconds">> & { retention?: Partial<ShellAutosaveRecoverySettings["retention"]>; }): Promise<ShellAutosaveRecoverySettings>

web_to_host_request_response · invoke · fastdoc-shell:update-autosave-recovery-settings

updateQuickPartsBuildingBlock

web_to_host_request_response · invoke · fastdoc-shell:update-quick-parts-building-block

updateVersionMetadata

updateVersionMetadata(request: { versionId: string;
  name?: string | null;
  pinned?: boolean;
}): Promise<ShellVersionHistoryEntry>

web_to_host_request_response · invoke · fastdoc-shell:update-version-metadata