ADF node: syncBlock

Node

Description

The syncBlock node is a placeholder block whose content is synchronized between two or more editor contexts. Initially it will only be supported in Confluence, but it may be introduced to other products in time.

Example

Java

1
2
3
4
5
6
doc(
        syncBlock()
                .resourceId("ari:cloud:confluence:87654321:page/11223344")
                .localId("27166f87-b93b-4b41-8fbd-abc9565327af");
);

ADF

1
2
3
4
5
6
7
8
9
10
11
12
13
14
{
  "type": "doc",
  "version": 1,
  "content": [
    {
      "type": "syncBlock",
      "attrs": {
        "resourceId": "ari:cloud:confluence:87654321:page/11223344",
        "localId": "27166f87-b93b-4b41-8fbd-abc9565327af"
      }
    }
  ]
}

Compatibility

Products

Usage

• DocContent
• LayoutColumnContent
• NonNestableBlockContent
• PanelContent
• TableCellContent

Marks

❌ N/A

Structure

• type - syncBlock
• attrs
  • localId - string1
  • resourceId - string2

---

1. The localId will typically be a random UUID. This is not enforced by the schema.↩︎
2. The resourceId will typically be an Atlassian Resource Identifier (ARI), which i a globally unique identifier used across Atlassian apps and services for the unique identification of content.↩︎