npm 包 @bentley/imodelhub-client 使用教程

在前端开发中,使用 npm 包是非常常见的,它可以帮助开发者快速构建自己的项目,提高开发效率。当涉及到使用 Bentley 的 iModelHub 时,我们可以使用它们提供的 npm 包 @bentley/imodelhub-client。它是一个非常好用的 npm 包,可以帮助我们轻松地实现与 iModelHub 的交互。

在这篇文章中,我们将提供一个详细的教程,介绍如何使用 @bentley/imodelhub-client。我们还将提供示例代码和指导意义,帮助读者更好地理解该 npm 包的使用方法。

安装

首先,我们需要在自己的项目中安装 @bentley/imodelhub-client。可以使用 npm 命令来安装,具体命令如下:

--- ------- ------------------------- ------

注意,在项目根目录中执行该命令。

使用示例

创建 Access Token

使用 @bentley/imodelhub-client 与 iModelHub 交互需要一个 Access Token,我们可以通过以下代码获取:

------ - ------------------- - ---- ----------------------------

----- ---------- - --- ----------------------
----- ----- - ----- ----------------------------

在进行下一步操作前,请确保已经获得了 Access Token。如果 Access Token 获得失败,则意味着你需要更换你的凭据信息。

获取 Projects

获取和创建项目是管理项目和 iModelHub 上的 iModel 的关键功能。使用以下代码可以获取所有项目:

------ -
  ------------ -------- --------------------------- ----------------
- ---- ----------------------------

----- --------------- - --- ------------------
----- -------------------------- - --- -----------------------------
----- ------------ --------- - ----- ----------------------------------------- ----------------------------

这些示例代码使用 IModelHubClient 和 Projects API 来访问 iModelHub 中的项目。其中 projectScopeRequestOptions 参数控制如何过滤项目列表,例如选择指定项目。如果你不需要使用过滤器,则不需要传递这个参数。需要注意的是,这个请求需要一个有效的 Access Token。

获取或创建 Briefcases

Briefcases 是 iModel 支持的特殊形式的锁定机制,用于保护一组人对同一份数据的更改。通常,应用程序使用 Briefcase 来指导如何在很短时间内同步和合并数据更改。以下示例展示了如何在 Briefcase 中列出 Briefcases:

------ -
  ------------ ---------------- --------------- ----------
- ---- ----------------------------

----- --------------- - --- ------------------
----- -------------- - --- -----------------
----------------------- - ---------
----- ----------- ----------- - ----- ------------------------------------------- ---------- ----------------

与获取项目相同,该请求也需要有效的 Access Token。briefcaseQuery 对象将筛选器传递给服务,并返回匹配筛选器的 Briefcases。

上传 Changesets

使用上一步列出的 Briefcases 集合,可以创建或更新 Briefcase。Briefcase 必须通过 Changeset 更新,并且每个 Briefcase 只能断开或合并成功。以下示例集合演示了如何创建 Changeset 并更新 Briefcase:

------ -
  ---------- ---------------
  ----------------------- ----------------------- ------------------ ----------
- ---- ----------------------------

----- --------------- -------------- - -
  ------------ ----------------------
  ------------------ ------------------------------
  ------------ --------------
--

----- --------- - --- --------------------------
----- ------------------------------------------------------ ------------ -------------- -----------
----- ----------------------- ---------------------- - - ----------------- -------- ---------- --------- --

----- -------- ---------------------------- ------------ ----------------------- ------------------------ --------------- -
    -- -- --- -------------- ------- -----
    ----- ----------------- - --- --------------------
    ----- ----- - ----- ------------------------------------------------------- -------

    ----- ------------------- ------------------ - -
        ------- ------
        -------- - -------------- ------- --------------------- --
        ----- ---------------------------------
      --
    ----- --- - ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
    ----- -------------- - ----- -------------------- ---- --------------------
    ------ --------------------
-

changesetFileDir 是指变更集的配置文件路径,其中包含待提交的变更集文件名及其哈希校验值。诸如 userName 和 password 等配置正在从 imodels 配置中提供。

下载 Changesets

以下代码展示如何使用 Briefcases 和 Changeset 对象下载匹配的 Briefcase 和 与 Briefcase 关联的 Changeset:

------ -
  --------------- ---------------- ---------- ----------------------
- ---- ----------------------------

----- --------------- - --- ------------------
----- -------------- - --- -----------------
-------------------------- - ----------------------
-----------------------------------
---------------------- - ----------------------------

----- ----------- ----------- - ----- ---------------------------------------------- ------- --------- ----------------
----- --------------------- ------ - ------------------ - -- - ---------------------------- - -------- - --

----- ------------------------ --------- - --------- - ------------------------------------- ---------- -- --------------- --- ----------------------
-- ------------------------ --- ---------- -
  -- --
-

该代码获取与 briefcase 中关联的 Changesets 列表,请求中对它们进行排序,并通过读取 DownloadUrl 获取与每个 Changeset 相关的二进制数据。根据本地 briefcase 最后一个下载的 Changeset,更新 Briefcase 客户端状态。

这个操作的目的是确保 Briefcase 被更新到最新的 Changeset,并确保 iModelHub 表示 Briefcase 已经从客户端下载并有关联的 Briefcase 与 Changeset。

总结

在本文中,我们仔细介绍了 @bentley/imodelhub-client 的使用方法和示例代码。你可以通过安装和引入这个 npm 包,实现与 iModelHub 的交互。这个教程提供的深度较高,可以让读者深入理解 @bentley/imodelhub-client 的使用方法,并可以根据实际情况更改示例代码。

来源:JavaScript中文网 ,转载请联系管理员! 本文地址:https://www.javascriptcn.com/post/5eedb05eb5cbfe1ea06110d0


猜你喜欢

  • GraphQL:用 Connection 优化节点查询

    前言 GraphQL 是一种由 Facebook 开发的数据查询和操作语言,它提供了一种更高效、更灵活的方式来获取和操作数据。GraphQL 的一个重要特性就是可以精确地指定需要查询的数据,避免了传统...

    2 个月前
  • Server-sent Events 的浏览器支持情况及解决方法

    什么是 Server-sent Events? Server-sent Events(简称 SSE)是一种基于 HTTP 的服务器推送技术,它可以让服务器向客户端发送事件流,客户端通过监听这个事件流来...

    2 个月前
  • ECMAScript 2020(ES11)中的新特性:BigInt 转换

    在 ECMAScript 2020(ES11)中,新增了一种数据类型:BigInt。它是一种可以表示任意大整数的数据类型,可以用来解决 JavaScript 中整数运算的精度问题。

    2 个月前
  • CSS Reset 在 IE6、IE7 等老浏览器中的应用

    什么是 CSS Reset CSS Reset 是一种通过重置浏览器默认样式的方式,消除不同浏览器之间的差异,从而实现更加一致的样式效果的技术手段。在前端开发中,使用 CSS Reset 可以让我们更...

    2 个月前
  • ES6 中的类继承和原型链之间的关系解析

    在 ES6 中,引入了 class 关键字,使得 JavaScript 也具备了面向对象编程的能力。在类继承和原型链之间,有着密切的关系。本文将详细解析 ES6 中的类继承和原型链之间的关系,并提供一...

    2 个月前
  • 如何使用 Redux 处理 React 应用中的表单数据

    前言 在开发 React 应用时,表单数据的处理是非常常见的需求。然而,由于 React 的单向数据流和组件化特性,传统的表单处理方式可能会变得非常繁琐。而 Redux 作为一种状态管理工具,可以帮助...

    2 个月前
  • Redis 处理高并发的策略

    前言 随着互联网的发展,高并发已经成为了一个不可避免的问题。而 Redis 作为一款高性能的 NoSQL 数据库,也成为了处理高并发的重要工具之一。本文将会介绍 Redis 处理高并发的策略,并且会提...

    2 个月前
  • 响应式设计中的图片适配问题解决方案

    在响应式设计中,图片适配是一个比较棘手的问题。如果不加以处理,可能会导致图片在不同设备上显示不佳,影响用户体验。本文将介绍响应式设计中的图片适配问题,并提供解决方案。

    2 个月前
  • 解析 TypeScript 中 encapsulation(封装)的实现方式

    解析 TypeScript 中 encapsulation(封装)的实现方式 在 TypeScript 中,封装(encapsulation)是一种重要的面向对象编程的特性。

    2 个月前
  • PM2 崩溃处理:如何避免由于 PM2 进程奔溃导致应用崩溃?

    在前端开发中,我们经常使用 PM2 进行进程管理和部署。但是,当 PM2 进程崩溃时,应用也会跟着崩溃。如何避免这种情况的发生?本文将介绍 PM2 崩溃处理的方法和技巧,帮助您更好地管理和部署应用。

    2 个月前
  • 在 Node.js 中运行 HTTPS 服务器的方法

    Node.js 是一个非常流行的 JavaScript 运行时环境,它可以让我们通过 JavaScript 编写服务器端应用程序。在开发 Web 应用程序时,安全性是非常重要的。

    2 个月前
  • 详解 ECMAScript 2018 中的三个新操作符及其用法

    ECMAScript 2018 (简称 ES2018) 是 JavaScript 语言的最新标准,其中包含了许多新特性和语法糖。本文将详细介绍其中的三个新操作符及其用法,分别是:扩展运算符、剩余运算符...

    2 个月前
  • 解决 Enzyme 测试 React Native 组件时动画无法渲染的问题

    在开发 React Native 应用时,我们经常需要使用 Enzyme 来测试组件。然而,当我们测试涉及到动画的组件时,我们可能会遇到一些问题:动画无法渲染,导致测试失败。

    2 个月前
  • 使用 React Router 打造复杂而强大的 SPA 应用

    随着 Web 技术的不断发展,单页应用(Single Page Application,SPA)已经成为了现代 Web 应用的主流。SPA 通过异步加载数据和动态更新页面,提供了更快速、更流畅的用户体...

    2 个月前
  • AngularJS 中如何使用 ng-repeat 中的 filter 来过滤数据

    在 AngularJS 中,ng-repeat 指令是用于循环遍历数组或对象并生成 HTML 元素的常用指令。而 ng-repeat 指令中的 filter 属性则是用于过滤数据的功能。

    2 个月前
  • 如何在 Chai 中验证 Promise.all

    如何在 Chai 中验证 Promise.all 在前端开发中,Promise.all 是一个非常常用的功能,它可以让我们在多个异步操作完成后再执行一些操作,这个功能在实际开发中非常实用。

    2 个月前
  • Mongoose 实现数据批量更新的方式详解

    前言 在前端开发中,经常会涉及到对数据库中的数据进行批量更新的操作。而 Mongoose 是一款 Node.js 平台下的 MongoDB 对象模型工具,它提供了一种方便的方式来操作 MongoDB ...

    2 个月前
  • 在使用 lit-element 的时候,如何解决麻烦的 Shadow DOM 的变量传递问题

    前言 在使用 Web Components 的时候,我们通常会使用 Shadow DOM 来实现封装和样式隔离。然而,Shadow DOM 的封闭性也带来了一些挑战,其中之一就是变量传递问题。

    2 个月前
  • Tailwind CSS 如何实现动态换肤?

    随着互联网的发展,越来越多的网站和应用开始支持动态换肤功能。动态换肤不仅可以提升用户体验,还可以让用户在不同的环境下选择适合自己的主题,增加用户黏性和满意度。本文将介绍如何使用 Tailwind CS...

    2 个月前
  • 如何在 Less 中使用字符串操作函数?

    在前端开发中,样式表是不可或缺的一部分。而 Less 是一种动态样式语言,它是 CSS 的一种扩展。在 Less 中,我们可以使用字符串操作函数来处理字符串,这些函数可以帮助我们更加方便地操作字符串,...

    2 个月前