@univerjs-pro/collaboration-client v0.5.0-beta.1 • Docs
@univerjs-pro/collaboration-client
Enumerations
| Enumeration | Description |
|---|---|
| CollaborationStatus | - |
| SessionStatus | - |
Classes
| Class | Description |
|---|---|
| AuthzIoHttpService | - |
| CollaborationController | - |
| CollaborationEntity | Each univer document instance would map to an CollaborationEntity to handle collaborated editing events. |
| CollaborationSession | The data structure to represent a collaboration session. It also manages the collaborator’s identity. |
| CollaborationSessionService | This service provide collaboration sessions to univer instances. A collaboration session may be used by different controllers of different features. |
| CollaborationSocketService | This service provides a socket that can be used to communicate with the remote collaboration server. |
| CommentService | - |
| DataLoaderController | This controller loads data when URL changes. |
| DesktopCollaborationStatusDisplayController | This controller is responsible for monitoring the collaboration status of the currently focused unit. |
| DocCollaborationEntity | Each univer document instance would map to an CollaborationEntity to handle collaborated editing events. |
| ImageIoService | - |
| LocalCacheService | This service provide caching to the collaboration controller. |
| MemberService | This services manages members is each rooms. |
| MentionIoHttpService | - |
| SheetCollabCursorShape | Render a single collaborated cursor on the canvas. |
| SheetCollaborationEntity | Each univer document instance would map to an CollaborationEntity to handle collaborated editing events. |
| SnapshotServerOverHTTPService | - |
| UniverCollaborationClientPlugin | Plug-in base class, all plug-ins must inherit from this base class. Provide basic methods. |
| WebURLService | This service reads the url from the host platform and return url parts, such as queries, hashes and path. |
Interfaces
| Interface | Description |
|---|---|
| ICollaborationSocket | - |
| ICollaborationSocketService | This service provides a socket that can be used to communicate with the remote collaboration server. |
| ISheetCollabCursorShapeProps | - |
| IUniverCollaborationClientConfig | - |
| IURLService | This service reads the url from the host platform and return url parts, such as queries, hashes and path. |
Variables
| Variable | Description |
|---|---|
| AUTHZ_URL_KEY | - |
| COLLAB_CLIENT_CONFIG_KEY | - |
| COLLAB_SUBMIT_CHANGESET_URL_KEY | - |
| COLLAB_WEB_SOCKET_URL_KEY | - |
| HEARTBEAT_INTERVAL_KEY | The heartbeat interval in milliseconds. |
| HEARTBEAT_TIMEOUT_KEY | - |
| LOCAL_CACHE_INTERVAL_KEY | A config key to determine how often should Univer save local edits. |
| LOGIN_URL_KEY | - |
| RETRY_CONNECTING_MAX_COUNT_KEY | - |
| SEND_CHANGESET_TIMEOUT_KEY | - |
| SNAPSHOT_SERVER_URL_KEY | - |
Functions
| Function | Description |
|---|---|
| CollaborationStatusDisplay | A component to display collaboration status to users. |
| deserializeToCombResponse | - |
| ICollaborationSocketService | - |
| IURLService | - |
| serializeCombRequest | - |