Real-Time Collaboration (RTC) events

Caution: These events are subject to change based on customer feedback. API compatibility is not guaranteed during the beta.

RtcClientConnected

This event is fired when a user enters the session.

Event fields: RtcClientConnected

See the rtc_client_connected documentation for a full description of the event fields.

Example of using the RtcClientConnected event

tinymce.init({
  selector: 'textarea',  // change this value according to your HTML
  plugins: 'rtc',
  setup: (editor) => {
    editor.on('RtcClientConnected', ({userId, userDetails, clientId, caretNumber, clientInfo}) => {
      console.log(`User connected userId:${userId}`);
    });
  }
})

RtcClientDisconnected

This event is fired when a user leaves the session.

Event fields: RtcClientDisconnected

This event provides the same event fields as the RtcClientConnected event. See the rtc_client_connected documentation for a full description of the event fields.

Example of using the RtcClientDisconnected event

tinymce.init({
  selector: 'textarea',  // change this value according to your HTML
  plugins: 'rtc',
  setup: (editor) => {
    editor.on('RtcClientDisconnected', ({userId, userDetails, clientId, caretNumber, clientInfo}) => {
      console.log(`User disconnected userId:${userId}`);
    });
  }
})

Can't find what you're looking for? Let us know.

Except as otherwise noted, the content of this page is licensed under the Creative Commons BY-NC-SA 3.0 License, and code samples are licensed under the Apache 2.0 License.