ADF node: bodiedSyncBlock

Node

Description

The bodiedSyncBlock node is a placeholder block whose content is synchronized between two or more editor contexts. Only one ADF document should use bodiedSyncBlock for the synchronized content, which is stored within that node. It is the source of truth for the content. Other documents use a [→ syncBlock] to refer to the shared content. Initially this feature will only be supported in Confluence, but it may be introduced to other products in time.

Example

Java

1
2
3
4
5
6
7
8
9
10
doc(
        bodiedSyncBlock()
                .resourceId("ari:cloud:confluence:87654321:page/11223344")
                .localId("27166f87-b93b-4b41-8fbd-abc9565327af");
                .content(
                        p("This content will be synchronized"),
                        codeBlock().content("console.log('hello');")
                )
);

ADF

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
{
  "type": "doc",
  "version": 1,
  "content": [
    {
      "type": "bodiedSyncBlock",
      "attrs": {
        "resourceId": "ari:cloud:confluence:87654321:page/11223344",
        "localId": "27166f87-b93b-4b41-8fbd-abc9565327af"
      },
      "content": [
        {
          "type": "paragraph",
          "content": [
            {
              "type": "text",
              "text": "This content will be synchronized"
            }
          ] 
        },
        {
          "type": "codeBlock",
          "content": [
            {
              "type": "text",
              "text": "console.log('hello');"
            }
          ]
        }
      ]
    }
  ]
}

Compatibility

Products

Usage

• DocContent

Marks

❌ N/A

Structure

• type - bodiedSyncBlock
• attrs
  • localId - string1
  • resourceId - string2
• content – array(BodiedSyncBlockContent…)
• marks? - array([→ Breakout])

---

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.↩︎