简介

Glazum 是一个简单有效的工具，用于收集您的 iOS 用户反馈。在任何您希望的时刻向他们提出任何您想了解的问题！

只需创建新问题，将其与您的应用中的一个标记绑定，并决定谁和何时可以看到它。所有答案都会自动收集和处理。您可以在仪表板页面上实时查看和管理它们。

您可以在 GitHub 上看到一个 Glazum API 使用的示例

注意事项

SDK 收集的信息会实时发送到 Glazum 网站。

Glazum SDK 与 iOS 6+、armv7+armv7s 和 arm64 兼容，支持设备和模拟器，已使用 Xcode 5.x 进行测试。

集成

创建 Podfile

在名为 Podfile 的文件中指定了由 CocoaPods 管理的项目依赖项。在每个 .xcodeproj 文件相同的目录下创建此文件。

$ edit Podfile
pod 'Glazum', '~> 0.3'`

安装依赖项

现在您可以在项目中安装依赖项：$ pod install

从此以后，在构建项目时，请确保始终打开生成的 Xcode 工作区文件 (.xcworkspace) 而不是项目文件：$ open YourProject.xcworkspace

手动集成

1. 将 Glazum.framework 文件添加到您的项目中：文件 -> 添加到 " "
   1. 找到并选择包含 SDK 的文件夹
   2. 确保"在需要时将项目复制到目标文件夹"被选中
   3. 设置文件夹为"为任何添加的文件夹创建分组"
   4. 选择您想要添加 SDK 的所有目标
2. 确保 Glazum.framework 已添加到您希望使用的 SDK 的 Link Binary With Libraries 构建阶段
   
   1. 在项目导航器中选择您的项目
   2. 选择您想要启用 SDK 的目标
   3. 选择构建阶段标签
   4. 打开 Link Binary With Libraries 阶段
   5. 如果 Glazum.framework 未列出，将您的 Project Navigator 中的库拖放到 Link Binary With Libraries 区域
   6. 重复步骤 2-5，直到所有您想要使用的 SDK 都已链接
3. 将 CoreGraphics.framework 添加到 Link Binary With Libraries 建筑阶段
   1. 在项目导航器中选择您的项目
   2. 选择您想要启用 SDK 的目标
   3. 选择构建阶段标签
   4. 打开 Link Binary With Libraries 阶段
   5. 如果 CoreGraphics.framework 未列出，点击+以添加新库
   6. 在列表中找到 CoreGraphics.framework 并添加它
   7. 重复步骤 2 - 6，直到你想使用 SDK 的所有目标都具有 CoreGraphics.framework

4. 在你的应用程序代理中

   1. 导入 Glazum: #import <Glazum/Glazum.h>

      注意： 而不是在每个文件中导入 Glazum/Glazum.h，你可以将上述行添加到项目内部的预编译头文件（<projectname>_Prefix.pch）中。这将使你能够在所有文件中访问 SDK。

      #ifdef __OBJC__ 
      

      部分。这将为您访问所有文件提供权限。

   2. 获取您的应用程序 IPD，您可以在 Glazum 仪表板找到

   3. 使用您的应用程序 ID 启动 Glazum

      • (BOOL) application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
        // ... [Glazum startUp:@"YOUR-APP-IDENTIFIER"]; // ... }

设置标记

将命名标记放置在您的代码中任何需要的位置。稍后您将把问题绑定到这些标记上。

[Glazum setMarker:@"button pressed"];

代码中的标记表示 Glazum 被允许显示问题的位置。请注意，这并不意味着每次执行标记代码时都会显示问题。Glazum 允许您设置显示问题给用户所需的一系列条件。只有当所有这些条件都满足时，才会显示问题。

设置标记是单次操作。您不需要对您的应用程序代码进行任何更改来添加/编辑或打开/关闭问题。我们的建议是尽可能多地设置标记。

请注意，有两个系统标记：app 启动和 app 进入前台。因此，不需要手动设置这些事件的标记。

问题预览

如果您想知道问题在您的应用程序中看起来怎么样，只需使用

[Glazum testQuestionWithType:kQuestionWithSingleLineTextAnswer];

其中 kQuestionWithSingleLineTextAnswer 是五种可用问题类型之一

typedef enum {
    kQuestionWithSingleLineTextAnswer,
    kQuestionWithMultiLineTextAnswer,
    kQuestionWithSingleAnswerSelection,
    kQuestionWithMultipleAnswerSelection,
    kQuestionWithNetPromoterScore
}GlazumQuestionType;

显示前后的回调

您可以指定在问题显示前后被调用的代码块。

doBefore 块带有一个布尔参数 willShowQuestion。当它为 true 时，问题将在此块执行后立即被询问。doAfter 块带有一个参数 questionWasShown。如果 questionWasShown 为 true，则实际上展示了问题。

使用 doBefore/doAfter 可能很有用，可以为显示问题准备您的应用程序，并在问题显示后恢复其之前的状态。

[Glazum setMarker:@"button pressed"
       doBefore:^(BOOL willShowQuestion) {
        //prepare application for the question to be asked
}
        doAfter:^(BOOL questionWasShown) {
        //cleanup everything and restore previous state
}];

请注意，您可以为 doBefore 或 doAfter 传递 nil。

[Glazum setMarker:@"button pressed"
       doBefore:nil
        doAfter:^(BOOL questionWasShown) {
        //cleanup everything and resume your app
}];

识别您的应用程序用户

如果您的应用程序以某种方式识别用户，您也可以使用 Glazum 进行识别。例如，要使用电子邮件（验证）识别用户，只需调用

[Glazum setUserIdentifier:@"[email protected]"];

当 Glazum:setUserIdentifier 被调用时，用户标识值将被永久存储并应用于之后执行的所有标记。要删除用户标识（例如注销用户），只需调用 setUserIdentifier 并传递 nil 参数

[Glazum setUserIdentifier:nil];

设置附加属性

除了识别您的应用程序用户外，您还可以根据自定义变量设置显示问题标准。要使用自定义变量，只需调用

[Glazum setCustomVariable:@"true" named:@"ab test share"];

值将被永久存储。要删除它，调用 setCustomVariable 并传递 nil 变量参数

[Glazum setCustomVariable:nil named:@"ab test share"];

设置 Glazum 选项

GlazumOptionDebug

如果您需要在控制台中的 Glazum 日志消息，只需设置 GlazumOptionDebug 选项如下

[Glazum setOptions:@{GlazumOptionDebug:@YES}];

GlazumOptionDebugLogHandler

如果您有自己的自定义日志记录器，您可以设置自定义块以接收所有调试消息

[Glazum setOptions:@{GlazumOptionDebugLogHandler:^(NSString *message) {
            //your custom debug logger logic
        }
}];