所有位置

事件

除了核心事件之外，以下事件可用于支持产品中的所有位置。

• 通知事件
• 窗口事件
• Talk Partner Edition活动

通知事件

当一个通知通过通知REST API端点，框架触发事件。有关通知端点的详细信息，请参见向App发送通知。

使用以下语法定义自定义事件处理程序。自定义事件处理程序应该始终以"api_notification"作为前缀:

             

              
客户端。在（“api_notification.event_name”，函数（数据）{控制台。日志（数据。身体，数据。发送方）；}）；
             

event_name是发送方传递给notify API的事件的名称。事件处理程序接收通知的数据和发送方的信息。发送者的信息是用户对象。

注意:以前这被称为通知事件，但它没有sender参数。

窗口事件

应用程序可以访问一些常见的DOM窗口事件通过窗口事件名称空间。

注意:窗口事件是防反跳在应用程序中出于性能原因。在每个事件的描述下面都标注了剥离等待值。

可用的事件:

window.resize

的window.resize事件最多每~33(1000/30)毫秒触发一次。

参数

• 宽度相当于window.innerWidth
• 高度相当于window.innerHeight

window.scroll

的window.scroll事件最多每~16(1000/60)毫秒触发一次。

参数

• scrollTop相当于window.scrollTop

Talk Partner Edition活动

Talk Partner Edition需要使用这些事件。

有关可以使用该API构建的潜在集成特性，请参阅Talk Partner Edition开发人员指南。

可用的事件:

voice.dialout

的voice.dialout事件在座席单击呼叫电话号码时触发。

参数

• 从可以user_phone_identity(用户档案联络资料部分)或ticket_editor(从票务编辑器的呼叫菜单中)
• 数量所选电话号码
• 用户标识所选用户的id
• ticketId当前票的id

voice.error

的voice.error事件在订阅任何其他Talk Partner Edition事件时发生错误时触发。

参数

• 代码可以0(未知错误)或1(禁止，这意味着必须购买Talk Partner Edition的订阅)
• 消息关于错误的描述性消息

对象

以下对象以及许多附加属性和操作在Support产品的所有位置都可用。

• 帐户对象
• 用户对象
• Group对象
• 标识对象
• 时区对象
• Apps托盘对象

额外的属性

• 可见

额外的行动

• 隐藏
• 显示
• 通知
• 实际上

的核心事件也适用于所有位置的应用程序。

帐户对象

currentAccount

得到

             

              
客户端。得到（“currentAccount”）
             

返回

             

              
{“currentAccount”：{//帐户对象属性}}
             

属性

• account.planName
• account.subdomain
• account.daysLeftInTrial
• account.timeZone

account.planName

得到

             

              
客户端。得到（“currentAccount.planName”）
             

返回

             

              
{“currentAccount.planName”：字符串}
             

account.subdomain

得到

             

              
客户端。得到（“currentAccount.subdomain”）
             

返回

             

              
{“currentAccount.subdomain”：字符串}
             

account.daysLeftInTrial

得到

             

              
客户端。得到（“currentAccount.daysLeftInTrial”）
             

返回

             

              
{“currentAccount.daysLeftInTrial”：整数}
             

account.timeZone

得到

             

              
客户端。得到（“currentAccount.timeZone”）
             

返回

             

              
{“currentAccount.timeZone”：{//时区对象属性}}
             

用户对象

用户

得到

你可以使用'user'参数来获取用户对象用户侧栏地点:

             

              
客户端。得到（“用户”）
             

在其他位置，你可以用以下参数获取用户对象:

• 在任何地点:

                 
  
                  
  客户端。得到（“currentUser”）
                 

• 在票证和新票证侧栏中:

                 
  
                  
  客户端。得到（“ticket.requester”）/ /或客户端。得到（“ticket.assignee.user”）
                 

用户对象也由其他api返回，例如ticket.requester。在下面的文档中，< path_to_user >占位符表示上面返回用户对象的值之一。

返回

             

              
{“currentUser”：{//用户对象属性}}
             

或

             

              
{“ticket.requester”：{//或"ticket.assign .user"//用户对象属性}}
             

或

             

              
{“用户”：{//用户对象属性}}
             

属性

• user.id
• user.email
• user.groups
• user.organizations
• user.identities
• user.name
• user.role
• user.externalId
• user.locale
• user.details
• user.notes
• user.alias
• user.signature
• user.timeZone
• user.tags
• user.avatarUrl
• user.customField: field_name

user.id

得到

             

              
客户端。得到（' < path_to_user > .id”）
             

返回

             

              
{“< path_to_user > .id”：整数}
             

user.email

得到

             

              
客户端。得到（' < path_to_user > .email”）
             

返回

             

              
{“< path_to_user > .email”：字符串}
             

限制:255个字符

user.groups

得到

             

              
客户端。得到（' < path_to_user > .groups”）
             

返回

             

              
{“< path_to_user > .groups”：({//分组对象属性}］}
             

看到Group对象属性。

user.organizations

得到

             

              
客户端。得到（' < path_to_user > .organizations”）
             

返回

             

              
{“< path_to_user > .organizations”：({//组织属性}］}
             

看到组织对象对于属性。

user.name

得到

             

              
客户端。得到（' < path_to_user > . name '）
             

返回

             

              
{“< path_to_user > . name”：字符串}
             

限制:255个字符

user.identities

得到

             

              
客户端。得到（' < path_to_user > .identities”）
             

返回

             

              
{“< path_to_user > .identities”：({//标识对象属性}］}
             

看到标识对象属性。

user.role

得到

取值为“end-user”、“agent”、“admin”，如果用户在企业计划或以上版本中拥有自定义角色，则为自定义角色id。

             

              
客户端。得到（' < path_to_user > .role”）
             

返回

             

              
{“< path_to_user > .role”：字符串|整数}
             

user.externalId

得到

             

              
客户端。得到（' < path_to_user > .externalId”）
             

集

             

              
客户端。集（' < path_to_user > .externalId”，价值）
             

返回

             

              
{“< path_to_user > .externalId”：字符串}
             

user.locale

得到

             

              
客户端。得到（' < path_to_user > .locale”）
             

返回

             

              
{“< path_to_user > .locale”：字符串}
             

user.details

得到

             

              
客户端。得到（' < path_to_user > .details”）
             

集

             

              
客户端。集（' < path_to_user > .details”，价值）
             

返回

             

              
{“< path_to_user > .details”：字符串}
             

user.notes

得到

             

              
客户端。得到（' < path_to_user >自身之外的）
             

集

             

              
客户端。集（' < path_to_user >自身之外的，价值）
             

返回

             

              
{“< path_to_user >自身之外”：字符串}
             

user.alias

得到

             

              
客户端。得到（' < path_to_user > .alias”）
             

集

             

              
客户端。集（' < path_to_user > .alias”，价值）
             

返回

             

              
{“< path_to_user > .alias”：字符串}
             

user.signature

得到

             

              
客户端。得到（' < path_to_user > .signature”）
             

集

             

              
客户端。集（' < path_to_user > .signature”，价值）
             

返回

             

              
{“< path_to_user > .signature”：字符串}
             

user.timeZone

得到

             

              
客户端。得到（' < path_to_user > .timeZone”）
             

返回

             

              
{“< path_to_user > .timeZone”：{//时区对象属性}}
             

看到时区对象属性。

user.tags

得到

             

              
客户端。得到（' < path_to_user > .tags”）
             

返回

             

              
{“< path_to_user > .tags”：(/ /字符串］}
             

user.avatarUrl

得到

             

              
客户端。得到（' < path_to_user > .avatarUrl”）
             

返回

             

              
{“< path_to_user > .avatarUrl”：字符串}
             

user.customField:字段名

用户自定义字段值作为其定义的类型。取代字段名使用自定义字段的关键属性。用户用户字段REST API来获取可能的列表关键值。

得到

             

              
客户端。得到（' < path_to_user > .customField:字段名）//例如client.get('.customField:my_text_field')
             

集

             

              
客户端。集（' < path_to_user > .customField:字段名，价值）//例如client.set('。customField: my_text_field”,值)
             

返回

             

              
{“< path_to_user > .customField:字段名”：字符串}
             

Group对象

在本节中< path_to_user >占位符用于表示用户。看到用户对象节获取可能的值。

属性

• group.id
• group.name

group.id

得到

             

              
客户端。得到（' < path_to_user > .groups.0.id”）
             

返回

             

              
{“< path_to_user > .groups.0.id”：整数}
             

group.name

得到

             

              
客户端。得到（' < path_to_user > .groups.0.name”）
             

返回

             

              
{“< path_to_user > .groups.0.name”：字符串}
             

标识对象

用户标识标识Zendesk Support帐户中的人员。亚博它通常是一个电子邮件地址，但也可以是一个电话号码，一个推特帐号，或其他选项。

变量将在下面的文档中使用。看到用户对象此变量可能值的文档。

属性

• identity.id
• identity.type
• identity.value
• identity.verified
• identity.primary
• identity.userId
• identity.undeliverableCount
• identity.deliverableState

identity.id

得到

             

              
客户端。得到（' < path_to_user > .identities.0.id”）
             

返回

返回标识的id。

             

              
{“< path_to_user > .identities.0.id”：整数}
             

identity.type

得到

             

              
客户端。得到（' < path_to_user > .identities.0.type”）
             

返回

返回其中之一电子邮件，推特，脸谱网，谷歌，agent_forwarding,或phone_number。

             

              
{“< path_to_user > .identities.0.type”：字符串}
             

identity.value

得到

             

              
客户端。得到（' < path_to_user > .identities.0.value”）
             

返回

返回此标识的标识符，例如电子邮件地址或电话号码。

             

              
{“< path_to_user > .identities.0.value”：字符串}
             

identity.verified

得到

             

              
客户端。得到（' < path_to_user > .identities.0.verified”）
             

返回

如果身份已验证，则返回true。

             

              
{“< path_to_user > .identities.0.verified”：布尔}
             

identity.primary

得到

             

              
客户端。得到（' < path_to_user > .identities.0.primary”）
             

返回

如果此标识是主标识，则返回true。

             

              
{“< path_to_user > .identities.0.primary”：布尔}
             

identity.userId

得到

             

              
客户端。得到（' < path_to_user > .identities.0.userId”）
             

返回

返回用户的id。

             

              
{“< path_to_user > .identities.0.userId”：整数}
             

identity.undeliverableCount

得到

             

              
客户端。得到（' < path_to_user > .identities.0.undeliverableCount”）
             

返回

对于单位类型的电子邮件，返回在该地址收到软反弹响应的次数。最大值为10，之后为deliverable_state设为无法投递的。

             

              
{“< path_to_user > .identities.0.undeliverableCount”：整数}
             

identity.deliverableState

得到

             

              
客户端。得到（' < path_to_user > .identities.0.deliverableState”）
             

返回

对于单位类型的电子邮件，返回可交付成果或无法投递的。

             

              
{“< path_to_user > .identities.0.deliverableState”：字符串}
             

时区对象

的< path_to_user >占位符在以下文档中使用。看到用户对象此变量可能值的文档。

属性

• timezone.name
• timezone.translatedName
• timezone.ianaName
• timezone.offset
• timezone.formattedOffset

timezone.name

得到

             

              
客户端。得到（' < path_to_user > .timeZone.name”）
             

返回

             

              
{“< path_to_user > .timeZone.name”：字符串}
             

timezone.translatedName

得到

             

              
客户端。得到（' < path_to_user > .timeZone.translatedName”）
             

返回

             

              
{“< path_to_user > .timeZone.translatedName”：字符串}
             

timezone.ianaName

得到

             

              
客户端。得到（' < path_to_user > .timeZone.ianaName”）
             

返回

根据IANA时区数据库返回时区名称。示例:“美国/ Los_Angeles”。

             

              
{“< path_to_user > .timeZone.ianaName”：字符串}
             

timezone.offset

得到

             

              
客户端。得到（' < path_to_user > .timeZone.offset”）
             

返回

返回时区相对于GMT的偏移分钟数。

             

              
{“< path_to_user > .timeZone.offset”：字符串}
             

timezone.formattedOffset

得到

             

              
客户端。得到（' < path_to_user > .timeZone.formattedOffset”）
             

返回

             

              
{“< path_to_user > .timeZone.formattedOffset”：字符串}
             

Apps托盘对象

的appsTray对象允许您显示和隐藏包含侧边栏应用程序的托盘。

appsTray

得到

             

              
客户端。得到（“appsTray”）
             

返回

             

              
{“appsTray”：{isVisible：布尔}}
             

属性

• appsTray.isVisible

行动

• appsTray.show
• appsTray.hide

appsTray.isVisible

得到

             

              
客户端。得到（“appsTray.isVisible”）
             

返回

             

              
{“appsTray.isVisible”：布尔}
             

appsTray.show

显示应用程序托盘，如果隐藏。

调用

             

              
客户端。调用（“appsTray.show”）
             

返回

             

              
{“appsTray.show”：{“isVisible”：真正的}}
             

appsTray.hide

隐藏应用程序托盘。

调用

             

              
客户端。调用（“appsTray.hide”）
             

返回

             

              
{“appsTray.hide”：{“isVisible”：假}}
             

额外的属性

可见

指定应用程序是否已被隐藏client.invoke(隐藏的)。

得到

             

              
客户端。得到（“可见”）
             

返回

             

              
{“可见”：真正的}
             

额外的行动

• 隐藏
• 显示
• 通知
• 实际上

隐藏

隐藏应用程序。

调用

             

              
客户端。调用（“隐藏”）
             

显示

如果隐藏则显示应用程序。

调用

             

              
客户端。调用（“显示”）
             

通知

在座席界面的右上方显示一条通知。

调用

             

              
客户端。调用（“通知”，消息(，种类，持续时间］）/ /或客户端。调用（“通知”，消息(，种类，选项］）
             

参数

• 消息通知消息。支持HTML标记来格式化字符串。

• 种类(可选)设置通知框的背景颜色。可能的值:

  价值	背景颜色
  “通知”	绿色
  “警告”	黄色的
  “错误”	红色的

  如果省略该参数，则默认值为'notice'。

• 持续时间(可选)通知显示的时间(以毫秒为单位)。如果省略该参数，则默认值为4000。

• 选项(可选)具有属性名为黏糊糊的它接受一个布尔值。控制通知是否保持打开状态，直到用户有意关闭它。如果省略该参数，则默认值为{粘性:假}。要更改它，请使用{粘性:真}。

实际上

在座席界面中打开票证、用户配置文件、组织配置文件、视图或导航栏应用程序的选项卡。

调用

             

              
客户端。调用（“实际上”，tabType，id）/ /或客户端。调用（“实际上”，“票”，“新”）/ /或客户端。调用（“实际上”，“nav_bar”，浏览器名称，appSection）
             

参数

• tabType要在用户界面中打开的实体类型。可以“票”，“用户”，“组织”，“视图”,或“nav_bar”。
• id(可选的观点)以数字或字符串形式打开实体的id。
• 新对于票证，在代理界面中打开一个新的票证标签。
• 浏览器名称(可选)对于导航栏应用程序，一个要路由到的应用程序名称的净化版本，其中破折号取代名称中的下划线、空格或驼峰大小写。例如,客户端。调用（“实际上”，“nav_bar”，'app-name')航线/代理/应用程序/应用名称。省略时，默认为负责触发此操作的应用的名称。
• appSection(可选)对于导航栏应用程序，在导航栏应用程序中路由到的部分。例如:客户端。调用（“实际上”，“nav_bar”，'app-name', 'dashboard')航线/代理/应用程序/应用名称/仪表盘。

返回

只有当选项卡成功打开时才会解析的承诺。promise没有解析成一个有用的值。