该应用程序以按钮的形式显示在车票的富文本编辑器的工具栏中。点击按钮打开应用程序。票务编辑器应用程序通常为编辑器添加功能。

富文本编辑器默认为新帐户启用。它可以通过使用管理界面在现有帐户中启用。看到启用代理的格式化选项。此应用程序位置在Markdown编辑器中不可用。

示例清单

             
“位置”“支持”“ticket_editor”“资产/ iframe.html”}}

看到设置应用位置

每个编辑器应用程序都必须有一个SVG图标icon_ticket_editor.svg。它必须满足与导航栏和顶部栏应用程序的SVG图标相同的设计规范。看到样式和资产

你可以使用全局变量调整行动与编辑器应用程序,但尺寸是有限的如下:

  • 高度:100px - 320px
  • 宽度:100px - 1000px

中可用的对象所有位置票侧边栏,以下对象、属性和操作在此位置可用:

当票证处于聊天模式时,API功能有限

当票据处于Chat模式时,以下api将不会产生预期的输出:

对象/属性 行动
ticket.editor。* 调用

不尝试使用这些API进行API调用,而是调用console.error

调用ticket.editor.insert在聊天模式下工作,并在聊天编辑器中将富文本自动转换为纯文本(Markdown语法)。

请注意: API限制适用于亚博Zendesk Agent工作区

事件

除了核心事件,票务编辑器中的应用程序可使用以下事件:

  • pane.activated

例子:

             
客户端“pane.activated”函数/ /处理程序}

有关详情,请参阅pane.activated在顶部栏文档中。

  • ticket.editor.targetChannel.changed
  • ticket.editor.capabilities.changed

票证编辑器对象

表示票据接口中的编辑器。

行动

ticket.editor.insert

在游标处插入字符串。

注意:使用ticket.editor时。出于安全原因,HTML注释要经过HTML清理器和规范化器,并与票证编辑器的HTML规则相匹配。这包括删除大多数CSS和一些影响表格格式的HTML标签。

调用
             
客户端调用“ticket.editor.insert”“我的打印机着火了”

ticket.editor.indent

增加包含游标的段落的缩进。

调用
             
客户端调用“ticket.editor.indent”

ticket.editor.outdent

减少包含游标的段落的缩进。

调用
             
客户端调用“ticket.editor.outdent”

ticket.editor.bold

显示文本选择。

调用
             
客户端调用“ticket.editor.bold”

ticket.editor.italic

使文本选择斜体。

调用
             
客户端调用“ticket.editor.italic”

ticket.editor.unorderedList

在游标处启动一个无序列表。

调用
             
客户端调用“ticket.editor.unorderedList”

ticket.editor.orderedList

在游标处启动一个有序列表。

调用
             
客户端调用“ticket.editor.orderedList”

ticket.editor.blockquote

对包含游标的段落应用引号格式。

调用
             
客户端调用“ticket.editor.blockquote”

ticket.editor.codespan

将代码字体应用于文本选择。字体通常是浏览器默认的等宽字体。

调用
             
客户端调用“ticket.editor.codespan”

ticket.editor.codeblock

将代码字体应用于包含光标的段落。

调用
             
客户端调用“ticket.editor.codeblock”

将链接应用于文本选择,如果没有选择文本,则将其插入光标处。该操作显示一个模态视图来指定链接文本和URL。

调用
             
客户端调用“ticket.editor.hyperlink”

ticket.editor.inlineImage

在光标处插入图像。您可以将图像指定为URL或base64编码的字符串。

所有Zendesk套件计划的最大文件大小为50 MB。亚博

调用

URL

             
客户端调用“ticket.editor.inlineImage”“http://www.example.com/image.png”

base64编码的字符串

             
客户端调用“ticket.editor.inlineImage”的数据:图像/ png, base64 iVBORw0KGgoAA……”

ticket.editor.hr

在游标处插入一条水平线(水平线)。

调用
             
客户端调用“ticket.editor.hr”

ticket.editor.targetChannel

提供有关代理当前所处的编辑器通道的详细信息。

得到
             
客户端得到“ticket.editor.targetChannel”
返回
             
“ticket.editor.targetChannel”//目标通道对象属性}

看到目标通道属性。

ticket.editor.capabilities

基于代理当前使用的编辑器提供通道的富文本功能。

得到
             
客户端得到“ticket.editor.capabilities”
返回
             
“ticket.editor.capabilities”//功能对象属性}}

看到功能属性。

目标通道对象

属性

targetChannel.name

得到
             
客户端得到“ticket.editor.targetChannel.name”
返回
             
“ticket.editor.targetChannel.name”字符串//电子邮件,聊天,网页,facebook, whatapp等}

此属性应仅用于报告和分析目的。到能力映射的通道可能在将来的任何时候发生变化。在向编辑器中插入内容时,我们建议始终引用功能对象来决定一个应用程序能够在编辑器中渲染什么,而不是依赖于targetChannel.name

targetChannel.sessionBased

指定通道是异步的还是同步的。这个属性可以用来驱动代理体验功能,在Zendesk支持应用程序中,这取决于代理所处渠道的即时性。亚博

基于会话的消息传递被定义为涉及同时参与的两方之间的实时对话的通信通道。基于会话的消息传递的例子包括Zendesk Chat和Zendesk Talk对话。亚博非基于会话的消息传递指的是具有会话特征的通道,这些会话可以实时发生,但通常是异步的。例子包括电子邮件、社交信息或网络表单票务。

             
客户端得到“ticket.editor.targetChannel.sessionBased”
返回
             
“ticket.editor.targetChannel.sessionBased”布尔}

targetChannel.sessionActive

如果编辑器的当前通道是同步的,则此属性指定通道当前是否处于活动会话中。

得到
             
客户端得到“ticket.editor.targetChannel.sessionActive”
返回
             
“ticket.editor.targetChannel.sessionActive”布尔}

功能对象

属性

capabilities.richText

指定编辑器所在的当前通道是否支持富文本呈现。

得到
             
客户端得到“ticket.editor.capabilities.richText”
返回
             
“ticket.editor.capabilities.richText”布尔}

额外的属性

额外的行动

app.close

关闭包含票务编辑器应用程序的弹出窗口。

调用
             
客户端调用“app.close”