跳到主要内容

SDK (javascript)

概述​

Labii JavaScript SDK 是一个软件开发工具包(SDK),为使用 Labii 平台开发 Web 应用程序提供一组工具和库。Labii 平台是一个云平台,研究人员可用它管理研究数据和工作流程,包括数据收集、存储、分析和共享。

Labii JavaScript SDK 允许开发者将 Labii 的特性和功能集成到 Web 应用程序中。它包含多种 API,可供开发者访问和操作 Labii 平台中存储的数据,例如数据录入表单、工作空间管理工具和报告功能。

该 SDK 包含一个 JavaScript 库,为与 Labii API 交互提供高级接口。它还提供一系列文档和示例,帮助开发者开始使用 SDK 并将其集成到应用程序中。

安装​

要在 JavaScript 工作空间中使用 Labii SDK,可以通过 npm 安装。在终端中运行以下命令(即将推出):

npm install labii-sdk

快速入门​

以下是 Labii SDK 的快速入门说明:

  1. 导入 Labii SDK:安装 Labii SDK 后,可以使用以下语法将其导入 JavaScript 代码:
    import Labii from 'labii-sdk';
  2. 列出行:要列出 Labii 工作空间中的行,可以使用 Row 对象的 list() 方法。list() 方法接受一个配置对象作为参数,该对象指定查询的各种选项。
Labii.Row.list({
serializer: 'name',
query: `table__sid=${table.sid.get()}`,
callback_success: (response)=>{
// code for success
},
callback_fail: (err)=>{
// code for fail
}
})

语法​

Labii SDK 语法遵循 Labii.[Object].[method](/api/sdk/{props}) 模式。

Labii​

这是 Labii SDK 的主对象。通过它可以访问 SDK 中的所有其他对象和方法。

对象​

对象是指 Labii SDK 中可用的对象之一,例如 Workspace、Table 或 Row。每个对象代表 Labii 平台中的一种实体类型,并提供一组与该实体交互的方法。

有关 Labii 对象列表,请参阅对象。

方法​

方法是可对 Labii 平台中的对象执行的函数或操作。Labii SDK 中的每个对象都有自己的一组方法,可用于执行各种操作,例如创建新工作空间、添加新实验或列出数据行。

  1. list():此方法用于从 Labii 平台检索实体列表,例如工作空间、实验或行。该方法接受一个配置对象作为参数,可用来指定列表的筛选、排序和分页选项。请求成功时,该方法返回一个解析为实体列表的 Promise。
  2. create():此方法用于在 Labii 平台中创建新实体,例如新工作空间、实验或行。该方法接受一个配置对象作为参数,其中应包含要创建的新实体的属性。请求成功时,该方法返回一个解析为新建实体的 Promise。
  3. retrieve():此方法根据 ID 或其他标识信息从 Labii 平台检索单个实体。该方法接受一个配置对象作为参数,其中应包含要检索实体的 ID 或其他标识信息。请求成功时,该方法返回一个解析为所检索实体的 Promise。
  4. modify():此方法根据 ID 或其他标识信息修改 Labii 平台中的现有实体。该方法接受一个配置对象作为参数,其中应包含要修改的实体属性。请求成功时,该方法返回一个解析为修改后实体的 Promise。
  5. delete():此方法根据 ID 或其他标识信息删除 Labii 平台中的现有实体。该方法接受一个配置对象作为参数,其中应包含要删除实体的 ID 或其他标识信息。请求成功时,该方法返回一个解析为已删除实体的 Promise。
  6. bulk_create():此方法仅适用于 Row。它可以在一次请求中创建同一表格的最多 50 行,比逐行调用 create() 快得多。每行会独立保存,因此一行无效不会阻止其他行创建。

Props​

Props 是调用方法时可以传入的属性或选项。它们用于配置方法的行为,或向 Labii 平台提供其他信息。例如,调用 Workspace.create() 方法时,可以传入工作空间名称、描述和所有者等 props。

list​

  • 列表 URL props:
    • level(str,可选,默认为 organization)。详情请参阅此处。
    • sid(str,可选,默认为 organization.sid)
    • serializer(str,可选,默认为 detail)。详情请参阅此处。
    • query(str,可选)
  • callback_success(func,可选)。此 prop 指定请求成功时调用的回调函数。该函数接收响应数据作为参数
  • callback_fail(func,可选)。此选项指定请求失败时调用的回调函数。该函数接收错误对象作为参数

create​

  • 列表 URL props:
    • level(str,可选,默认为 organization)。详情请参阅此处。
    • sid(str,可选,默认为 organization.sid)
    • serializer(str,可选,默认为 detail)。详情请参阅此处。
    • query(str,可选)
  • callback_success(func,可选)。此 prop 指定请求成功时调用的回调函数。该函数接收响应数据作为参数
  • callback_fail(func,可选)。此选项指定请求失败时调用的回调函数。该函数接收错误对象作为参数

bulk_create​

仅适用于 Row。

  • data(object,必填)。格式为 {rows: [...]},其中每一行的数据格式与传递给 create() 的数据相同。每次请求最多 50 行;更大的导入任务需要拆分为多个批次。
  • 列表 URL props:
    • level(str,可选,默认为 organization)。详情请参阅此处。
    • sid(str,可选,默认为 organization.sid)
    • query(str,必填)。必须包含 table__sid。支持与 create() 相同的选项,例如使用 unique_indentifier=uid 更新现有行,而不是创建新行。
  • callback_success(func,可选)。此 prop 指定请求成功时调用的回调函数。响应数据为 {results: [...]},按 rows 中的相同顺序为每行返回一项:
    • 行保存成功时返回 {index, sid, name}
    • 行被拒绝时返回 {index, error},例如缺少权限或值无效
  • callback_fail(func,可选)。此选项指定整个请求失败时调用的回调函数,例如行数超过 50,或您无权访问该公司。在这种情况下,不会保存任何行。
Labii.Row.bulk_create({
query: `table__sid=${table.sid}`,
data: {rows: [
{name: "Sample 1", workspaces: [{sid: workspace.sid}]},
{name: "Sample 2", workspaces: [{sid: workspace.sid}]},
]},
callback_success: (response)=>{
response.data.results.forEach((result)=>{
if (result.error){
console.log(`Row ${result.index + 1} failed: ${result.error}`);
}
})
},
callback_fail: (err)=>{
// code for fail
}
})

retrieve​

  • 列表 URL props:
    • sid(str,必填)。
    • query(str,可选)
  • callback_success(func,可选)。此 prop 指定请求成功时调用的回调函数。该函数接收响应数据作为参数
  • callback_fail(func,可选)。此选项指定请求失败时调用的回调函数。该函数接收错误对象作为参数

modify​

  • 列表 URL props:
    • sid(str,必填)。
    • query(str,可选)
  • callback_success(func,可选)。此 prop 指定请求成功时调用的回调函数。该函数接收响应数据作为参数
  • callback_fail(func,可选)。此选项指定请求失败时调用的回调函数。该函数接收错误对象作为参数

delete​

  • 列表 URL props:
    • sid(str,必填)。
    • query(str,可选)
  • callback_success(func,可选)。此 prop 指定请求成功时调用的回调函数。该函数接收响应数据作为参数
  • callback_fail(func,可选)。此选项指定请求失败时调用的回调函数。该函数接收错误对象作为参数

示例​