与 Collab- provider 合并

本指南概述了与协作提供者相结合的两个主要使用案例.

使用大小写

1. 全面整合:FE事件和BE API呼叫
   • 对于既需要前端事件又需要后端 API 交互的情景,后端 API 由 pf-collab-service为确定是否需要API呼叫,请参见 OpenAPI 文档,具体在 Service to Service 节.
2. 部分整合:仅FE活动
   • 对于只需要前端事件,没有后端API交互的情景.

整合细节

1. 全面整合:FE事件和BE API呼叫
   • 确保供应商以下列方式初始化:
     • DocumentService 从 document-service.ts
     • Api 从 api.ts
2. 部分整合:仅FE活动
   • 确保供应商以下列方式初始化:
     • NullDocumentService 从 null-document-service.ts
     • NullApi 从 null-api.ts

关于这些整合方法的详细比较,请参考以下表格中的源代码: ../platform/packages/editor/collab-provider/src/provider/index.ts

// Full integration
- setup({getState, onSyncUpError}: {getState: () => EditorState; onSyncUpError?: SyncUpErrorFunction;})

// Partial Integration, initialize the provider with passing config isPresenceOnly as true
- setupForPresenceOnly(clientId: string)

支助

如有其他问题或需要帮助,请联系 #团队-cc-编辑服务 在斯莱克.