核心设置和命令影响整个消息传递小部件。

开放

泽(“信使”,“开放”);

打开消息传递Web小部件。

参数

没有一个

关闭

泽(“信使”,“关闭”);

关闭消息传递Web小部件。

参数

没有一个

在开放

zE('messenger:on', 'open', callback)

当消息传递Web小部件打开时执行回调。

参数

  • 回调:函数。

例子

             
“使者:““开放”函数控制台日志您已经打开了消息传递Web小部件

在关闭

zE('messenger:on', 'close', callback)

在消息传递Web小部件关闭时执行回调。

参数

  • 回调:函数。

例子

             
“使者:““关闭”函数控制台日志您已经关闭了消息传递Web小部件

未读消息

zE('messenger:on', 'unreadMessages', callback)

当未读消息的数量发生变化时执行回调。

参数

  • 回调:函数。回调函数被传递到当前数<数>执行时的未读消息。

例子

             
“使者:““unreadMessages”函数控制台日志你有$ {未读消息(s)。

自定义启动器

要创建自定义消息传递Web Widget启动程序并定义其行为方式,请使用开放关闭unreadMessagesAPI和发射器设置用于管理中心的消息。

设置语言环境

zE('messenger:set', 'locale', newLocale)

设置消息传递Web小部件的区域设置。它覆盖了消息传递Web Widget的默认行为,即与最终用户在其Web浏览器中设置的相同语言相匹配。

该命令以区域设置字符串作为参数。对于支持的地区和相关代码的列表,使用以下Zendesk公共REST API端点:亚博https://support.亚博zendesk.com/api/v2/locales/public.json

请注意:这段代码应该放在消息传递Web Widget代码片段之后。

参数

  • newLocale:字符串。要更改区域设置的locale字符串。

设置zIndex

zE('messenger:set', 'zIndex', newZIndex);

在消息传递Web小部件的所有iframe上设置CSS属性z-index。

当两个元素重叠时,元素的z-index值决定哪一个覆盖另一个。具有较大z指数的元素覆盖具有较小z指数的元素。

默认情况下,消息传递Web小部件中的所有iframe的z-index值为999999

参数

  • newZIndex:数字。用于消息传递Web小部件的所有iframe的z-index值

例子

             
“使者:设置”“zIndex”123

集饼干

zE('messenger:set', 'cookies', isEnabled);

消息传递Web Widget混合使用了cookie以及本地和会话存储以实现功能。

如果最终用户选择不使用cookie,您可以使用下面的命令让消息传递Web Widget知道它不能使用这些存储选项。

目前,禁用cookie将导致对最终用户隐藏消息传递Web Widget,并删除本地和会话存储中的所有值。

参数

  • isEnabled:布尔。如果为false,则消息传递Web Widget将从视图中隐藏,并删除所有存储的数据。

例子

             
“使者:设置”“饼干”