开始
开始
添加消息传递
到你的项目,从你的Android应用程序与用户互动。
先决条件
在开始集成Zendesk SDK之前,请确保满足以下先决条件。亚博
确保你满足最低支持的Android API级别
最低空气污染指数(
minSdkVersion
)的Zendesk 亚博SDK是21。您可能会收到以下警告。
依赖项“androidx.appcompat:appcompat-resource亚博电脑端s:1.5.1”要求依赖于它的库和应用程序针对32或更高版本的Android api进行编译。
这并不妨碍您进行编译。您仍然可以瞄准Zendesk SDK版本2亚博1,并使用版本32或更高版本进行编译。
运行Zendesk SDK所需的最低Java版本是8。亚博下面是如何配置项目以使用Java版本8进行编译的示例,使用添加到您的build.gradle模块:
安卓{
compileOptions{
sourceCompatibility=JavaVersion。VERSION_1_8
targetCompatibility=JavaVersion。VERSION_1_8
}
}
从Zendesk的管理中心获取通道密钥亚博
在初始化SDK之前,需要获取通道密钥。通道密钥是SDK需要正确初始化的唯一标识符。您可以从Zendesk管理中心获取。亚博有关说明,请参阅在Android和iOS的Zendesk sdk中使用消息传亚博递。如果你的账户不是Zendesk管亚博理员,可以让别人帮你取。
添加SDK依赖项
您可以使用Maven将Android SDK添加到项目中。
以下权限将自动添加到您的AndroidManifest因为SDK必须使网络请求按预期工作。
<uses-permissionandroid:名字=”android.permission.INTERNET”/>
<uses-permissionandroid:名字=”android.permission.ACCESS_NETWORK_STATE”/>
将Zendesk亚博 Maven存储库添加到您的项目依赖项中。
存储库{
maven{
url“https://亚博zendesk.jfrog.io/artifactory/repo”
}
}
将以下依赖项添加到应用程序中build.gradle:
实现“亚博zendesk.messaging: messaging-android: latest_version”
取代
latest_version
的最新可用版本号发布说明。
获取通道密钥
在初始化SDK之前,需要获取通道密钥。通道密钥是SDK需要正确初始化的唯一标识符。您可以从Zendesk管理中心获取。亚博有关说明,请参阅在Android和iOS的Zendesk sdk中使用消息传亚博递。如果你的账户不是Zendesk管亚博理员,可以让别人帮你取。
初始化SDK
初始化SDKonCreate
你的方法应用程序
类。要做到这一点,您需要您的通道密钥,您可以在Zendesk管理中心找到。亚博如果您没有Zendesk的管理员权限,请让Zendesk管理员为您获亚博取信息。
下面的代码片段给出了一个例子消息传递
Kotlin和Java的初始化。
芬兰湾的科特林
进口android.app.Application
进口android.util.Log
进口zende亚博sk.android.Zendesk
进口zende亚博sk.messaging.android.DefaultMessagingFactory
/ * *
在Kotlin中集成了[DefaultMessagingFactory]的示例[应用程序]。
* /
类示例:Application() {
重载onCreate() {
super.onCreate ()
亚博Zendesk.initialize (
Context = this,
channelKey = /*"{channel_key}"*/,
successCallback = {z亚博endesk ->
日志。我(“IntegrationApplication”,“初始化成功”)
},
failureCallback ={错误->
//在崩溃报告仪表板中跟踪异常的原因将有助于在生产中分类任何意外的故障
日志。e(“IntegrationApplication”,”Initialization failed", error)
},
messagingFactory = DefaultMessagingFactory()
)
}
}
Java
导入安卓。应用程序。应用程序;
导入安卓。跑龙套。日志;
进口zende亚博sk。安卓。亚博;
进口zende亚博sk。消息传递。安卓。DefaultMessagingFactory;
/**在Java中集成{@link DefaultMessagingFactory}的示例{@link Application}。* /
类JavaIntegrationApplication扩展应用程序{
@Override
公共空间onCreate(){
超级。onCreate();
亚博。初始化(
这,
/ * * / {channel_key},
亚博->日志。我(“IntegrationApplication”,“初始化成功”),
错误->日志。e(“IntegrationApplication”,"消息初始化失败",错误),
新DefaultMessagingFactory());
}
}
展示对话
如果亚博Zendesk.initialize ()
如果成功,你可以在应用程序的任何地方使用下面的代码片段来显示对话屏幕。
如果亚博Zendesk.initialize ()
不成功,存根实现了吗亚博
类返回并记录到控制台。
芬兰湾的科特林
亚博Zendesk.instance.messaging.showMessaging(上下文)
Java
亚博。getInstance()。getmessage()。showMessaging(上下文);
演示应用程序
我们为用户提供了多个演示应用程序来展示我们SDK的功能。
每个应用程序都展示了一个特定的功能,包括基本实现、JWT身份验证等。每个应用程序都包含一个README文件,详细说明了使应用程序工作所需的步骤。
你可以在我们的亚博Zendesk SDK演示应用。
下一个步骤
如果您已经完成了上面的步骤,那么现在就可以探索SDK并了解消息传递将如何为您的业务和最终用户工作。
推送通知
为了确保良好的最终用户体验,我们还建议设置推送通知,使其与您的应用程序正确合作。设置所需的步骤概述在推送通知。
未读消息
当用户接收到一条新消息时,将使用更新的未读消息总数触发一个事件。要订阅此事件,请向Zendesk SDK实例添加一个事件侦听器。亚博看到事件查看观察未读邮件的必要步骤。
此外,您可以通过调用来检索当前未读消息的总数getUnreadMessageCount ()
在Zendesk SDK实例上的消息传递。亚博
你可以在我们的亚博Zendesk SDK演示应用。
芬兰湾的科特林
亚博zendesk.messaging.getUnreadMessageCount ()
Java
亚博。getmessage()。getUnreadMessageCount();
先进的集成
要探索更高级的集成选项,请参见先进的集成。
故障排除
我们建议在崩溃报告仪表板中跟踪任何初始化失败的原因。这将有助于在将集成部署到生产环境后对其进行故障排除。
日志记录
默认情况下禁用日志记录。您可以在Java或Kotlin中使用以下命令启用它:
进口zende亚博sk。日志记录器。日志记录器;
日志记录器。setLoggable(真正的);
你可以使用以下命令检查Logger的状态:
日志记录器。isLoggable();