文档 API参考

添加支持SDK(必选)

添加支持SDK(必选)

在将支持SDK添加到您的iOS项目之前，请确保Zendesk支持管理员已在Zendesk支持中注册了您的应用程序。亚博看到在Zendesk Support中注册应用程序亚博在支持帮助中心。

您可以使用以下方法之一将Support SDK添加到您的项目中:

支持SDK使用iOS中的相机和照片库，让最终用户将图像附件添加到门票。无论您选择哪种方法添加SDK，都要检查info.plist用于相机和照片库访问的文件。

使用SPM添加SDK

Swift包管理器是一个管理Swift代码分发的工具。它与Swift构建系统集成，可以自动下载、编译和链接依赖项。

将Support SDK作为依赖项添加到项目中:

  1. 遵循苹果公司的文档如何将包添加到项目中。

  2. 粘贴支持SDK包的URL，https://github.com/亚博zendesk/support_sdk_ios，进入…选择存储库包搜索栏。

  3. 选择基于版本的软件包要求，并设置为最新版本的SDK。

使用CocoaPods添加SDK

CocoaPods是一个依赖项管理器，它允许你向项目中添加第三方框架和库。有关安装说明，请参见安装CocoaPods。

如果还没有完成，为你的项目创建一个Podfile如下:

  1. 在Terminal中，导航到项目的顶级文件夹(包含xcodeproj文件)。

  2. 使用以下命令创建Podfile:$ pod init

  3. 用以下命令在Xcode中打开文件:打开- Xcode Podfile

内容应该如下所示:

             

              
”””鲁比（人名）目标“我的样本应用”做use_frameworks !#如果你使用Objective-C，删除这一行结束”””

将Zendesk亚博支持SDK添加到您的Podfile中，并在您的项目中安装支持SDK，如下所示:

  1. 添加豆荚的Ze亚博ndeskSDK到做布洛克:

                   
    
                
    目标“我的样本应用”做．．．豆荚的Ze亚博ndeskSupportSDK结束

    只安装API提供者自己建立美国;

                   
    
                
    目标“我的样本应用”做．．．豆荚的Ze亚博ndeskSupportProvidersSDK结束

  2. 保存Podfile。

  3. 在“Terminal”中执行如下命令:

                   
    
                
    圆荚体安装

    请注意:如果您使用CocoaPods安装了以前版本的SDK，请运行更新ZendeskSu亚博pportSDK首先更新系统上的SDK pod。

因为你的项目现在包含了一个由CocoaPods管理的依赖项，你必须在Xcode中通过双击.xcworkspace文件,而不是.xcodeproj。

有关更多信息，请参见使用CocoaPods在cocoapods.org上。

为迦太基添加SDK

Carthage是iOS应用中另一个常见的第三方依赖管理器。有关安装和使用说明，请参见安装迦太基在Github上的迦太基自述。

  1. 在你的cartfile，添加以下行来导入必要的框架来构建6.0.0版本的支持SDK:

                   
    
                
    Github "亚博zendesk/support_sdk_ios" ~> 6.0.0

    请注意如果你只需要支持API提供者如果没有UI，您只需要添加SupportProvidersSDK到你的文件夹。

                   
    
                
    Github "亚博zendesk/support_providers_sdk_ios" ~> 6.0.0

  2. 保存carfile。

  3. 执行如下命令:

Carthage更新——use-xcframeworks ' ' '

  1. 将以下框架拖到框架和库部分，在应用程序目标的常规设置选项卡下。确保嵌入下拉了嵌入和签名为每个框架选择。
    • 亚博ZendeskCoreSDK.xcframework
    • SupportProvidersSDK.xcframework
    • SupportSDK.xcframework
    • CommonUISDK.xcframework
    • MessagingSDK.xcframework
    • MessagingAPI.xcframework
    • SDKConfigurations.xcframework

请注意:您的应用程序构建目标必须指向其FRAMEWORK_SEARCH_PATHS在Carthage/Build/iOS文件夹中设置。

手动添加SDK

要在你的应用中使用支持SDK，你必须在Xcode中手动添加Zendesk支持SDK到你的项目中。亚博指令的不同取决于你是使用Swift还是Objective-C。

Swift:在Xcode中手动添加支持SDK

  1. 下载以下ZIP文件:

  1. 在XCode中，在project navigator中选择你的项目:

  2. 在Finder中，导航到提取SDK的位置。

  3. 将下面的XCFrameworks拖到框架和库部分，在应用程序目标的常规设置选项卡下。确保嵌入下拉了嵌入和签名为每个框架选择。

    • 亚博ZendeskCoreSDK.xcframework
    • SupportProvidersSDK.xcframework
    • SupportSDK.xcframework
    • CommonUISDK.xcframework
    • MessagingSDK.xcframework
    • MessagingAPI.xcframework
    • SDKConfigurations.xcframework

  4. 设置添加文件选项如下:

    • 目的地——选择如果需要，复制项目
    • 添加文件夹——选择创建组

请注意如果你在构建项目时出现链接错误，你可能需要在你的项目中添加以下一个或两个Apple核心框架:MobileCoreServices.framework和Security.framework。它们并不总是自动添加的。

目标- c:在Xcode中手动添加Support SDK

  1. 下载ZIP文件亚博Zendesk支持SDK库在Github上解压缩你硬盘上的文件。

  2. 在XCode中，在project navigator中选择你的项目。

  3. 在Finder中，导航到提取SDK的位置。

  4. 确保有一个框架目录在项目目录的顶层。如果该目录不存在，请创建该目录。

  5. 将以下项目复制到框架文件夹。

    • 亚博ZendeskCoreSDK.xcframework
    • SupportProvidersSDK.xcframework
    • SupportSDK.xcframework
    • CommonUISDK.xcframework
    • MessagingSDK.xcframework
    • MessagingAPI.xcframework
    • SDKConfigurations.xcframework

  6. 将这些项目拖到框架和库节，并确保嵌入下拉了嵌入和签名为他们每个人选择。

  7. 其余的Add Files设置如下:

    • 目的地——选择如果需要，复制项目
    • 添加文件夹——选择创建组
    • 添加到目标-确保您的应用程序和所有相关的目标被选中

  8. 在你的项目中建立设置，搜索FRAMEWORK_SEARCH_PATHS。添加项目框架文件夹中。你可以简单地把文件夹从Finder中拖进来。

  9. 在建立设置，搜索CLANG_ENABLE_MODULES。将此字段设置为是的。

  10. 在建立设置，搜索ALWAYS_EMBED_SWIFT_STANDARD_LIBRARIES。将此字段设置为是的。

添加iCloud权限

要允许用户附加文件以支持来自其iCloud帐户的请求，您必须启用iCloud文档在你的应用中功能。

更新info.plist中的使用说明

支持SDK使用iOS中的相机和照片库，允许最终用户向门票添加图像附件。注意，为了发送任何图像附件，用户必须同时允许这两者。

如果你的应用还没有请求这些功能的权限，请更新你的info.plist的使用说明文件NSPhotoLibraryUsageDescription和NSCameraUsageDescription。

在Apple中了解更多关于Cocoa键的信息开发人员文档。