@univerjs-pro/collaboration-client v0.5.4
index
Enumerations
| Enumeration | Description |
|---|---|
| CollaborationStatus | - |
| CollaborationUIEventId | - |
| SessionStatus | - |
| UnitStatus | - |
Classes
| Class | Description |
|---|---|
| AuthzIoHttpService | - |
| AwaitingState | All local mutations are sent to the server and waiting for acknowledgement. |
| AwaitingWithPendingState | Some local mutations are sent to the server and waiting for acknowledgement, yet still some local mutations are waiting to be sent to the server. |
| CollaborationController | - |
| CollaborationEntity | Each univer document instance would map to an CollaborationEntity to handle collaborated editing events. |
| CollaborationImageIoService | - |
| 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. |
| CollaborationUIEventService | - |
| CollaborativeUndoRedoService | This UndoRedoService is local. |
| CommentService | - |
| ConflictState | This state is special for handling collaboration conflicts. |
| DataLoaderService | This service provides a way to load data from the server and initialize the Univer instance. |
| DocCollaborationEntity | Each univer document instance would map to an CollaborationEntity to handle collaborated editing events. |
| FetchingMissState | When the client is trying to fetch missed changesets: |
| MemberService | This services manages members is each rooms. |
| MentionIoHttpService | - |
| OfflineState | - |
| PendingState | Some local changes are waiting to be sent to the server. But no changesets are waiting for acknowledgement. |
| SheetCollaborationEntity | Each univer document instance would map to an CollaborationEntity to handle collaborated editing events. |
| SheetTransformSelectionsService | - |
| SnapshotServerOverHTTPService | - |
| SyncedState | All local changesets are sent to and acknowledged by the server. |
| UniverCollaborationClientPlugin | Plug-in base class, all plug-ins must inherit from this base class. Provide basic methods. |
Interfaces
| Interface | Description |
|---|---|
| ICollaborationSocket | - |
| ICollaborationSocketService | This service provides a socket that can be used to communicate with the remote collaboration server. |
| IDocCollaborationEntityCallback | - |
| ILocalCacheService | - |
| INetworkConditionService | - |
| ISingleActiveUnitService | - |
| IUnitCacheData | - |
| IUniverCollaborationClientConfig | - |
Variables
| Variable | Description |
|---|---|
| - | |
| - | |
| - | |
| COLLABORATION_CLIENT_PLUGIN_CONFIG_KEY | - |
| DEFAULT_COLLAB_WEB_SOCKET_URL | - |
| DEFAULT_REMOTE_UNISCRIPT_EXECUTION_ENDPOINT | - |
| HEARTBEAT_INTERVAL_KEY | The heartbeat interval in milliseconds. |
| HEARTBEAT_TIMEOUT_KEY | - |
| LOCAL_CACHE_INTERVAL | - |
| LOCAL_CACHE_INTERVAL_KEY | A config key to determine how often should Univer save local edits. |
| The config key to determine the URL provided by the auth server | |
| REMOTE_UNISCRIPT_EXECUTION_ENDPOINT_KEY | The config key to determine the URL of the Uniscript execution endpoint. |
| RETRY_CONNECTING_MAX_COUNT_KEY | - |
| - | |
| - |
Functions
| Function | Description |
|---|---|
| deserializeToCombResponse | - |
| getLocalCacheKey | - |
| ICollaborationSocketService | - |
| ILocalCacheService | - |
| INetworkConditionService | - |
| ISingleActiveUnitService | It is not recommended to open multiple units in different browser tabs at the same time, especially when the there is not access to the internet. There is a great chance of loosing offline data! So we should make there is only one active unit at a time. |
| serializeCombRequest | - |