Blocklet 服务

BlockletService 是一个功能强大的客户端，作为您的 blocklet 与底层 ABT Node 服务交互的主要接口。它将复杂的 GraphQL 查询和 HTTP 请求封装成一个简洁的、基于 promise 的 JavaScript API，从而简化了用户管理、会话处理、基于角色的访问控制 (RBAC) 和检索 blocklet 元数据等任务。

该服务对于构建利用 Blocklet 平台全部功能的、安全且功能丰富的应用程序至关重要。在深入了解此服务之前，建议先理解我们的身份验证指南中涵盖的概念。

工作原理#

您应用程序中的 BlockletService 客户端与在 ABT Node 上运行的 blocklet-service 进行通信。所有请求都使用 blocklet 的凭据自动进行身份验证，以确保对核心功能的安全访问。

开始使用#

要使用该服务，只需导入并实例化它即可。客户端将根据 Blocklet Server 提供的环境变量自动配置。

import BlockletService from '@blocklet/sdk/service/blocklet';

const client = new BlockletService();

async function main() {
  const { user } = await client.getOwner();
  console.log('Blocklet 所有者:', user.fullName);
}

main();

会话管理#

login#

验证用户身份并发起一个会话。

参数

返回

refreshSession#

使用刷新令牌刷新已过期的会话。

参数

返回

switchProfile#

更新用户的个人资料信息。

参数

返回

用户管理#

getUser#

通过用户的 DID 检索单个用户的个人资料。

参数

返回

getUsers#

检索分页的用户列表，支持筛选和排序。

参数

返回

getUsersCount#

获取用户总数。

返回

getUsersCountPerRole#

获取每个角色的用户数。

返回

getOwner#

检索 blocklet 所有者的个人资料。

返回

updateUserApproval#

批准或撤销用户对 blocklet 的访问权限。

参数

返回

updateUserTags#

更新与用户关联的标签。

参数

返回

updateUserExtra#

更新用户的额外元数据。

参数

返回

updateUserInfo#

更新用户的一般信息。需要有效的用户会话 cookie。

参数

返回

updateUserAddress#

更新用户的物理地址。需要有效的用户会话 cookie。

参数

返回

用户会话#

getUserSessions#

检索用户的活动会话列表。

参数

返回

getUserSessionsCount#

获取用户会话的总数，支持可选筛选。

参数

返回

社交与社区#

getUserFollowers#

检索关注特定用户的用户列表。需要有效的用户会话 cookie。

参数

返回

getUserFollowing#

检索特定用户正在关注的用户列表。需要有效的用户会话 cookie。

参数

返回

getUserFollowStats#

获取用户的关注者和正在关注的数量。需要有效的用户会话 cookie。

参数

返回

checkFollowing#

检查一个用户是否正在关注一个或多个其他用户。

参数

返回

followUser#

使一个用户关注另一个用户。

参数

返回

unfollowUser#

使一个用户取消关注另一个用户。

参数

返回

getUserInvites#

检索由特定用户邀请的用户列表。需要有效的用户会话 cookie。

参数

返回

标签管理#

getTags#

检索所有可用的用户标签列表。

参数

返回

createTag#

创建一个新的用户标签。

参数

返回

updateTag#

更新一个已有的用户标签。

参数

返回

deleteTag#

删除一个用户标签。

参数

返回

基于角色的访问控制 (RBAC)#

getRoles#

检索所有可用角色的列表。

返回

getRole#

通过名称检索单个角色。

参数

返回

createRole#

创建一个新角色。

参数

返回

updateRole#

更新一个已有的角色。

参数

返回

deleteRole#

删除一个角色。

参数

返回

getPermissions#

检索所有可用权限的列表。

返回

getPermissionsByRole#

检索授予特定角色的所有权限。

参数

返回

createPermission#

创建一个新权限。

参数

返回

updatePermission#

更新一个已有的权限。

参数

返回

deletePermission#

删除一个权限。

参数

返回

grantPermissionForRole#

为角色分配一个权限。

参数

返回

revokePermissionFromRole#

从角色中撤销一个权限。

参数

返回

updatePermissionsForRole#

用一组新的权限替换角色的所有现有权限。

参数

返回

hasPermission#

检查角色是否具有特定权限。

参数

返回

通行证管理#

issuePassportToUser#

向用户颁发一个新的通行证，并为其分配一个角色。

参数

返回

enableUserPassport#

为用户启用先前已撤销的通行证。

参数

返回

revokeUserPassport#

撤销用户的通行证。

参数

返回

removeUserPassport#

永久移除用户的通行证。

参数

返回

Blocklet 与组件信息#

getBlocklet#

检索当前 blocklet 的元数据和状态。

参数

返回

getComponent#

通过其 DID 检索当前 blocklet 中特定组件的状态。

参数

返回

getTrustedDomains#

检索用于联合登录的受信任域列表。

返回

getVault#

检索并验证 blocklet 的保险库信息。

返回

clearCache#

根据模式清除节点上的缓存数据。

参数

返回

访问密钥管理#

createAccessKey#

为程序化访问创建一个新的访问密钥。

参数

返回

getAccessKey#

检索单个访问密钥的详细信息。

参数

返回

getAccessKeys#

检索访问密钥列表。

参数

返回

verifyAccessKey#

验证访问密钥是否有效。

参数

返回

掌握 BlockletService 后，您可能想探索如何向用户发送消息。请前往通知服务指南了解更多信息。