Important changes to Tiny Cloud pricing > Find out more

Overview of the Real-Time Collaboration configuration options

List of all available RTC configuration options.

Contribute to this page

Configuration style

The Real-Time Collaboration (RTC) plugin uses promise-based “provider” functions to support a variety of configuration scenarios including asynchronously fetching data from a server. Function input parameters are provided as an object, allowing unused fields to be omitted.

Overview of RTC options

Required configuration options

These options are required when using the Real-Time Collaboration (RTC) plugin.

rtc_document_id
Provide a unique identifier for current document (editor content).
rtc_encryption_provider
Provide the editor with encryption details for encrypting the content before it is shared between collaborators.
rtc_token_provider
Provide the editor with a JSON Web Token (JWT) for verifying that the user has access to edit the current document.

Recommended configuration options

These options are assist with improving the user experience. They are not required, but are recommended.

rtc_server_disconnected
Assists with communitcating to the end-user that either:
  • They have been unsuccessful in connecting to the collaboration session.
  • They have lost their connection to the collaboration session.
rtc_user_details_provider
This option:
  • Allows the user’s name or an alias to be shown on user “carets” in collaborative sessions, and
  • Assists with providing data for:
    • The rtc_client_connected and rtc_client_disconnected options.
    • The RtcClientConnected and RtcClientDisconnected events.

Optional configuration options

The following options assist with integrating Real-Time Collaboration and improving the user experience.

rtc_snapshot
Assists with autosaving the editor content during a RTC session.
rtc_initial_content_provider
Assists with adding initial content for a newly created (initialized) editor.
rtc_client_info
Allows additional user details to be provided for:
  • The rtc_client_connected and rtc_client_disconnected options.
  • The RtcClientConnected and RtcClientDisconnected events.
rtc_client_connected
Assists with notifying users that collaborators have joined a RTC session and can be used to maintain a list of connected users.
rtc_client_disconnected
Assists with notifying users that collaborators have left a RTC session and can be used to update a list of connected users.
rtc_unsupported_content_notification
Allows integrators (developers) to disable the unsupported content notification.

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.