Join Channel
channel_joinJoin a plugin channel to establish a live connection to a Figma document for real-time updates.
Instructions
Join a plugin channel to establish the live connection to the Figma document.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| channel | Yes | The name of the channel to join |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| node | No | ||
| pages | No | ||
| status | Yes | Connection status | |
| channel | Yes | Channel name | |
| errorCode | No | Error code if status is error | |
| pageCount | No | Number of pages in the document | |
| documentId | No | Figma document ID | |
| scopeRootId | No | Editable scope root node ID | |
| documentName | No | Figma document name | |
| errorMessage | No | Error message if status is error | |
| allowEditNode | No | false | 'page' | 'node' | |
| allowEditStyle | No | Whether style edits are allowed | |
| allowEditVariable | No | Whether variable edits are allowed | |
| editableScopeType | No | readonly, page, or node |