@ fluidframework/odsp-driver (英语)
ODSP (OneDrive/Sharepoint) 驱动程序是一种流体驱动程序的实施,它便利了交流 客户端和 ODSP 服务器以检索 Fluid 内容并连接到 Fluid 协作会话.
ODSP Fluid 服务不是公开服务,目前无法使用此驱动程序 连接到它。 这个驱动程序作为不同流体驱动程序执行的示例而存在. 开发者不应该依赖这个驱动程序来获得自己的解决方案.
遥测事件名称到 SPO API 映射 :
这些事件名称由 _end 如果它们成功 API 呼叫或通过 _cancel 以防他们失败.
在表格中,我使用了失败者.
| 事件名称 | 终点 | 页:1 |
|---|---|---|
| 流体:遥测:OdspDriver:TreesLatest cancel | /_api/v2.1/drives/DRIVEID/items/ITEMID/opStream/snapshots/trees/latest?ump=1 | 从存储中获取快照出错, 通常是在文档加载时 。 (电话) |
| 流体:遥测:OdspDriver:GetDeltas cancel 流体:遥测:OdspDriver:OpsFetch cancel | /_api/v2.1/drives/DRIVEID/items/ITEMID/opStream?ump=1&filter=sequenceNumber ge START and sequenceNumber le END | 从存储取出操作错误 。 (电话) |
| 流体: 遥测: OdspDriver:Join Session cancel | /_api/v2.1/drives/DRIVEID/items/ITEMID/opStream/joinSession?ump=1 | 获取连接到套接字所需的细节时出错 。 此外,每15分钟还召集一次延长会议。 (电话) |
| 流体:遥测: BlobManager:相接读取Blob 取消 流体: 遥测: OdspDriver: readDataBlob cancel | /_api/v2.1/drives/DRIVEID/items/ITEMID/opStream/attachments/BLOB_ID/content | 读取附件 blobs (例如图像) 时出错 。 (电话) |
| 流体: 遥测: OdspDriver: createBlob cancel | /_api/v2.1/drives/DRIVEID/items/ITEMID/opStream/attachment/content | 创建附件 blob( 如插入的图像) 时出错 。 (电话) |
| 流体: 遥测: OdspDriver: CreateNewFile cancel | /_api/v2.1/drives/DRIVEID/items/root:%2f<path>.fluid:/opStream/snapshots/snapshot?ump=1 | 创建新流体文件时出错, 在容器附件时出错 。 (电话) |
| 流体:遥测:OdspDriver:创建NewEmptyFile cancel | /_api/v2.1/drives/DRIVEID/items/root://FILEPATH/FILENAME:/[email protected]=rename&select=id,name,parentReference&ump=1 | 创建新空 Fluid 文件出错 。 当我们在分离容器中有附件 blobs时,我们首先创建空文件,然后上传附件 blobs,然后上传摘要,以便摘要可以指那些 blobs. (电话) |
| 流体:遥测:OdspDriver:上载简表 跳出 | /_api/v2.1/drives/DRIVEID/items/ITEMID/opStream/snapshots/snapshot | 上传流体摘要到存储时出错 。 (电话) |
| 流体:遥测:OdspDriver:RedeemShareLink cancel | _api/v2.0/shares/${encodedShareUrl}/driveItem | 抓取时在单回合 Trip 赎回后赎回共享链接时出错 . 更多关于单曲RT Redeem在这里. |
| 奥德斯普驱动器:odspFileLink cancel OdspDriver: get ShareLink 取消 | /_api/v2.0/drives/${driveId}/items/${itemId}?select=webUrl,webDavUrl,sharepointIds | 获取共享链接时出错 requestName =: getFileItemLite 在遥测. getShareLink 事件为 odspFileLink 活动. |
| 奥德斯普驱动器:odspFileLink cancel OdspDriver: get ShareLink 取消 | /_api/web/GetFileById(@a1)/ListItemAllFields/GetSharingInformation?@a1=guid${encodeURIComponent(${ file Project.sharepointIds.list Project UniqueId}} ${ file Project.sharepointIds.list Project UniqueId}}}\ ${文件项目)} | 获取共享链接时出错 requestName =: getSharingInformation 在遥测. getShareLink 事件为 odspFileLink 活动. |
使用 Fluid 框架库
对于依赖流体框架库的公共API,我们建议 ^ (caret)版本范围.
例如,使用 ^1.3.4。 。 。 .
依赖不稳定的API,例如: beta API,我们推荐一个更具限制性的版本范围.
例如,使用一个 ~ 版本范围.
安装
运行此命令以安装软件包 :
npm i @fluidframework/odsp-driver
从此软件包导入
此软件包使用 packet.json 导出 通过支持级别将API分离. 有关支助保障的信息改为: API 支持级别。 。 。 .
导入 public API 从 @fluidframework/odsp-driver。 。 。 .
导入 legacy API 从 @fluidframework/odsp-driver/legacy。 。 。 .
API 文档
读取 @ fluidframework/odsp-driver (英语) API 文档 https://fluidframework.com/docs/apis/odsp-driver 互联网档案馆的存檔,存档日期2013-12-21。 。 。 .
ODSP APIs 数字化
记录与从ODSP创建或加载流体文件有关的关于opds-driver特定活体的一些基本情况.
/ snapshot API 图像
- 创建新的 Fluid 文件,其内容作为请求正文中提供的摘要.
- 与摘要一起创建文件是在一个单独的api呼叫中完成的,以减少新文件创建期间的来回旅行次数.
- 又支持创建文件共享链接, 如果在 api 呼叫中提供了适当的请求头 。 引入这个功能是为了在创建文件,然后创建共享链接的同时,保存一个主机应用程序的回程次数.
- 刚刚
&createLinkType=csl支持可建立组织范围共享链接的参数。 特性由enableShareLinkWithCreate通过HostStoragePolicy. (创建 LinkType 现在已贬值, 因此倾向于使用下面的选项2) - 现在,提供合适的价值
&createLinkScope财务报告和审定财务报表&createLinkRole请求参数将允许您创建与各种权限范围的共享链接。 见resolvedUrl定义更多细节。 特性由enableSingleRequestForShareLinkWithCreate通过HostStoragePolicy。 。 。 .
- 刚刚
/树木/最晚 API
- 获取已有流体文件的快照.
- 更早,申请需要先赎回文件的共享链接,然后才能进行/trees/latest取回. 为了减少到ODSP的往返次数,现在通过在ODSP中通过共享链接获取同一API请求中的最新快照,从而恢复共享链接
&sl请求参数. - 这个api也是无飞行前的,这意味着它之前没有在浏览器中发出OPSIONs呼叫以减少网络到服务器的行程.
客户最低要求
Fluid框架客户端库支持此文档中的平台. 这些要求有意具有限制性. 在一个主要的版本系列中,我们可以放松这些要求,但我们不能使其更严格. 对于长期支持(LTS)版本,我们可能需要支持这些平台几年.
其他配置可以奏效,但Fluid框架不支持. 如果一个不支持的配置停止工作, 我们不会将此归类为错误 . 要请求支持未列出的配置, 请存档 . 产品组会评估你的要求. 在此问题上,请具体说明配置的现状:
- 配置有效但需要官方支持.
- 配置不起作用,需要更改.
支持的运行时间
- Fluid框架支持节点.js版本22和24同时收到 上游支助。 。 。 .
- 流体框架将停止支持第22版 当上游支持于2027-04-30结束时。 。 。 .
- 流体框架不支持节点.js与
--no-experimental-fetch旗帜.
- Fluid框架支持支持ES2022标准库的现代浏览器.
支持的工具
- 类型脚本 6.0数字 :
- 流体框架支持全部
strict选项. - 设定建设目标(
lib, (中文(简体) ),target改为:ES2022或后会. - 启用
strictNullChecks。 。 。 . - 流体框架不支持 在 TypeScript 6.0 中贬值的配置选项。 。 。 .
- 流体框架不完全支持
exactOptionalPropertyTypes。 。 。 . 如果您启用此选项, 请不要使用in, (中文(简体) ),Reflect.has, (中文(简体) ),Object.hasOwn,或Object.prototype.hasOwnProperty改为Fluid框架类型的窄成员. 这些方法可以错误地排除undefined从可能的值.
- 流体框架支持全部
- 网络软件包 页:1
- 我们不需要一个特定的捆绑者. 其他处理ES模块的捆绑机可以工作,但我们只积极测试网页包.
模块分辨率
在类型脚本中 compilerOptions,使用时 Node16, (中文(简体) ), Node20, (中文(简体) ), NodeNext,或 Bundler 模块分辨率.
这些设置遵循 节点.js v12+无害环境管理 分辨率和加载算法。 。 。 .
不使用 Node10 模块分辨率.
模块格式
- ES模块: 使用ES模块来消耗Fluid框架客户端软件包,包括在Node.js中.
- 常见JS : Fluid Framework在3.0版本或后期不正式支持CommonJS.
贡献准则
你们可以 贡献 通过这些方式实现流体框架:
详细指示改为: repo 文档。 。 。 .
本项目遵循 Microsoft 开源行为守则。 。 。 . 更多信息,改为: 《行为守则》经常被问到的问题。 。 。 . 问题或评论,联系 打开码@ microsoft.com。 。 。 .
这个项目可能包含微软项目的商标或标志,产品,或服务. 这些商标或标志的使用必须遵循微软 商标和品牌准则。 。 。 . 在这个项目的修改后版本中使用微软商标或标志不得造成混淆或暗示微软赞助.
帮助
读取 流体框架文件 用于了解流体框架概念和API.
要求提供文件未载列的资料, 创建问题。 。 。 .
商标
这个项目可能包含微软项目的商标或标志,产品,或服务.
这些商标或标志的使用必须遵循微软的 商标和品牌准则。 。 。 .
在这个项目的修改后版本中使用微软商标或标志不得造成混淆或暗示微软赞助.