Huly 平台 API 客户端
一个用于与Huly平台API互动的TypeScript客户端库.
安装
为了能够安装所需的软件包,您需要获得GitHub访问令牌. 您可以按照指示创建符号 这里。 。 。 .
npm install @hcengineering/api-client
WebSocket 客户端对 REST 客户端
Api客户端包提供两个主要客户端变体:一个WebSocket客户端和一个REST客户端. WebSocket客户端持有与Huly平台API的持续连接. REST客户端使用标准的HTTP请求来进行操作.
WebSocket 客户端
import { connect } from '@hcengineering/api-client'
// Connect to Huly
const client = await connect('https://huly.app', {
email: '[email protected]',
password: 'password',
workspace: 'my-workspace',
})
// Use the client to perform operations
...
// Close the client when done
await client.close()
REST 客户端
import { connectRest } from '@hcengineering/api-client'
// Connect to Huly
const client = await connectRest('https://huly.app', {
email: '[email protected]',
password: 'password',
workspace: 'my-workspace'
})
// Use the client to perform operations
...
认证
客户端支持两种认证方法:使用电子邮件和密码,或者使用符号. 认证后,客户端将可获得与用户相同的资源.
注:以下示例使用WebSocket客户端(
connect) (中文(简体) ). 要使用 REST 客户端, 导入和调用connectRest有相同的选择.
参数:
url: Huly 实例的 URL, 用于 Huly Cloudhttps://huly.appoptions连接选项workspace:要连接的工作空间名称,工作空间名称可见于工作空间的URL:https://huly.app/workbench/<workspace-name>token: 可选认证符email: 可选用户电子邮件password: 可选用户密码
使用电子邮件和密码
import { connect } from '@hcengineering/api-client'
const client = await connect('https://huly.app', {
email: '[email protected]',
password: 'password',
workspace: 'my-workspace'
})
...
await client.close()
使用托肯语
import { connect } from '@hcengineering/api-client'
const client = await connect('https://huly.app', {
token: '...',
workspace: 'my-workspace'
})
...
await client.close()
客户端 API
客户端提供了一套与Huly平台API互动的方法. 本节介绍客户端可用的主要方法.
获取 API
客户端提供了检索文件的两种主要方法: findOne 财务报告和审定财务报表 findAll。 。 。 .
找到一个
获取符合查询标准的单一文档.
参数:
_class: 要查找的对象的分类, 结果将包含目标类的所有子分类query: 查询标准options: 查找选项limit: 限制返回结果的数量sort: 排序标准lookup: 查询标准projection: 预测标准total: 如果返回指定总数
示例
import contact from '@hcengineering/contact'
...
const person = await client.findOne(
contact.class.Person,
{
_id: 'person-id'
}
)
查找全部
获取符合查询标准的多文档.
参数:
_class: 要查找的对象的分类, 结果将包含目标类的所有子分类query: 查询标准options: 查找选项limit: 限制返回结果的数量sort: 排序标准lookup: 查询标准projection: 预测标准total: 如果返回指定总数
示例
import { SortingOrder } from '@hcengineering/core'
import contact from '@hcengineering/contact'
..
const persons = await client.findAll(
contact.class.Person,
{
city: 'New York'
},
{
limit: 10,
sort: {
name: SortingOrder.Ascending
}
}
)
API 文档
客户端提供三种管理文件的主要方法: createDoc, (中文(简体) ), updateDoc,以及 removeDoc。这些方法允许您在文档上执行 CRUD 操作.
创建文件
在指定空间创建新文档.
参数:
_class: 对象的类别space: 物体的空间attributes: 对象的属性id: 对象的可选标识, 如果不提供, 将生成新的标识
示例
import contact, { AvatarType } from '@hcengineering/contact'
..
const personId = await client.createDoc(
contact.class.Person,
contact.space.Contacts,
{
name: 'Doe,John',
city: 'New York',
avatarType: AvatarType.COLOR
}
)
更新文件
更新现有文档.
参数:
_class: 对象的类别space: 物体的空间objectId: 对象编号operations: 要更新的对象属性
示例
import contact from '@hcengineering/contact'
..
await client.updateDoc(
contact.class.Person,
contact.space.Contacts,
personId,
{
city: 'New York',
}
)
删除文件
删除已存在的文档.
参数:
_class: 对象的类别space: 物体的空间objectId: 对象编号
示例
import contact from '@hcengineering/contact'
..
await client.removeDoc(
contact.class.Person,
contact.space.Contacts,
personId
)
收藏 API
添加缩放
在指定的收藏中创建新的附加文档.
参数:
_class: 要创建的对象的类别space: 创建对象的空间attachedTo: 附加到attachedToClass: 附加到collection: 载有所附文件的集合名称attributes: 对象的属性id: 对象的可选标识, 如果不提供, 将生成新的标识
示例
import contact, { AvatarType } from '@hcengineering/contact'
..
const personId = await client.createDoc(
contact.class.Person,
contact.space.Contacts,
{
name: 'Doe,John',
city: 'New York',
avatarType: AvatarType.COLOR
}
)
await client.addCollection(
contact.class.Channel,
contact.space.Contacts,
personId,
contact.class.Person,
'channels',
{
provider: contact.channelProvider.Email,
value: '[email protected]'
}
)
更新
更新收藏中现有的附件文档.
参数:
_class: 要更新的对象的分类space: 需更新的天体空间objectId: 需更新的天体空间attachedTo: 父对象的IDattachedToClass: 母对象的类collection: 载有所附文件的集合名称attributes: 要更新的对象属性
示例
import contact from '@hcengineering/contact'
..
await client.updateCollection(
contact.class.Channel,
contact.space.Contacts,
channelId,
personId,
contact.class.Person,
'channels',
{
city: 'New York',
}
)
删除收集
从收藏中删除已存在的附件文档.
参数:
_class: 要删除的对象的类别space: 删除对象的空间objectId: 删除对象的空间attachedTo: 父对象的IDattachedToClass: 母对象的类collection: 载有所附文件的集合名称
示例
import contact from '@hcengineering/contact'
..
await client.removeCollection(
contact.class.Channel,
contact.space.Contacts,
channelId,
personId,
contact.class.Person,
'channels'
)
混合 API
客户端提供两种管理混音的方法: createMixin 财务报告和审定财务报表 updateMixin。 。 。 .
创建密克辛
为指定的文档创建新组合.
参数:
objectId: 混合体附着于objectClass: 组合符所附加的对象的类别objectSpace: 混合体附着在物体上的空间mixin: 要更新的混音类型代码attributes: 混音的属性
import contact, { AvatarType } from '@hcengineering/contact'
..
const personId = await client.createDoc(
contact.class.Person,
contact.space.Contacts,
{
name: 'Doe,John',
city: 'New York',
avatarType: AvatarType.COLOR
}
)
await client.createMixin(
personId,
contact.class.Person,
contact.space.Contacts,
contact.mixin.Employee,
{
active: true,
position: 'CEO'
}
)
更新密克辛
更新已有的混音符.
参数:
objectId: 混合体附着于objectClass: 组合符所附加的对象的类别objectSpace: 混合体附着在物体上的空间mixin: 要更新的混音类型代码attributes: 组合的属性以更新
import contact, { AvatarType } from '@hcengineering/contact'
..
const person = await client.findOne(
contact.class.Person,
{
_id: 'person-id'
}
)
await client.updateMixin(
personId,
contact.class.Person,
contact.space.Contacts,
contact.mixin.Employee,
{
active: false
}
)