Analytics Client iOS‌‌‌‌

Core iOS Client

设置

CocoaPods

1. 您需要安装CocoaPods。

2. 在您的项目中创建一个名为Podfile的文件，并添加以下行

   pod 'liferay-analytics-ios'  

3. 运行$ pod install。

4. 这将下载最新的SDK版本并创建一个.xcworkspace文件，使用该文件在Xcode中打开您的项目。

如何使用？

初始化库

您应该通过传递您的分析密钥来初始化库，建议在AppDelegate中的应用程序完成启动方法中添加该命令。如果您未初始化库，则可能会收到.analyticNotInitialized或.analyticAlreadyInitialized错误，如果库已被初始化。默认情况下，事件批量发送到云的刷新间隔为60秒。

参数

• analyticsKey: 字符串（必需）
• flushInterval: 整数（可选）

try Analytics.configure(analyticsKey: "YOUR_ANALYTICS_KEY", flushInterval: 50)

如何设置您的身份？

建议在用户登录时调用，必须绑定下一个事件为此用户。名称参数是可选的。

参数

• email: 字符串（必需）
• name: 字符串（可选）

Analytics.setIdentity(email: "user email", name: "user name")

如何清除身份？

建议在用户注销时调用，必须解绑之前用户的事件。

Analytics.clearSession()

如何发送自定义事件？

发送任何自定义事件的方式。

参数

• eventId: 字符串 (必需)
• applicationId: 字符串 (必需)
• properties: [String: String] (可选)。对于附加属性

Analytics.send(
            eventId: "PageView",
            applicationId: "MYSAMPLE",
            properties: ["custom1": "value 1",
                        "custom2": "value 2"]) 

表单插件

配置

CocoaPods

1. 您需要安装CocoaPods。

2. 在您的项目中创建一个名为Podfile的文件，并添加以下行

   pod 'liferay-analytics-forms-ios'  

3. 运行$ pod install。

4. 这将下载最新的SDK版本并创建一个.xcworkspace文件，使用该文件在Xcode中打开您的项目。

如何使用？

表单属性

这是一个结构体，用于具体化表单事件。

参数

• formId: 字符串 (必需)
• formTitle: 字符串 (可选)

let formAttributes = FormAttributes(formId: "10", formTitle: "People")

表单查看

发送表单查看事件的实现方法。

参数

• 属性：表单属性（必需）

Forms.formViewed(attributes: formAttributes)

表单提交

发送表单提交事件的实现方法。

参数

• 属性：表单属性（必需）

Forms.formSubmitted(attributes: formAttributes)

字段属性

这是一个结构体，用于记录字段事件。

参数

• 字段名：String（必需）
• 标题：String（可选）
• 表单属性：表单属性（必需）

let fieldNameAttributes = FieldAttributes(name: "nameField", title: "Name", formAttributes: formAttributes)

跟踪字段

跟踪字段的所有事件，如（聚焦和失焦）。

参数

• 字段：（UITextField 或 UITextView）（必需）
• 字段属性：字段属性（必需）

Forms.trackField(field: nameField, fieldAttributes: fieldNameAttributes)