편집기 커맨드

호스트 페이지가 편집기로 보내는 메시지입니다. session.post(action, info)로 보냅니다. payload 타입은 @edicus/sdk/types의 EditorCommandMap에 있습니다.

session.post('command', { type: 'save', force_save: true })

편집기는 자체 UI로 대부분을 처리하므로, 커맨드는 내 페이지에서 편집기 동작을 직접 일으켜야 할 때 씁니다.

자주 쓰는 커맨드

`command`

undo, redo, 저장 같은 편집 명령입니다.

string

required

편집기가 실제로 분기해 처리하는 값 전체입니다.'undo', 'redo', 'save', 'save-then-close', 'preview', 'close-preview', 'cancel-imposing', 'save-imposing-then-close', 'request-doc-report', 'test', 'alert-back'

boolean

변경사항이 없어도 저장을 강제합니다.

boolean

진행 표시를 보여줍니다.

session.post('command', { type: 'undo' })
session.post('command', { type: 'redo' })
session.post('command', { type: 'save', force_save: true })

과거 문서에는 undo, redo, save 세 가지만 실려 있었습니다. 위 목록이 편집기가 실제로 처리하는 전체입니다.

`add-image`

이미지를 삽입합니다.

string

required

이미지 소스 종류입니다. 'file-input'은 파일 불러오기 창으로 로컬 파일을 추가합니다.

string

required

추가 방법입니다. 'add'는 마지막 아이템으로 추가합니다.

string

required

추가할 아이템 종류입니다. 'cell'은 사진틀로, 'sticker'는 스티커로 추가합니다.

session.post('add-image', {
  src_type: 'file-input',
  method: 'add',
  item_type: 'sticker',
})

`add-text`

텍스트를 삽입합니다.

varInfo

외부연동 변수 정보입니다.

Show varInfo

string

외부연동 action 타입입니다. input 또는 select입니다.

string

외부연동에 쓸 아이템 id입니다.

string

외부연동 아이템의 title입니다.

string

select 타입일 때의 group id입니다.

any

외부연동 부가 데이터입니다. 구조가 정의돼 있지 않습니다.

object

Show data

string

텍스트 내용입니다.

number

폰트 크기입니다. pt 단위입니다.

'left' | 'center' | 'right'

가로 정렬입니다.

session.post('add-text', {
  variable: { type: 'input', id: '_text_001_', title: '이름', group_id: '', extra: undefined },
  data: { text: '내용을 입력하세요', font_size: 10, align: 'left' },
})

`var-changed`

호스트 쪽에서 외부연동 텍스트의 값이 바뀌었음을 편집기에 알립니다.

session.post('var-changed', {
  variable: { type: 'input', id: '_text_001_', title: '이름', group_id: '', extra: undefined },
  data: { text: '새 이름' },
})

`request-feature`

편집기의 부가 UI를 요청합니다. 편집기가 상황에 따라 거부할 수 있습니다. ready-to-listen을 받은 직후에 보내시는 것을 권합니다.

string

required

요청하는 기능입니다. 현재 'promo-window'(프로모션 화면)를 쓸 수 있습니다.

object

Show option@promo-window

number

원하는 화면 너비입니다. 제한될 수 있습니다.

number

원하는 화면 높이입니다. 제한될 수 있습니다.

string

iframe에 띄울 주소입니다.

boolean

시작할 때 화면을 활성화할지입니다.

session.on('ready-to-listen', () => {
  session.post('request-feature', {
    feature: 'promo-window',
    option: { preferredWidth: 480, preferredHeight: 600, url: 'https://...', opened: true },
  })
})

option의 필드는 preferredWidth처럼 camelCase입니다. 다른 대부분의 위치는 snake_case를 씁니다.

`send-user-token`

request-user-token에 대한 수동 응답입니다.

string

required

새로 발급받은 토큰입니다.

session.post('send-user-token', { token })

createEdicusClient({ getToken })을 설정하셨다면 SDK가 자동으로 보내므로 직접 부를 필요가 없습니다.

전체 커맨드 목록

type은 전부 to-edicus입니다.

action	payload 타입	비고
`command`	`CommandInfo`	위 설명을 보세요
`select-page`	`SelectPageInfo`
`execute-ddp-block`	`{ ddp_block: unknown; history_label?: string }`
`var-changed`	`{ variable?: VarInfo; data?: { text: string } }`	추가 필드를 허용합니다
`add-image`	`AddImageInfo`
`add-text`	`AddTextInfo`
`set-cell-src-infos`	`SetCellSrcInfos`
`clear-cell-src`	`ClearCellSrc`
`get-scene-info`	`GetSceneInfo`
`save-snapshot`	`SaveSnapshotInfo`
`capture-gallery`	`CaptureGalleryInfo`
`request-feature`	`RequestFeatureInfo`
`apply-reform`	`ApplyRefromInfo`	타입 이름이 `Reform`이 아니라 `Refrom`입니다. 오타 그대로입니다
`set-mutable-prod-var`	`SetProdVarsInfo`
`return-message`	`{ action: string; info: unknown }`
`auto-fill-photo`	`unknown`
`import-project`	`ImportProjectInfo`
`change-toolbar-prefix-html`	`{ html: string }`
`send-user-token`	`{ token: string }`	`request-user-token`에 대한 응답입니다

시작하기

개념

편집기 SDK

서버 연동

레퍼런스

자주 쓰는 커맨드

`command`

`add-image`

`add-text`

`var-changed`

`request-feature`

`send-user-token`

전체 커맨드 목록

다음 단계

편집기 이벤트

닫기와 저장 후처리

​자주 쓰는 커맨드

​command

​add-image

​add-text

​var-changed

​request-feature

​send-user-token

​전체 커맨드 목록

​다음 단계

편집기 이벤트

닫기와 저장 후처리

자주 쓰는 커맨드

`command`

`add-image`

`add-text`

`var-changed`

`request-feature`

`send-user-token`

전체 커맨드 목록

다음 단계