编辑插件参与平台
@atlaskit/editor-core 的参与平台插件
说明: 这一构成部分是为阿特拉斯系统内部开发而设计的. 外部捐助者将能够使用这一构成部分,但无法提交问题.
概览
参与平台插件在编辑器内提供与Atlassian参与平台的集成. 它通过允许您开始和停止接触消息来控制外部消息,以及检查这些消息的状态. 插件需要协调客户端来管理消息的生命周期和状态.
主要特点
- 开始消息 - 启动带有特定ID和可选变异ID的约定信息
- 停止信件 - 停止带有特定身份的订婚信息
- 信件状态跟踪 - 检查接触信息的有效状态
- 基于承诺的API - 通过综合承诺管理防止重复请求
- 协调客户整合 - 与参与平台协调客户合作
安装
- 安装 - 说吧 线条 添加 @ atlaskit/ editor- plugin- engagement- 平台
- 无 - 说吧 @atlaskit/editor-plugin-engagement-平台
- 来源 - 说吧 键盘
- 套装 - 说吧 unpkg.com (英语)
使用量
仅内部使用
@atlaskit/editor-plugin-greatment-platform 供@atlaskit/editor-core内部使用,并作为您产品中编辑器的插件依赖.
不支持直接使用此组件.
基本设置
要使用插件,请导入并包含在编辑器设置中 :
import { engagementPlatformPlugin } from '@atlaskit/editor-plugin-engagement-platform';
const coordinationClient = useCoordinationClient()
const { preset, editorApi } = usePreset(() => {
return universalPreset.add([
engagementPlatformPlugin,
{ coordinationClient },
]);
}, [universalPreset, coordinationClient]);
正在检查信件状态
要获得一个任务消息的当前状态,您可以使用以下代码:
function isMessageActive(messageId: string): boolean {
const messageStates = api.engagementPlatform.sharedState.currentState()?.messageStates ?? {};
return !!messageStates[messageId];
}
插件配置
插件需要一个配置对象,其结构如下:
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 - 编辑器参与平台插件 用于此软件包的文档和示例.
支助
对于内部阿特拉斯人, 访问懒惰的通道 # 帮助编辑器 # 支助或访问 去/编辑-帮助 以提交错误.
许可证
请看 阿特拉斯前端 - 许可证 获取更多的许可证信息.