Сессия и книга

Открытие подмножества книги, сохранение, viewport, восстановление, свойства, сравнение и слияние ревизий. Операций на странице: 17.

Операции на этой странице — 17

check_workbook_compatibility
close_workbook_subset
compare_workbook_versions
diagnose_file_open_recovery
document_properties_lifecycle
inspect_workbook_privacy
merge_workbook_revisions
open_workbook_subset
open_workbook_subset_from_bytes
publish_file_open_recovery
replay_workbook_history
save_workbook_subset
save_workbook_subset_to_bytes
synchronize_workbook_viewport
workbook_accessibility
workbook_links_manager
workbook_window_session_command

check_workbook_compatibility

Проверяет workbook compatibility.

Request

Поле	Тип TypeScript	Обяз.
operation	“check_workbook_compatibility”	да
subsetId	string	да
target	CompatibilityTarget	да
readOnly	boolean	нет
requestedBackend	ComputeBackendKind \| null	нет

Success payload · check_workbook_compatibility

Поле	Тип TypeScript	Обяз.
operation	“check_workbook_compatibility”	да
subsetId	string	да
session	ContractSubsetSessionInfo	да
report	CompatibilityInventoryReport	да

Минимальный JSON-шаблон

{
  "operation": "check_workbook_compatibility",
  "subsetId": "<subsetId>",
  "target": "<CompatibilityTarget>",
  "requestedBackend": "native-desktop"
}

close_workbook_subset

Закрывает workbook subset.

Request

Поле	Тип TypeScript	Обяз.
operation	“close_workbook_subset”	да
subsetId	string	да
requestedBackend	ComputeBackendKind \| null	нет

Success payload · close_workbook_subset

Поле	Тип TypeScript	Обяз.
operation	“close_workbook_subset”	да
subsetId	string	да
closed	boolean	да
releasedClipboardCount	number	да
remainingSessionCount	number	да

Минимальный JSON-шаблон

{
  "operation": "close_workbook_subset",
  "subsetId": "<subsetId>",
  "requestedBackend": "native-desktop"
}

compare_workbook_versions

Сравнивает workbook versions.

Request

Поле	Тип TypeScript	Обяз.
operation	“compare_workbook_versions”	да
currentSourceUri	string	да
versionSourceUri	string	да
requestedBackend	ComputeBackendKind \| null	нет

Success payload · compare_workbook_versions

Поле	Тип TypeScript	Обяз.	Примечание из контракта
operation	“compare_workbook_versions”	да
diff	WorkbookVersionStructuralDiff	да

Минимальный JSON-шаблон

{
  "operation": "compare_workbook_versions",
  "currentSourceUri": "<string>",
  "versionSourceUri": "<string>",
  "requestedBackend": "native-desktop"
}

diagnose_file_open_recovery

Диагностирует file open recovery.

Request

Поле	Тип TypeScript	Обяз.
operation	“diagnose_file_open_recovery”	да
sourceUri	string	да
requestedBackend	ComputeBackendKind \| null	нет

Success payload · diagnose_file_open_recovery

Поле	Тип TypeScript	Обяз.	Примечание из контракта
operation	“diagnose_file_open_recovery”	да
plan	ContractFileRecoveryPlan	да

Минимальный JSON-шаблон

{
  "operation": "diagnose_file_open_recovery",
  "sourceUri": "file:///path/book.xlsx",
  "requestedBackend": "native-desktop"
}

document_properties_lifecycle

Операция document properties lifecycle.

Request

Поле	Тип TypeScript	Обяз.
operation	“document_properties_lifecycle”	да
subsetId	string	да
intent	ContractDocumentPropertiesIntent	да
requestedBackend	ComputeBackendKind \| null	нет

Success payload · document_properties_lifecycle

Поле	Тип TypeScript	Обяз.
operation	“document_properties_lifecycle”	да
subsetId	string	да
session	ContractSubsetSessionInfo	да
result	ContractDocumentPropertiesResult	да

Минимальный JSON-шаблон

{
  "operation": "document_properties_lifecycle",
  "subsetId": "<subsetId>",
  "intent": "<ContractDocumentPropertiesIntent>",
  "requestedBackend": "native-desktop"
}

inspect_workbook_privacy

Инспектирует workbook privacy.

Request

Поле	Тип TypeScript	Обяз.
operation	“inspect_workbook_privacy”	да
subsetId	string	да
intent	ContractPrivacyInspectorIntent	да
requestedBackend	ComputeBackendKind \| null	нет

Success payload · inspect_workbook_privacy

Поле	Тип TypeScript	Обяз.
operation	“inspect_workbook_privacy”	да
subsetId	string	да
session	ContractSubsetSessionInfo	да
result	ContractPrivacyInspectorResult	да

Минимальный JSON-шаблон

{
  "operation": "inspect_workbook_privacy",
  "subsetId": "<subsetId>",
  "intent": "<ContractPrivacyInspectorIntent>",
  "requestedBackend": "native-desktop"
}

merge_workbook_revisions

Объединяет workbook revisions.

Request

Поле	Тип TypeScript	Обяз.
operation	“merge_workbook_revisions”	да
subsetId	string	да
workbookId	string	да
baseRevision	number	да
local	ContractWorkbookRevisionDelta	да
incoming	ContractWorkbookRevisionDelta	да
expectedRevision	number	да
viewport	ViewportWindow \| null	нет
requestedBackend	ComputeBackendKind \| null	нет

Success payload · merge_workbook_revisions

Поле	Тип TypeScript	Обяз.
operation	“merge_workbook_revisions”	да
subsetId	string	да
workbookId	string	да
baseRevision	number	да
localRevision	number	да
incomingRevision	number	да
outcome	ContractWorkbookRevisionMergeOutcome	да
appliedMutationCount	number	да
conflicts	ContractWorkbookRevisionConflict[]	да
changedKeys	string[]	да
dirty	boolean	да
recalcNeeded	boolean	да
workbookHistory	ContractWorkbookHistoryProjection	да

Минимальный JSON-шаблон

{
  "operation": "merge_workbook_revisions",
  "subsetId": "<subsetId>",
  "workbookId": "<string>",
  "baseRevision": 0,
  "local": "<ContractWorkbookRevisionDelta>",
  "incoming": "<ContractWorkbookRevisionDelta>",
  "expectedRevision": 0,
  "requestedBackend": "native-desktop"
}

open_workbook_subset

Открывает workbook subset.

Request

Поле	Тип TypeScript	Обяз.
operation	“open_workbook_subset”	да
sourceUri	string	да
viewport	ViewportWindow \| null	нет
delimitedOpenOptions	ContractDelimitedOpenOptions \| null	нет
requestedBackend	ComputeBackendKind \| null	нет

Success payload · open_workbook_subset

Поле	Тип TypeScript	Обяз.	Примечание из контракта
operation	“open_workbook_subset”	да
subsetId	string	да
sheetCount	number	да
session	ContractSubsetSessionInfo	да
readiness	ContractWorkbookReadiness	да
formatCapabilities	ContractFormatCapabilities \| null	нет
xlsbDirtySaveProfile	ContractXlsbDirtySaveProfile \| null	нет
activeSheet	ContractActiveSheetMeta	да
workbookSheets	ContractWorkbookSheetMeta[]	нет
themeFonts	ContractWorkbookThemeFontsProjection \| null	нет
tableMetadata	ContractTableMetadataProjection \| null	нет
workbookTableMetadata	ContractTableMetadataProjection \| null	нет
worksheetAutoFilterMetadata	ContractWorksheetAutoFilterMetadata \| null	нет
directionPlaceholder	ContractDirectionPlaceholderSubset \| null	нет
objectStatusPlaceholder	ContractObjectStatusPlaceholderSubset \| null	нет
surfaceObjects	ContractSheetObject[] \| null	нет
objectInventory	ContractWorkbookObjectInventoryEntry[] \| null	нет
inkProjection	ContractReviewInkProjectionItem[] \| null	нет
geometry	ContractGeometrySubset	да
recalcNeeded	boolean	да
viewport	ViewportWindow	да
previewCells	ContractPreviewCell[]	да
conditionalFormattingRules	ContractConditionalRule[]	нет
dataValidationMetadata	ContractDataValidationMetadata	нет
frozenBandCells	ContractPreviewCell[]	нет
layoutMetrics	ContractLayoutMetricsSubset \| null	нет
formulaTrustSnapshot	ContractFormulaTrustSnapshot \| null	нет
themeColorPalette	string[]	нет
viewportReadiness	ContractViewportReadiness	нет	Desktop-ready projections retain the area-specific publication guard.

Минимальный JSON-шаблон

{
  "operation": "open_workbook_subset",
  "sourceUri": "file:///path/book.xlsx",
  "requestedBackend": "native-desktop"
}

open_workbook_subset_from_bytes

Открывает workbook subset from bytes.

Request

Поле	Тип TypeScript	Обяз.
operation	“open_workbook_subset_from_bytes”	да
sourceName	string	да
sourceBytesBase64	string	да
viewport	ViewportWindow \| null	нет
delimitedOpenOptions	ContractDelimitedOpenOptions \| null	нет
requestedBackend	ComputeBackendKind \| null	нет

Success payload · open_workbook_subset

Поле	Тип TypeScript	Обяз.	Примечание из контракта
operation	“open_workbook_subset”	да
subsetId	string	да
sheetCount	number	да
session	ContractSubsetSessionInfo	да
readiness	ContractWorkbookReadiness	да
formatCapabilities	ContractFormatCapabilities \| null	нет
xlsbDirtySaveProfile	ContractXlsbDirtySaveProfile \| null	нет
activeSheet	ContractActiveSheetMeta	да
workbookSheets	ContractWorkbookSheetMeta[]	нет
themeFonts	ContractWorkbookThemeFontsProjection \| null	нет
tableMetadata	ContractTableMetadataProjection \| null	нет
workbookTableMetadata	ContractTableMetadataProjection \| null	нет
worksheetAutoFilterMetadata	ContractWorksheetAutoFilterMetadata \| null	нет
directionPlaceholder	ContractDirectionPlaceholderSubset \| null	нет
objectStatusPlaceholder	ContractObjectStatusPlaceholderSubset \| null	нет
surfaceObjects	ContractSheetObject[] \| null	нет
objectInventory	ContractWorkbookObjectInventoryEntry[] \| null	нет
inkProjection	ContractReviewInkProjectionItem[] \| null	нет
geometry	ContractGeometrySubset	да
recalcNeeded	boolean	да
viewport	ViewportWindow	да
previewCells	ContractPreviewCell[]	да
conditionalFormattingRules	ContractConditionalRule[]	нет
dataValidationMetadata	ContractDataValidationMetadata	нет
frozenBandCells	ContractPreviewCell[]	нет
layoutMetrics	ContractLayoutMetricsSubset \| null	нет
formulaTrustSnapshot	ContractFormulaTrustSnapshot \| null	нет
themeColorPalette	string[]	нет
viewportReadiness	ContractViewportReadiness	нет	Desktop-ready projections retain the area-specific publication guard.

Минимальный JSON-шаблон

{
  "operation": "open_workbook_subset_from_bytes",
  "sourceName": "book.xlsx",
  "sourceBytesBase64": "<base64>",
  "requestedBackend": "native-desktop"
}

publish_file_open_recovery

Публикует file open recovery.

Request

Поле	Тип TypeScript	Обяз.
operation	“publish_file_open_recovery”	да
sourceUri	string	да
destinationUri	string	да
planId	string	да
mode	ContractFileRecoveryMode	да
requestedBackend	ComputeBackendKind \| null	нет

Success payload · publish_file_open_recovery

Поле	Тип TypeScript	Обяз.	Примечание из контракта
operation	“publish_file_open_recovery”	да
publication	ContractFileRecoveryPublication	да

Минимальный JSON-шаблон

{
  "operation": "publish_file_open_recovery",
  "sourceUri": "file:///path/book.xlsx",
  "destinationUri": "file:///path/output.xlsx",
  "planId": "<string>",
  "mode": "<ContractFileRecoveryMode>",
  "requestedBackend": "native-desktop"
}

replay_workbook_history

Воспроизводит workbook history.

Request

Поле	Тип TypeScript	Обяз.
operation	“replay_workbook_history”	да
subsetId	string	да
direction	ContractWorkbookHistoryDirection	да
viewport	ViewportWindow \| null	нет
requestedBackend	ComputeBackendKind \| null	нет

Success payload · replay_workbook_history

Поле	Тип TypeScript	Обяз.
operation	“replay_workbook_history”	да
subsetId	string	да
session	ContractSubsetSessionInfo	да
direction	ContractWorkbookHistoryDirection	да
historyOwner	ContractWorkbookHistoryOwner	да
undoDepth	number	да
redoDepth	number	да
revision	number	да
replayed	ComputeResponsePayload	да

Минимальный JSON-шаблон

{
  "operation": "replay_workbook_history",
  "subsetId": "<subsetId>",
  "direction": "<ContractWorkbookHistoryDirection>",
  "requestedBackend": "native-desktop"
}

save_workbook_subset

Сохраняет workbook subset.

Request

Поле	Тип TypeScript	Обяз.
operation	“save_workbook_subset”	да
subsetId	string	да
destinationUri	string	да
preserveCachedValues	boolean	да
delimitedSaveOptions	ContractDelimitedSaveOptions \| null	нет
xlsxSavePatch	ContractXlsxSavePatch \| null	нет
requestedBackend	ComputeBackendKind \| null	нет

Success payload · save_workbook_subset

Поле	Тип TypeScript	Обяз.
operation	“save_workbook_subset”	да
subsetId	string	да
session	ContractSubsetSessionInfo	да
saveRoute	ContractCurrentSubsetSaveRoute	да
wroteBytes	number	да
recalcNeeded	boolean	да

Минимальный JSON-шаблон

{
  "operation": "save_workbook_subset",
  "subsetId": "<subsetId>",
  "destinationUri": "file:///path/output.xlsx",
  "preserveCachedValues": false,
  "requestedBackend": "native-desktop"
}

save_workbook_subset_to_bytes

Сохраняет workbook subset to bytes.

Request

Поле	Тип TypeScript	Обяз.
operation	“save_workbook_subset_to_bytes”	да
subsetId	string	да
saveFormat	ContractFileFormat \| null	нет
preserveCachedValues	boolean	да
delimitedSaveOptions	ContractDelimitedSaveOptions \| null	нет
requestedBackend	ComputeBackendKind \| null	нет

Success payload · save_workbook_subset_to_bytes

Поле	Тип TypeScript	Обяз.
operation	“save_workbook_subset_to_bytes”	да
subsetId	string	да
session	ContractSubsetSessionInfo	да
saveRoute	ContractCurrentSubsetSaveRoute	да
formulaTrustSnapshot	ContractFormulaTrustSnapshot \| null	нет
savedFormat	ContractFileFormat	да
byteCount	number	да
bytesBase64	string	да
recalcNeeded	boolean	да

Минимальный JSON-шаблон

{
  "operation": "save_workbook_subset_to_bytes",
  "subsetId": "<subsetId>",
  "preserveCachedValues": false,
  "requestedBackend": "native-desktop"
}

synchronize_workbook_viewport

Синхронизирует workbook viewport.

Request

Поле	Тип TypeScript	Обяз.	Примечание из контракта
operation	“synchronize_workbook_viewport”	да
subsetId	string	да
sourceUri	string	да
viewport	ViewportWindow \| null	нет
recordHistory	false	да	View projection is not a user mutation and never enters history.
expectedReadinessGeneration	number \| null	нет	Omit only for legacy callers. Typed shell owners bind publication to the generation they observed before issuing the request.
requestedBackend	ComputeBackendKind \| null	нет

Success payload · synchronize_workbook_viewport

Поле	Тип TypeScript	Обяз.	Примечание из контракта
operation	“synchronize_workbook_viewport”	да
subsetId	string	да
viewportReadiness	ContractViewportReadiness	да
projection	OpenWorkbookSubsetProjectionPayload \| null	нет	Present only for state=ready. Deferred/cancelled/superseded/failed responses never carry an empty projection masquerading as final data.

Минимальный JSON-шаблон

{
  "operation": "synchronize_workbook_viewport",
  "subsetId": "<subsetId>",
  "sourceUri": "file:///path/book.xlsx",
  "recordHistory": false,
  "requestedBackend": "native-desktop"
}

workbook_accessibility

Операция workbook accessibility.

Request

Поле	Тип TypeScript	Обяз.
operation	“workbook_accessibility”	да
subsetId	string	да
requestId	string	да
expectedRevision	number	да
expectedGeneration	number	да
readOnly	boolean	нет
protected	boolean	нет
intent	ContractWorkbookAccessibilityIntent	да
requestedBackend	ComputeBackendKind \| null	нет

Success payload · workbook_accessibility

Поле	Тип TypeScript	Обяз.
operation	“workbook_accessibility”	да
subsetId	string	да
session	ContractSubsetSessionInfo	да
result	ContractWorkbookAccessibilityResult	да

Минимальный JSON-шаблон

{
  "operation": "workbook_accessibility",
  "subsetId": "<subsetId>",
  "requestId": "<string>",
  "expectedRevision": 0,
  "expectedGeneration": 0,
  "intent": "<ContractWorkbookAccessibilityIntent>",
  "requestedBackend": "native-desktop"
}

workbook_links_manager

Операция workbook links manager.

Request

Поле	Тип TypeScript	Обяз.
operation	“workbook_links_manager”	да
subsetId	string	да
intent	ContractWorkbookLinksIntent	да
requestedBackend	ComputeBackendKind \| null	нет

Success payload · workbook_links_manager

Поле	Тип TypeScript	Обяз.
operation	“workbook_links_manager”	да
subsetId	string	да
session	ContractSubsetSessionInfo	да
result	ContractWorkbookLinksResult	да

Минимальный JSON-шаблон

{
  "operation": "workbook_links_manager",
  "subsetId": "<subsetId>",
  "intent": "<ContractWorkbookLinksIntent>",
  "requestedBackend": "native-desktop"
}

workbook_window_session_command

Операция workbook window session command.

Request

Поле	Тип TypeScript	Обяз.
operation	“workbook_window_session_command”	да
subsetId	string	да
intent	ContractWorkbookWindowSessionAction	да
requestedBackend	ComputeBackendKind \| null	нет

Success payload · workbook_window_session_command

Поле	Тип TypeScript	Обяз.	Примечание из контракта
operation	“workbook_window_session_command”	да
projection	ContractWorkbookWindowSessionProjection	да

Минимальный JSON-шаблон

{
  "operation": "workbook_window_session_command",
  "subsetId": "<subsetId>",
  "intent": "<ContractWorkbookWindowSessionAction>",
  "requestedBackend": "native-desktop"
}