...
| 이벤트 타입 | 설명 |
|---|
| ON_SYNC | - 실시간 협업이 연결되었을 때 발생합니다.
- 리스너의 parameter로 전달되는 값:
| Name | Type | Description |
|---|
| event | Object |
| Code Block |
|---|
| {
setForceUpdate: (update: boolean) => void
} |
- setForceUpdate(update): 실시간 협업 모델을 현재 에디터에 작성된 모델로 강제로 업데이트할지 여부를 설정합니다.
|
| Code Block |
|---|
| language | js |
|---|
| theme | Emacs |
|---|
| title | example |
|---|
| 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);
}); |
|
| USER_CHANGED | - 접속 중인 사용자 수가 변경되었을 때 발생합니다.
- 리스너의 parameter로 전달되는 값:
| Name | Type | Description |
|---|
| users | Object[] | 접속 중인 사용자 목록 배열입니다. | Code Block |
|---|
| [
{ id: {number}, name: {string}, color: {string}, data: {Object}, position: {Position}, modified: {number}, self: {boolean} },
....
] |
- id: 사용자의 Client Id
- name: 사용자의 이름
- color: 사용자 색
- data: 사용자 데이터
- position: 사용자의 커서 위치 정보
- modified: 마지막으로 업데이트된 시간 timestamp
- self: 사용자가 나 인지 여부
| | added | number[] | 추가된 사용자의 Client Id 배열입니다. | | removed | number[] | 제거된 사용자의 Client Id 배열입니다. |
| Code Block |
|---|
| language | js |
|---|
| theme | Emacs |
|---|
| title | example |
|---|
| 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) {}); |
|
| USER_INFO_CHANGED | - 접속 중인 사용자의 이름, 색, 커서 위치 정보가 변경되거나 사용자 수가 변경되었을 때 발생합니다.
- 리스너의 parameter로 전달되는 값:
| Name | Type | Description |
|---|
| users | Object[] | 접속 중인 사용자 목록 배열입니다. | Code Block |
|---|
| [
{ id: {number}, name: {string}, color: {string}, data{Object}, position: {Position}, modified: {number}, self: {boolean} },
....
] |
- id: 사용자의 Client Id
- name: 사용자의 이름
- color: 사용자 색
- data: 사용자 데이터
- position: 사용자의 커서 위치 정보
- modified: 마지막으로 업데이트된 시간 timestamp
- self: 사용자가 나 인지 여부
|
| Code Block |
|---|
| language | js |
|---|
| theme | Emacs |
|---|
| title | example |
|---|
| 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) {}); |
|
| DOCUMENT_UPDATED | | Status |
|---|
| colour | Yellow |
|---|
| title | 릴리즈 3.0.2404 이상 |
|---|
|
- 문서에 변경사항이 생겼을 때 발생합니다.
- 리스너의 parameter로 전달되는 값:
| Name | Type | Description |
|---|
| user | Object[] | 문서를 변경한 사용자 정보입니다. | Code Block |
|---|
| {
id: {number}, name: {string}, color: {string}, self: {boolean}
} |
- id: 사용자의 Client Id
- name: 사용자의 이름
- color: 사용자 색
- self: 사용자가 나 인지 여부
|
| Code Block |
|---|
| language | js |
|---|
| theme | Emacs |
|---|
| title | example |
|---|
| var editor = new SynapEditor(id, synapEditorConfig);
var collaboration = editor.plugins.collaboration;
var EVENT_TYPE = collaboration.EVENT_TYPE;
collaboration.on(EVENT_TYPE.DOCUMENT_UPDATED, function (user) {}); |
|
on(eventType, listener)
Collaboration 플러그인에서 발생하는 이벤트에 대한 리스너를 설정합니다.
...