Appunfold iOS SDK 集成文档

本指南将向您提供有关如何在几分钟内将 SDK 集成的分步详细说明。以下步骤详细概述了集成过程。

将 SDK 集成到您的 Xcode - iOS 项目中的步骤

• 步骤 1：下载 appunfold 框架
• 步骤 2：将 appunfold 框架附加到您的 iOS 项目
• 步骤 3：启动 appunfold 框架

如果您使用 Cocoapods 或 Carthage，则跳过步骤 1 和步骤 2，直接跳转到步骤 3。

Cocoapods

添加

  pod 'Appunfold', '~> 1.0'

到您的 Podfile。
在终端中，转到您的项目文件夹，并输入 pod install。打开 <your-project-name.xcworkspace>。

Carthage

添加

  github "Appunfold/ios-sdk"

到您的 Cartfile。在终端中，转到您的项目文件夹，并输入 carthage update

步骤 1：下载 appunfold 框架

从此处下载 appunfold SDK。

或者您可以克隆 appunfold 的 GitHub 仓库

  git clone https://github.com/appunfold/ios-sdk

appunfold.framework 应复制到您的项目文件夹中。

步骤 2：将 appunfold 框架附加到您的 iOS 项目

• 在项目导航面板上单击 项目 文件夹。
• 在 目标和 下单击应用程序，然后转到如图所示的 通用 选项卡。
• 如图所示，在 捆绑的框架 下单击 + 按钮。
• 从出现的对话框中选择 添加其他...。
• 从项目文件夹中选择 appunfold.framework。
• 如果有对话框提示是否复制框架，请单击 是。

步骤 3：启动 appunfold 框架

• 在您的 AppDelegate 文件中，导入 appunfold 框架

  Swift

    import appunfold

  Objective-C

    #import <appunfold/appunfold.h>

• 在 didFinishLaunchingWithOptions: 方法中，使用以下 initMethod 启动 appunfold SDK

  Swift

    func application(_application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {
      //Override point for customization after application launch.
      AppunfoldSDK.sharedInstance().initWithAPIKey("<YOUR-API-KEY>")
    } 

  Objective-C

    -(BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
      // Override point for customization after application launch.
      [[AppunfoldSDK sharedInstance] initWithAPIKey:@"<YOUR-API_KEY>"];
    }

  注意 - 您可以从 appunfold 仪表板中应用程序的集成页面获取 API-KEY。

跟踪用户

您可以使用我们的工具跟踪用户的活跃情况。为此，您必须映射用户信息。此映射可以使用以下 API 完成

Swift

  AppunfoldSDK.sharedInstance().setUserWithId("<User-Id>", 
                                    username  : "<username>", 
                                        email : "<email>", 
                                andParameters : ["<param1>":"<value1>","<param2>":"<value2>"])

Objective C

  [[AppunfoldSDK sharedInstance] setUserWithId:@"<User-Id>"
                                      username:@"<Username>"
                                         email:@"<Email>"
                                 andParameters:@{@"<param1>":@"<value1>",@"<param2>":@"<value2>"}];

此 API 识别单个用户并将相应的分析数据映射到。除了 userid 之外的所有参数都是可选的。您可以在 API 中提供的字典参数中添加任意数量的参数。

请注意，在使用此 API 之前必须初始化 AppunfoldSDK。

高级

• 帮助中心可见性

  您可以使用以下 API 通过代码控制 AppunfoldSDK 帮助中心的可见性

  Swift

    AppunfoldSDK.sharedInstance().showHelpCenter()

  Objective C

    [[AppunfoldSDK sharedInstance] showHelpCenter];

• FAB 可见性

  要了解 FAB 按钮是否当前已启用，可以使用以下 API

  Swift

    let x = AppunfoldSDK.sharedInstance().isFABEnabled() 
    // x will be `true` if fab is enabled; `false` if not

  Objective C

    BOOL x = [[AppunfoldSDK sharedInstance] isFABEnabled];
    // x will be `YES` is fab is enabled; `NO` if not

  要启用/禁用 FAB，可以使用以下 API

  Swift

    AppunfoldSDK.sharedInstance().enableFAB(<true/false>)

  Objective C

    [[AppunfoldSDK sharedInstance] enableFAB:<YES/NO>];