# @atlaskit/editor-plugin-engagement-platform 中文文档

规范地址：https://npmcn.com/package/%40atlaskit/editor-plugin-engagement-platform/

版本：31\.0\.0
npm 元数据更新时间：2026-10-27T02:04:38.245Z
中文译文更新时间：2026-11-07T03:02:46.462Z
软件包许可：Apache-2\.0

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40atlaskit/editor-plugin-engagement-platform
原文对照：https://npmcn.com/package/%40atlaskit/editor-plugin-engagement-platform/?lang=original
项目主页：https://bitbucket.org/atlassian/atlassian-frontend-monorepo#readme
源码仓库：https://bitbucket.org/atlassian/atlassian-frontend-monorepo

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：68.1 kB，47 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：3 个
- peer 依赖：react ^18\.2\.0 \|\| ^19\.2\.0，react-dom ^18\.2\.0 \|\| ^19\.2\.0，@atlaskit/editor-common ^134\.0\.0
- 首次发布：2024-10-08T09:15:47.653Z
- 最新版本发布：2026-10-27T02:04:37.798Z
- 近 30 天下载量：24742（2026-10-07 至 2026-11-05，npm 官方下载统计）
- 已发布版本数：57（近 12 个月 29 个）

## 中文简介

@atlaskit/editor-core 的参与平台插件

## 安装

```sh
npm install @atlaskit/editor-plugin-engagement-platform
```

也可以使用：`pnpm add @atlaskit/editor-plugin-engagement-platform`、`yarn add @atlaskit/editor-plugin-engagement-platform`、`bun add @atlaskit/editor-plugin-engagement-platform`

## README

# 编辑插件参与平台

@atlaskit/editor-core 的参与平台插件

**说明:** 这一构成部分是为阿特拉斯系统内部开发而设计的. 外部捐助者将能够使用这一构成部分,但无法提交问题.

## 概览

参与平台插件在编辑器内提供与Atlassian参与平台的集成. 它通过允许您开始和停止接触消息来控制外部消息,以及检查这些消息的状态. 插件需要协调客户端来管理消息的生命周期和状态.

## 主要特点

-   **开始消息** - 启动带有特定ID和可选变异ID的约定信息
-   **停止信件** - 停止带有特定身份的订婚信息
-   **信件状态跟踪** - 检查接触信息的有效状态
-   **基于承诺的API** - 通过综合承诺管理防止重复请求
-   **协调客户整合** - 与参与平台协调客户合作

## 安装

* * *

-   **安装** - 说吧 _线条 添加 @ atlaskit/ editor- plugin- engagement- 平台_
-   **无** - 说吧 [@atlaskit/editor-plugin-engagement-平台](https://www.npmjs.com/package/@atlaskit/editor-plugin-engagement-platform)
-   **来源** - 说吧 [键盘](https://bitbucket.org/atlassian/atlassian-frontend/src/master/packages/editor/editor-plugin-engagement-platform)
-   **套装** - 说吧 [unpkg.com (英语)](https://unpkg.com/@atlaskit/editor-plugin-engagement-platform/dist/)

## 使用量

* * *

**仅内部使用**

@atlaskit/editor-plugin-greatment-platform 供@atlaskit/editor-core内部使用,并作为您产品中编辑器的插件依赖.

不支持直接使用此组件.

### 基本设置

要使用插件,请导入并包含在编辑器设置中 :

```typescript
import { engagementPlatformPlugin } from '@atlaskit/editor-plugin-engagement-platform';

const coordinationClient = useCoordinationClient()

const { preset, editorApi } = usePreset(() => {
    return universalPreset.add([
        engagementPlatformPlugin,
        { coordinationClient },
    ]);
}, [universalPreset, coordinationClient]);
```

### 正在检查信件状态

要获得一个任务消息的当前状态,您可以使用以下代码:

```typescript
function isMessageActive(messageId: string): boolean {
    const messageStates = api.engagementPlatform.sharedState.currentState()?.messageStates ?? {};
    return !!messageStates[messageId];
}
```

### 插件配置

插件需要一个配置对象,其结构如下:

```typescript
interface EngagementPlatformPluginOptions {
    coordinationClient: CoordinationClientType;
}
```

### API 密码

#### `api.engagementPlatform.actions.startMessage(messageId: string, variationId?: string): Promise<boolean>`

以给定的ID和可选变异 ID 启动任务信息 .

**警告:** 你必须打电话 `stopMessage` 当您的消息显示完毕时。 如果你不打电话 `stopMessage`,您的消息会阻止用户看到任何其他消息,直到消息的过期时间到达.

#### `api.engagementPlatform.actions.stopMessage(messageId: string): Promise<boolean>`

停止与给定的ID连接消息 .

请看 [Atlaskit - 编辑器参与平台插件](https://atlaskit.atlassian.com/packages/editor/editor-plugin-engagement-platform) 用于此软件包的文档和示例.

## 支助

* * *

对于内部阿特拉斯人, 访问懒惰的通道 [\# 帮助编辑器 #](https://atlassian.slack.com/archives/CFG3PSQ9E) 支助或访问 [去/编辑-帮助](https://go/editor-help) 以提交错误.

## 许可证

* * *

请看 [阿特拉斯前端 - 许可证](https://hello.atlassian.net/wiki/spaces/AF/pages/2589099144/Documentation#License) 获取更多的许可证信息.

## 常见问题

### @atlaskit/editor-plugin-engagement-platform 是什么？

@atlaskit/editor-core 的参与平台插件

### 如何安装 @atlaskit/editor-plugin-engagement-platform？

在项目目录运行 npm install @atlaskit/editor-plugin-engagement-platform，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：react（^18\.2\.0 \|\| ^19\.2\.0）、react-dom（^18\.2\.0 \|\| ^19\.2\.0）、@atlaskit/editor-common（^134\.0\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @atlaskit/editor-plugin-engagement-platform 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @atlaskit/editor-plugin-engagement-platform 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @atlaskit/editor-plugin-engagement-platform 可以商用吗？

@atlaskit/editor-plugin-engagement-platform 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @atlaskit/editor-plugin-engagement-platform 的下载量有多少？

根据 npm 官方下载统计，@atlaskit/editor-plugin-engagement-platform 在 2026/10/07 – 2026/11/05 这 30 天内被下载 24,742 次，日均约 825 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @atlaskit/editor-plugin-engagement-platform 还在维护吗？

最新版本 31\.0\.0 发布于 2026/10/27（11 天前）；至今共发布 57 个版本，其中过去 12 个月发布了 29 个；首次发布于 2024/10/08。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。