Document apiReferenceImages

images.setHyperlink

Set or remove the hyperlink attached to an image.

mutates documenttracked modedry runconditional
doc.images.setHyperlink(…)

Expected result

Returns an ImagesMutationResult; reports NO_OP if unchanged.

Inputs

imageIdstringrequired
urlstring | nullrequired
1 additional input field
tooltipstring

Result

Output fields
appliedChangeMode"direct" | "tracked"
idstring
insertedEntityAddress[]
updatedEntityAddress[]
removedEntityAddress[]
invalidatedRefsAffectedRef[]
remappedRefsAffectedRefRemapping[]
affectedStoriesStoryLocator[]
textRangeShiftsTextRangeShift[]
txIdstring
warningsReviewWarning[]
effectsReceiptEffects
Fields
insertedTextTextMutationEffect[]
insertedBlocksBlockMutationEffect[]
trackedChangeRefsTrackedChangeAddress[]
trackedChangeCountinteger
changedboolean
successboolean
imageobject
failureobject

Failures

Pre-apply throws

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

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