protection.setEditingRestriction

​

Summary

• 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

​

Input fields

​

Example request

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

​

Output fields

​

Example response

{}

​

Pre-apply throws

• INVALID_INPUT
• CAPABILITY_UNAVAILABLE

​

Non-applied failure codes

• NO_OP

​

Raw schemas

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

{
  "type": "object"
}

{
  "type": "object"
}

{
  "type": "object"
}