Document apiReferenceSections

sections.setBreakType

Set the section break type.

mutates documentdry runconditional
doc.sections.setBreakType(…)

Expected result

Returns a SectionMutationResult receipt; reports NO_OP if the section already has the requested break type.

Inputs

targetSectionAddressrequired
Fields
kind"section"required
sectionIdstringrequired
breakType"continuous" | "nextPage" | "evenPage" | "oddPage"required

Result

Output fields
true
successtruerequired
sectionSectionAddressrequired
Fields
kind"section"required
sectionIdstringrequired
false
successfalserequired
failureobjectrequired
Fields
code"NO_OP" | "INVALID_TARGET" | "CAPABILITY_UNAVAILABLE"required
messagestringrequired
detailsunknown

Failures

Pre-apply throws

  • TARGET_NOT_FOUND
  • INVALID_TARGET
  • INVALID_INPUT
2 more codes
  • CAPABILITY_UNAVAILABLE
  • INTERNAL_ERROR

Non-applied receipt codes

  • NO_OP
  • INVALID_TARGET
  • CAPABILITY_UNAVAILABLE

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