Document apiReferenceToc

toc.configure

Update the configuration switches of a table of contents.

mutates documentdry runconditional
doc.toc.configure(…)

Expected result

Returns a TocMutationResult with the updated TOC address on success, or a failure code on no-op.

Inputs

targetobjectrequired
Fields
kind"block"required
nodeType"tableOfContents"required
nodeIdstringrequired
patchobjectrequired
Fields
outlineLevelsobject
Fields
fromintegerrequired
tointegerrequired
useAppliedOutlineLevelboolean
tcFieldIdentifierstring
tcFieldLevelsobject
Fields
fromintegerrequired
tointegerrequired
hyperlinksboolean
hideInWebViewboolean
omitPageNumberLevelsobject
Fields
fromintegerrequired
tointegerrequired
separatorstring
includePageNumbersboolean
tabLeader"none" | "dot" | "hyphen" | "underscore" | "middleDot"
rightAlignPageNumbersboolean

Result

Output fields
true
successtruerequired
tocobjectrequired
Fields
kind"block"required
nodeType"tableOfContents"required
nodeIdstringrequired
false
successfalserequired
failureobjectrequired
Fields
code"NO_OP" | "INVALID_TARGET" | "TARGET_NOT_FOUND" | "CAPABILITY_UNAVAILABLE" | "INVALID_INSERTION_CONTEXT" | "PAGE_NUMBERS_NOT_MATERIALIZED"required
messagestringrequired
detailsunknown

Failures

Pre-apply throws

  • TARGET_NOT_FOUND
  • INVALID_TARGET
  • INVALID_INPUT
1 more codes
  • CAPABILITY_UNAVAILABLE

Non-applied receipt codes

  • NO_OP

Raw schemas

Open the generated JSON artifact for the exact input, output, success, and failure schemas represented by this contract version.

View raw JSON schemas