protection.setEditingRestriction

Enable Word-style editing restriction on the document. Only readOnly mode is supported in v1.

Summary

Enable Word-style editing restriction on the document. Only readOnly mode is supported in v1.

• Operation ID: protection.setEditingRestriction
• API member path: editor.doc.protection.setEditingRestriction(...)
• Mutates document: yes
• Idempotency: idempotent
• Supports tracked mode: no
• Supports dry run: yes
• Deterministic target resolution: yes

Expected result

Returns a ProtectionMutationResult with the updated protection state on success.

Input fields

Field	Type	Required	Description
formattingRestricted	boolean	no
mode	enum	yes	"readOnly"

Example request

{
  "formattingRestricted": true,
  "mode": "readOnly"
}

Output fields

No fields.

Example response

{}

Pre-apply throws

• INVALID_INPUT
• CAPABILITY_UNAVAILABLE

Non-applied failure codes

• NO_OP

Raw schemas

Raw input schema

{
  "additionalProperties": false,
  "properties": {
    "formattingRestricted": {
      "type": "boolean"
    },
    "mode": {
      "enum": [
        "readOnly"
      ],
      "type": "string"
    }
  },
  "required": [
    "mode"
  ],
  "type": "object"
}

Raw output schema

{
  "type": "object"
}

Raw success schema

{
  "type": "object"
}

Raw failure schema

{
  "type": "object"
}