Document apiReference

clearContent

Clear all document body content, leaving a single empty paragraph.

mutates documentconditional
doc.clearContent(…)

Expected result

Returns a Receipt with success status; reports NO_OP if the document is already empty.

Inputs

This operation takes no input fields.

Result

Output fields
true
successtruerequired
idstring
insertedEntityAddress[]
updatedEntityAddress[]
removedEntityAddress[]
invalidatedRefsAffectedRef[]
remappedRefsAffectedRefRemapping[]
affectedStoriesStoryLocator[]
textRangeShiftsTextRangeShift[]
txIdstring
false
successfalserequired
failureobjectrequired
Fields
code"NO_OP"required
messagestringrequired
detailsunknown

Failures

Pre-apply throws

  • 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