简而言之,支持iOS SDK
简而言之,支持iOS SDK
本页为您提供了使用Support SDK启动和运行的基本步骤。
SDK要求如下:
- 最低iOS版本:11
- 支持5.0.3及更新版本的XCode 11.4+和Swift 5.2.2
什么是支持SDK?
支持SDK可以帮助您添加以下功能到您的应用程序:
- 显示全部或部分帮助中心内容
- 搜索帮助中心内容
- 显示打开的请求
- 创建请求
- 更新请求
您可以使用支持SDK自定义所有这些功能的用户界面的颜色和字体。查看更多信息自定义外观
我们自己的记住日期应用程序是一个应用程序使用我们的UI的例子。该应用程序的源代码打开了GitHub.
您也可以在没有提供UI的情况下使用Support SDK的功能。这允许您构建自己的UI。这需要更多的开发时间,但可以让您更好地控制。了解详情API提供者在此基础上,您可以构建自己的UI。
你需要什么?
您的组织有一个Zendesk支持帐户。亚博你可以注册开始免费试用。
Ze亚博ndesk管理员已经在Zendesk支持中注册了您的iOS应用程序。看到在Zendesk Support中注册移动应用程序亚博在支持帮助中心
Zend亚博esk管理员已经为您提供了应用程序的初始化代码。当管理员注册应用程序时,代码在Zendesk支持中生成
您想要使用的功能包含在Zendesk计划中。亚博看到每个计划的功能和限制的细分.
开始跑步
将SDK添加到项目中。
有关详情,请参阅添加支持SDK.
初始化SDKAppDelegate项目的文件。这是一个两步的过程。首先,你初始化Core SDK,然后初始化Support SDK。
斯威夫特
亚博Zendesk。初始化ialize(appId: "appId", clientId: "clientId", zendeskUrl: "url")
支持。初始化ialize(withZendesk: Zendesk.instance)
objective - c
(ZDK亚博Zendesk initializeWithAppId:“appId”clientId:“clientId”亚博zendeskUrl:“url”];
(ZDKSupport initializeWith亚博Zendesk:(ZDK亚博Zendesk实例]];
如果你只使用API提供者自己构建UI;
斯威夫特
亚博Zendesk。初始化ialize(appId: "appId", clientId: "clientId", zendeskUrl: "url")
支持。初始化ialize(withZendesk: Zendesk.instance)
objective - c
(ZDK亚博Zendesk initializeWithAppId:“appId”clientId:“clientId”亚博zendeskUrl:“url”];
(ZDKSupport initializeWith亚博Zendesk:(ZDK亚博Zendesk实例]];
请注意如果你正在使用多个品牌的主子域,而不是主子域
亚博zendeskUrl
在上面的代码中。请记住,最终用户将只能查看属于该品牌的门票。创建一个身份,以便应用程序可以作为Zendesk支持用户进行身份验证,然后将其设置在亚博
亚博
单例模式:斯威夫特
let ident = Identity.createAnonymous()
亚博Zendesk.instance ? .setIdentity(鉴别)
objective - c
id<ZDKObjCIdentity>userIdentity=((ZDKObjCAnonymous alloc]initWithName:空的邮件:零];
((ZDK亚博Zendesk实例]setIdentity:userIdentity];
有两种类型的身份:匿名和JWT。有关详情,请参阅设置标识.
支持SDK现在已经初始化,可以使用了。
启动支持SDK UI
支持SDK提供了4个视图控制器:
- HelpCenterOverviewViewController
- HelpCenterArticleViewController
- RequestViewController
- RequestListViewController
这些uiviewcontroller是由RequestUi
和ZDKHelpCenterUi
.它们可以以任何方式呈现,但必须包含在UINavigationController中。例子:
斯威夫特
let viewController = RequestUi。buildRequestUi (: [])
self.navigationController ?。pushViewController(viewController, animated: true)
objective - c
ui*requestList=(ZDKRequestUi buildRequestUiWith:@(]];
(自我.导航控制器pushViewController:requestList动画:是的];
可以使用RequestUiConfiguration
和ZDKHelpCenterUI
.例子:
斯威夫特
//创建一个配置对象
let config = RequestUiConfiguration()
配置。主题="Testing the SDK"
配置。标签=("ios", "testing"]
//呈现SDK
让requestScreen = RequestUi。buildRequestUi((配置):)
self.navigationController ?。pushViewController(requestScreen, animated: true)
objective - c
//创建一个配置对象
ZDKRequestUiConfiguration*配置=((ZDKRequestUiConfiguration alloc]初始化];
配置.标签=@(@“创建请求”];
配置.主题=“从创建请求中测试”;
//呈现SDK
ui*requestScreen=(ZDKRequestUi buildRequestUiWith:@(配置]];
(自我.导航控制器pushViewController:requestScreen动画:是的];
你可以通过一个屏幕配置
到另一个屏幕,当其中一个启动另一个时应用。有关详情,请参阅配置SDK活动.
要查看一些使用Zendesk移动sdk的不同方式的示例,请查看我们的示例应用程序库亚博Github上.