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

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

• 步骤 1 : 下载 UserIQ 框架
• 步骤 2 : 将 UserIQ 框架附加到您的 iOS 项目
• 步骤 3 : 初始化 UserIQ 框架
• 步骤 4 : 登录后设置用户
• 步骤 5 : 添加自定义参数（可选）
• 步骤 6 : 登出

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

Cocoapods

添加

  pod 'UserIQ', '~> 2.9'

到您的 Podfile。在终端中，转到您的项目文件夹，输入 pod install。打开 <你的项目名称> .xcworkspace

Carthage

添加

  github "useriq-com/ios-sdk"

将Carthage添加到您的Cartfile中。在终端中，进入您的项目文件夹并输入 carthage update

步骤 1: 下载UserIQ框架

从这里下载UserIQ SDK

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

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

将UserIQ.framework复制到您的项目文件夹中。

步骤 2: 将UserIQ框架附加到您的iOS项目中

• 在项目导航面板上单击项目文件夹。
• 单击 Targets下的应用程序，然后进入如下所示的 General选项卡。
• 单击如下所示的 Embedded Binaries下的 +按钮。
• 从出现的对话框中选择 Add Other。
• 从项目文件夹中选择 UserIQ.framework。
• 如果出现提示框询问是否复制框架，请单击"Yes。

步骤 3: 初始化UserIQ框架

• 在AppDelegate文件中导入UserIQ框架

  Swift

    import UserIQ

  Objective-C

    #import <UserIQ/UserIQ.h>

• 在didFinishLaunchingWithOptions:方法中，根据下面的示例使用initMethod初始化UserIQ SDK

  Swift

    func application(_application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {
      UserIQSDK.sharedInstance().initWithAPIKey("<YOUR-API-KEY>")
    }

  Objective-C

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

  注意 - 您可以从UserIQ仪表板的集成页面获取API-KEY。

  此API将以匿名用户初始化SDK。

步骤 4: 登录后设置用户

• 一旦用户登录，匿名用户可以使用下面所示的setUser API更改为当前用户。在接收用户信息的文件中导入UserIQ SDK（类似于上一步）。

  Swift

    UserIQSDK.sharedInstance().setUserId("EMP124",
                                      name: "Alex",
                                      email: "[email protected]",
                                      accountId: "1",
                                      accountName: "Acme Corp",
                                      signupDate: "2017-11-29",
                                      andParameters: ["location":"Atlanta"])

  Objective-C

    [[UserIQSDK sharedInstance] setUserId:@"EMP124"
                                     name:@"Alex"
                                    email:@"[email protected]"
                                accountId:@"1"
                              accountName:@"Acme Corp"
                               signupDate:@"2017-11-29"
                            andParameters:@{@"location":@"Atlanta"}];

  注意 - 确保如果应用程序一直保持用户登录状态直至用户手动登出，则在启动应用程序时调用此API。

第5步：添加自定义参数（可选）

• 在andParameters(String key, String value)中添加用户的任何自定义属性。

  Swift

     andParameters: ["location":"Atlanta", "Foo":"Bar", "Foo1": "Bar1"]

  Objective-C

     andParameters:@{@"location":@"Atlanta", @"Foo":@"Bar", @"Foo1":@"Bar1"}

第6步：登出

• 如果用户登出，可以通过调用logout API将用户重置为匿名用户。确保在用户登出时调用此方法，以防止登录屏幕跟踪和其他与用户无关的信息与用户关联。

  Swift

    UserIQSDK.sharedInstance().logout()

  Objective-C

    [[UserIQSDK sharedInstance] logout];

API & 使用

有关API及其使用的更多详细信息，请参阅wiki页面