목차

EVENT_TYPE

Collaboration 플러그인에서 사용할 수 있는 이벤트 타입입니다.

on(), off() 메소드를 활용해 이벤트에 대한 리스너를 설정하거나 제거할 수 있습니다.

{
    setForceUpdate: (update: boolean) => void
}

var editor = new SynapEditor(id, synapEditorConfig);
var collaboration = editor.plugins.collaboration;
var EVENT_TYPE = collaboration.EVENT_TYPE;

collaboration.on(EVENT_TYPE.ON_SYNC, function (event) {
    event.setForceUpdate(true);
});

[
    { id: {number}, name: {string}, color: {string}, position: {Position}, modified: {number}, self: {boolean} }, 
    ....
]

var editor = new SynapEditor(id, synapEditorConfig);
var collaboration = editor.plugins.collaboration;
var EVENT_TYPE = collaboration.EVENT_TYPE;

collaboration.on(EVENT_TYPE.USER_CHANGED, function (users, added, removed) {});

[
    { id: {number}, name: {string}, color: {string}, position: {Position}, modified: {number}, self: {boolean} }, 
    ....
]

var editor = new SynapEditor(id, synapEditorConfig);
var collaboration = editor.plugins.collaboration;
var EVENT_TYPE = collaboration.EVENT_TYPE;

collaboration.on(EVENT_TYPE.USER_INFO_CHANGED, function (users) {});

on(eventType, listener)

Collaboration 플러그인에서 발생하는 이벤트에 대한 리스너를 설정합니다.

off(eventType, listener)

Collaboration 플러그인에서 발생하는 이벤트에 대한 리스너를 제거합니다.

setUserName(name)

사용자의 이름을 설정합니다.

setUserColor(color)

사용자의 색상을 설정합니다.

getClientId()

사용자의 Client Id를 반환합니다.

init()

실시간 협업을 초기화 합니다.

changeDocument(docId)

실시간 협업 문서를 docId 에 해당하는 문서로 교체합니다.

destroy()

실시간 협업을 종료합니다.

setInit(fn)

Collaboration 플러그인이 초기화 되는 시점에 호출됩니다.

getHistory()

업데이트 기록을 반환합니다.

updateHistoryOriginal(modelJSON)

업데이트 기록의 원본 모델을 업데이트합니다.

parameter로 modelJSON을 넘기지 않은 경우 에디터의 현재 모델로 업데이트 합니다. 업데이트 기록 데이터의 versions 가 초기화 됩니다.

applyChanges()

에디터 모델에서 변경된 사항들을 실시간 협업 모델에 적용합니다.