几内亚
我不是一个图书馆来简化与GudHub API的工作. 此外,该图书馆还设有各种设施,以便更好地与下列机构一起运作: items, (中文(简体) ), fields 财务报告和审定财务报表 apps来啊!
npm 软件包
软件包名称是 @gudhub/core这是一个私人包裹,所以 .npmrc 文件必须在根文件夹中才能从中加载 无。这意味着,如果你有 @gudhub/core 包裹中。 json 用于 GudHubClient,则 .npmrc 文件也应在根文件夹中.
发布 gudhub lib 到 npm
为了发布新版"GudHub Lib",您必须:
- 更改版本
package.json - 将您的更改提交到仓库
master分支 - 运行
npm publish命令,将发布新版本到 无
发展
如果你想开发 GudHub 图书馆 在另一种环境中,如: 宽度,您需要做到以下几点:
- 你应该去
gudhub文件夹并运行到那里npm init @gudhub/core命令,它将安装 @ gudhub/ 核心 将软件包输入您的全球环境 - 那你得再加一点
@gudhub/core给您的package.json作为依赖. - 运行后, 软件包将从本地计算机下载
npm run dev或者说npm install命令
初始化
有几种方法可以初始化古德Hub. 最简单的方法就是将gudhub初始化,没有争论. 在这种情况下,只有提款机可以使用.
import {GudHub} from '@gudhub/core';
const gudhub = new GudHub();
第二种方式是将GudHub以授权密钥初始化. 这是你项目中最常用的GudHub方法. 你只需要通过 auth_key 作为争论.
在此情况下,您将能够与 GudHub 数据合作,并使用以下所列的所有方法.
import {GudHub} from '@gudhub/core';
const auth_key = 'JLKHKJSKJhkjsclkdjcijIOIoiuSTg';
const gudhub = new GudHub(auth_key);
第三种方法是以附加参数来初始化GudHub. 用于开发在Node.js上的服务器应用,并用于本地服务器的测试. 在下面的例子中,可以看到如何初始化 GudHub(在例子中可以看到默认的参数).
import {GudHub} from '@gudhub/core';
const auth_key = 'JLKHKJSKJhkjsclkdjcijIOIoiuSTg';
const gudhub = new GudHub(auth_key,{
server_url : "https://app.gudhub.com/GudHub",
wss_url : "wss://app.gudhub.com/GudHub/ws/app/",
initWebsocket : false
});
| 参数名称 | 说明 | 默认值 |
|---|---|---|
| 服务器url | 所有请求都会发送到这个 URL | https://app.gudhub.com/ GudHub 页面存档备份,存于互联网档案馆 |
| 无效 | url 设置网络连接 | wss://app.gudhub.com/ GudHub/ws/app/ (中文(简体) ) |
| 输入Websocket | 在这里,我们可以关闭 websoket 连接 | 虚假 |
用户
json 构造器( )
通过这种方法,您可以按照计划获得json.
gudhub.jsonConstructor(scheme, item, variables)
更多信息,请访问 json 在 GudHub 上的构造器。 。 。 .
json to 项目( )
这种方法将 json 转换为 gudhub 项 。 转换基于 fieldMap。在生成项目后,您可以发送项目创建新项目.
gudhub.jsonToItems(json, fieldsMap);
更多信息,请访问 json 在 GudHub 上的构造器。 。 。 .
使用项目参考文献居中
这种方法用源项的项目来更新目的项。 使用 src FieldIdToCompare 和 destFeldIdToCompare 来检查 sorce Projects Ref 和 src FeldId ToCompare 之间的连接 。 检测到连接后, 将项目 ref 保存到 dest FieldFor Ref .
gudhub.populateWithItemRef(sorceItemsRef, srcFieldIdToCompare, destinationItems, destFieldIdToCompare, destFieldForRef, APPID)
更多信息,请访问 gudHub 的项目参考文献。 。 。 .
合并项目( )
当前的方法将所有字段替换为目标值 项目按价值分列 如果目的项目没有吸附项目所在的字段,它们将在目的项目中被创建.
gudhub.mergeItems(sorceItems, destinationItems, mergeByFieldId);
更多信息,请访问 合并 GudHub 上的项目。 。 。 .
项目比较( )
这种方法将吸附项目领域与目的地领域进行比较。 这意味着,如果 sorce 项目具有与目的相同值的字段,则项目将被描述为"同 项",即使目的 项目有附加字段,但项目没有.
gudhub.compareItems(sorceItems, destinationItems, fieldToCompare);
更多信息,请访问 比较 GudHub 上的项目。 。 。 .
获取日期( C)
此方法将根据指定的命名空间返回日期 。 名称空格应采用字符串格式
gudhub.getDate(date_type);
更多信息,请访问 在 GudHub 上获得约会。 。 。 .
makeNestedList () (中文(简体) )
这种方法创造了无穷之巢的田地列表. 它需要一系列的字段,取决于它们的ID为每个字段制作附件.
gudhub.makeNestedList(arr, 'id', 'parent_id', 'children_property', 'priority')
更多信息,请访问 在 GudHub 上制作监视列表。 。 。 .
App 处理器
获取 AppInfo ()
这是空数组返回应用程序的方法 : field_list, (中文(简体) ), items_list, (中文(简体) ), file_list, (中文(简体) ), views_list。需要这样的简单数据来渲染 App 图标,并在 App 中做一些简单的更新,比如: 当不需要完整 app 数据时, 更新 App 名称图标权限等
gudhub.getAppInfo(app_id);
更多信息,请访问 获取 GudHub 上的 AppInfo。 。 。 .
获取 App ()
这种方法是用来通过指定其ID作为参数的应用程序.
gudhub.getApp(app_id);
更多信息,请访问 在 GudHub 上获取 App。 。 。 .
获取 AppsList ()
这种方法在登录后被调用以获取用户应用程序列表. 它没有争论. 获取App列表 返回用户共享的应用程序列表.
gudhub.getAppsList();
更多信息,请访问 在 GudHub 上获取 App。 。 。 .
认证
登录( c)
这种方法用于访问账户。 它可以用登录和密码或认证密钥调用,无论是否附加参数.
gudhub.login(data);
更多信息,请访问 登录 GudHub。 。 。 .
登录( c)
当用户从账户中日志出时使用这种方法.
gudhub.logout(token);
更多信息,请访问 在 GudHub 上登录。 。 。 .
注册( )
这种方法用于在GudHub中注册一个用户账户.
gudhub.signup(user);
更多信息,请访问 在 GudHub 注册。 。 。 .
获取用户ById ()
这种方法让用户从用户列表中可以访问应用程序.
gudhub.getUserById(userId);
更多信息,请访问 在 GudHub 上获取用户符号。 。 。 .
获取用户列表 ()
这种方法在搜索过程中被叫作用户共享. 即当您在搜索框中输入关键词时, GudHub 将显示所有名字与该词相匹配的用户.
gudhub.getUsersList(keyword);
更多信息,请访问 在 GudHub 上获取用户列表。 。 。 .
获取用户工作空间( )
这种方法用于获取属于当前用户工作空间的用户列表. 返回的用户被缓存在存储中.
gudhub.getUserWorkspace();
更多信息,请访问 获取 GudHub 上的用户工作空间。 。 。 .
更新用户( )
这是用于更新用户账户数据的方法.
gudhub.updateUser(userData);
更多信息,请访问 更新 GudHub 上的用户。 。 。 .
获取Token ()
这种方法用于获取当前符号.
gudhub.getToken();
更多信息,请访问 获取 GudHub 上的数据。 。 。 .
更新Token ()
这种方法在更新符号时称为.
gudhub.updateToken(auth_key)
更多信息,请访问 关于 GudHub 的更新。 。 。 .
更新Avatar( )
当用户更改其账户相片时使用这种方法.
gudhub.updateAvatar(imageData);
更多信息,请访问 在 GudHub 上更新Avatar。 。 。 .
获取 Storage () 用户
这种方法用于在共享过程中从用户列表中获取所需的用户.
gudhub.getUserFromStorage(id);
更多信息,请访问 gudHub 上的用户。 。 。 .
保存用户TOStorage ()
这种方法允许您在用户列表中添加新的用户.
gudhub.saveUserToStorage(saveUser);
更多信息,请访问 在 GudHub 上保存用户tostrage。 。 。 .
获取Version ()
使用这种方法来查找当前版本的"古德Hub".
gudhub.getVersion();
更多信息,请访问 获取 GudHub 上的版本。 。 。 .
项目处理器
获取项目( )
这种方法用于获取当前应用程序的项目.
await gudhub.getItems(app_id, trash);
更多信息,请访问 获取 GudHub 上的项目。 。 。 .
添加新项目( )
使用此方法在项目列表中添加新项目 .
await gudhub.addNewItems(app_id, itemsList);
更多信息,请访问 添加关于 GudHub 的新项目。 。 。 .
更新项目( )
这种方法用于更新某些项目.
await gudhub.updateItems(app_id, itemsList);
更多信息,请访问 更新 GudHub 的项目。 。 。 .
删除项目( )
由于此方法, 您可以从您的应用程序中删除一个或多个项目 .
await gudhub.deleteItems(app_id, itemsIds);
更多信息,请访问 删除 GudHub 上的项目。 。 。 .
字段处理器
获取字段( )
由于这种方法,您可以从相关应用程序中获取字段.
await gudhub.getField(app_id, field_id);
更多信息,请访问 获取 GudHub 上的字段。 。 。 .
更新字段( )
这种方法允许您更新当前应用程序的字段模型.
await gudhub.updateField(app_id, fieldModel);
更多信息,请访问 更新 GudHub 上的字段。 。 。 .
删除字段( )
该方法用于从应用程序中删除字段.
await gudhub.deleteField(app_id, field_id);
更多信息,请访问 删除 GudHub 上的字段。 。 。 .
获取 FieldModels ()
这种方法用于获取一个字段模型列表.
await gudhub.getFieldModels(app_id);
更多信息,请访问 获取 GudHub 上的 FieldModels。 。 。 .
获取 FieldValue ()
这种方法负责从所期望的领域获得价值.
await gudhub.getFieldValue(app_id, item_id, field_id);
更多信息,请访问 获取 GudHub 上的 FieldValue 值。 。 。 .
设置 FieldValue ()
这种方法被叫作在所期望的领域中设定值.
await gudhub.setFieldValue(app_id, item_id, field_id, field_value);
更多信息,请访问 设置 GudHub 上的字段值。 。 。 .
文件处理器
获取文件( )
这种方法被称为从应用程序获取文件.
gudhub.getFile(app_id, file_id);
更多信息,请访问 在 GudHub 上获取文件。 。 。 .
获取Files( )
这种方法要求从当前应用程序中获取文件列表.
gudhub.getFiles(app_id, filesId);
更多信息,请访问 在 GudHub 上获取文件。 。 。 .
上传文件 ()
目前的方法允许上传文件. 它通过表格传输文件.
await gudhub.uploadFile(fileData, app_id, file_id)
更多信息,请访问 上传 GudHub 上的文件。 。 。 .
上传 FileFromString ()
这是允许将不同文件以 Base64 格式上传到应用程序的方法.
await gudhub.uploadFileFromString(fileObject);
更多信息,请访问 上传 GudHub 上的 FileFrom String。 。 。 .
是 FileExists () (中文(简体) )
由于此方法, 您可以检查此应用程序中是否有以下 ID 文件 .
await gudhub.isFileExists(app_id, file_id)
更多信息,请访问 在 GudHub 上为 FileExists。 。 。 .
更新 FileFromString ()
当前的方法允许更新某些文件的数据和名称.
await gudhub.updateFileFromString(data, file_id, file_name, extension, format)
更多信息,请访问 更新 GudHub 上的 FileFromString 格式。 。 。 .
复制文件( )
这种方法用于创建文件的复制.
await gudhub.duplicateFile(files)
更多信息,请访问 gudHub 上的复制文件。 。 。 .
下载 FileFromString ()
使用这种方法从文件列表中下载文件 .
await gudhub.downloadFileFromString(app_id,file_id)
更多信息,请访问 下载 GudHub 上的 FileFromString。 。 。 .
删除文件( )
由于这种方法文件可以从应用程序中删除.
gudhub.deleteFile(app_id, file_id);
更多信息,请访问 删除 GudHub 上的文件。 。 。 .
文档处理器
创建文档 ()
这种方法要求在某些应用程序中创建一个新文档.
gudhub.createDocument(documentObject);
更多信息,请访问 在 GudHub 上创建文档。 。 。 .
获取文档( )
从应用程序文档列表中获取所需文档的方法 .
gudhub.getDocument(documentAddress);
更多信息,请访问 获取 GudHub 上的文档。 。 。 .
获取文档( )
这种方法是用来从应用程序中获取一系列文档的.
gudhub.getDocuments(documentsAddresses);
更多信息,请访问 获取 GudHub 上的文档。 。 。 .
删除文档( )
由于此方法, 您可以从应用程序中删除文档 .
gudhub.deleteDocumentApi(documentAddress);
更多信息,请访问 删除 GudHub 上的文档。 。 。 .
管道服务
日期( )
这是要求订阅的方法.
gudhub.on(event, address, myFunction);
更多信息,请访问 在GudHub上进行。 。 。 .
发射( )
这是GudHub本身使用的方法. 这需要获得现有的订阅.
gudhub.on(event, address, myFunction);
更多信息,请访问 在 GudHub 上释放。 。 。 .
销毁()
这种方法用于破坏额外的订阅和优化进程.
gudhub.destroy('gh_app_views_update', address, myFunction);
更多信息,请访问 在 GudHub 上销毁。 。 。 .
