导航栏

该应用程序以图标的形式出现在代理界面左侧的导航栏中。点击图标打开应用程序。

示例清单

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

看到设置应用位置

中提供的对象所有位置,在此位置可使用以下附加操作:

事件

除了核心事件,在导航栏中,应用程序可以使用以下事件:

有关窗格事件的详细信息,请参见事件在顶部栏文档中。

app.route.changed

导航栏应用程序与其他位置的不同之处在于,可以使用直接链接直接浏览到特定应用程序的内容窗格。例子:

https://z3n.亚博zendesk.com/agent/apps/app-name

链接的最后一部分,应用名称,对应于安装时赋予应用程序的唯一名称。如果应用程序名称是驼峰大小写或包含空格或下划线,则该名称将被转换为由破折号分隔的字符串,以使其url友好并保持格式一致。

要查看导航条应用程序的路由,请在Zendesk Support中安装一个导航条应用程序,并单击导航条中的应用程序图标。亚博浏览器的URL应该包括代理/应用程序加上你的应用程序安装名称的净化版本。

除了直接浏览到导航栏应用程序,你还可以在应用程序URL中包含其他部分。例子:https://z3n.亚博zendesk.com/agent/apps/app-name/foo/bar/baz

当包含额外的片段时,经过处理的应用标题之后的部分将通过app.route.changed事件。

例子:

             
zafClient“app.route.changed”函数数据{控制台日志数据appRoute/ /“foo / bar /巴兹”控制台日志数据appTitle/ /“我的程序”}
URL参数

app.route.changed事件在导航栏应用程序中触发时,传递给处理程序的事件数据对象包含一个键forappParams。的appParamskey包含处理路由时存在的任何URL参数的JSON对象表示。

请注意: URL以外的参数扎-参数在处理后从URL中剥离,但在应用中可用。

例子:

给定导航栏应用程序路线https://z3n.亚博zendesk.com/agent/apps/app-name/foo/bar/baz?quux=true&boz=2

             
zafClient“app.route.changed”函数数据{控制台日志数据appRoute/ /“foo / bar /巴兹”控制台日志数据appTitle/ /“我的程序”控制台日志数据appParams// {quux: 'true', boz: 2}}

行动

在此位置可使用以下附加操作:

preloadPane

默认情况下,导航栏或顶部栏应用程序的窗格视图仅在应用程序第一次打开时插入DOM。调用preloadPane导致窗格视图提前插入到DOM中,但直到打开应用程序时才可见。当你需要在应用可见之前操作DOM,或者你有一个iframe需要预加载时,这是很有用的。创建应用窗格时,框架会触发pane.created事件。

注意:你只能打电话preloadPane实例的API从先前加载的位置。然而,在大多数情况下,直接从后台位置执行后台任务比预加载窗格更可取。

调用
             
instanceClient调用“preloadPane”//使用实例API从另一个位置调用。

iconSymbol

更改SVG图标。看到iconSymbol API

             
客户端“iconSymbol”symbolName
参数
  • symbolNamea的值id属性<符号id = " mySymbol " >标记在SVG文件中。

注意:你不能用iconSymbol属性更改溢出菜单中的应用程序图标。

iconChars

将SVG图标更改为提供的两个字符。支持use UTF8。

调用
             
客户端调用“iconChars”twoChars客户端调用“iconChars”“Wi”客户端调用“iconChars”“∑”✈
参数
  • twoChars是一个由两个字符组成的字符串,它将被放入导航栏图标中。

注意:你不能用iconChars属性更改溢出菜单中的应用程序图标。