Beacon SDK

Help Scout的Beacon SDK允许您在iOS应用中嵌入与网页相同的Beacon功能。信标提供了一种快速而直接的方式，让客户浏览您的知识库或联系您的团队。

要求

Beacon SDK 2.0需要iOS 11.0及以上。

自Beacon 2.1.0起，需要Xcode 12才能使用Beacon SDK进行构建。Beacon 2.0.x需要Xcode 11.4。

支持的平台和语言版本

• iOS 11至iOS 16
• Swift 5
• Xcode 12+

安装

CocoaPods

信标通过CocoaPods提供。要安装它，请将以下行添加到您的Podfile

pod 'Beacon'

由于信标目前以动态框架的形式分发，因此您的Podfile中也需要包含use_frameworks!标志。

Swift包管理器

信标通过Swift包管理器提供。要安装它，只需遵循Apple的指南将Beacon-iOS包依赖项添加到Xcode中。

Carthage🛑

从Beacon 2.1.0版本开始，信标（暂时）🤞)不再通过Carthage提供。这是因为信标现在以XCFramework形式分发，(截至2020年10月29日) Carthage不支持。有关Carthage团队所做工作的更多信息，可以在以下问题或以下拉请求1，2中找到。

版本2.0.2或更低的信标可以使用Carthage安装。在Cartfile中添加以下行，然后根据Carthage的安装说明进行操作。

github "helpscout/beacon-ios-sdk"

由于信标分发的方式，尝试在构建时使用--no-use-binaries标志将会失败。

手动

可以通过链接Beacon.xcframework来手动安装信标。要做到这一点，请从此处下载Beacon.xcframework.zip，并根据文档在Xcode项目中添加Beacon.xcframework。

附加设置

我们的开发者网站提供了有关如何配置应用程序以使用Beacon电子邮件附件和推送通知的信息。

示例应用程序

此存储库包含两个示例应用程序，一个用Objective-C编写，另一个用SwiftUI编写。

要运行Objective-C示例，您可以在Examples/Obj-C Example目录中cd cd Examples/Obj-C\ Example，打开Beacon Example.xcodeproj并运行BeaconExample方案。

要运行SwiftUI示例，您可以在Examples/SwiftUI Example目录中cd cd Examples/SwiftUI\ Example，打开Beacon SwiftUI Example.xcodeproj并运行Beacon SwiftUI Example方案。为了让它正常运行，您需要在SettingsView.swift的第10行提供一个有效的Beacon标识符。

文档

有关通过SDK提供的更多自定义选项，请参阅我们的开发者网站。

支持

如有问题或疑问，请联系Help Scout支持[email protected]