BrytescoreObjcAPI 1.4.0

BrytescoreObjcAPI 1.4.0

×

由 Emily Morehouse-Valcarcel 维护。

BrytescoreObjcAPI 1.4.0

  • 作者：
  • emilyemorehouse

Lead Booster Analytics

brytescore-objc

brytescore-objc 是一个开源的 iOS SDK，它可以将您的网站与 Brytescore API 连接起来。Brytescore API 允许您跟踪用户的行为并评估他们的参与度。

示例

要运行示例项目，先克隆仓库，然后从 Example 目录中第一个运行 pod install。

安装

brytescore-objc 通过 CocoaPods 提供。要安装它，只需将以下行添加到您的 Podfile 中

    use_frameworks!
    pod "BrytescoreObjcAPI"

导入 BrytescoreAPI

在您的 .h 文件中导入 brytescore-objc。

Objective-C

    @import BrytescoreObjcAPI;

方法

初始化

设置API密钥。生成新的唯一会话ID。如果有的话，检索保存的用户ID。

  • 参数 {string} API密钥。

Objective-C

    BrytescoreAPIManager *apiManager = [[BrytescoreAPIManager alloc] initWithApiKey: @"<api-key>"];

getAPIKey

返回当前API密钥

  • 返回值：当前API密钥

Objective-C

    [apiManager getAPIKey];

load

用于加载JSON包的函数。

  • 参数 {string} 包名。

Objective-C

    [apiManager load:@"realestate"];

devMode

设置开发模式。将事件记录到控制台，而不是发送到API。开启开发模式将自动触发调试模式。

  • 参数 enabled：如果为true，则启用开发模式。

Objective-C

    [apiManager devMode:enabled];

debugMode

设置调试模式。当关闭调试模式时，将抑制日志事件的记录。

  • 参数 enabled：如果为true，则启用调试模式。

Objective-C

    [apiManager debugMode:enabled];

impersonationMode

设置化身模式。在大 Converted from impersonation 模式下，将跳过向API发送信息。

  • 参数 enabled：如果为true，则启用化身模式。

Objective-C

    [apiManager impersonationModeWithEnabled: enabled];

验证模式

设置验证模式。为所有API调用添加验证属性。

  • 参数 enabled：如果为真，则启用验证模式。

Objective-C

    [apiManager validationMode:enabled];

brytescore

开始跟踪一个针对已加载包的特定属性。

  • 参数 property：属性名
  • 参数 data：属性跟踪数据

Objective-C

    [apiManager brytescore:propertyName withData:data];

pageView

开始 pageView。

  • 参数 data：pageView 数据。
  • data.isImpersonating
  • data.pageUrl
  • data.pageTitle
  • data.referrer

Objective-C

    [apiManager pageView:data];

registeredAccount

发送一个新账户注册事件。

  • 参数数据：注册数据。
  • data.isImpersonating
  • data.userAccount.id

Objective-C

    [apiManager registeredAccount:data];

submittedForm

发送 submittedForm 事件。

  • 参数数据：聊天数据。
  • data.isImpersonating

Objective-C

    [apiManager submittedForm:data];

startedChat

发送 startedChat 事件。

  • 参数数据：表单数据。
  • data.isImpersonating

Objective-C

    [apiManager startedChat:data];

updatedUserInfo

更新用户的账户信息。

  • 参数数据：账户数据。

Objective-C

    [apiManager updatedUserInfo:data];

已认证

发送用户认证事件。

  • 参数数据：认证数据。
  • data.isImpersonating
  • data.userAccount
  • data.userAccount.id

Objective-C

    [apiManager authenticated:data];

killSession

终止会话。

Objective-C

    [apiManager killSession];