JIRA Mobile Connect for iOS

JIRAMobileConnect 是一个 iOS 库，可以嵌入到任何 iOS 应用中，以提供

• 实时崩溃报告 使用户或测试人员可以直接将崩溃报告提交到您的 JIRA 实例
• 用户或测试人员反馈 视图，允许用户或测试人员在您的应用程序内创建错误报告。
• 富数据输入 用户可以附加和标注屏幕截图，留下语音消息，发送他们的位置
• 与用户双向通信 感谢您为应用提供反馈的用户或测试人员！

要求

• iOS 8.0+
• Xcode 7.0+
• JIRA On Demand 或安装了 JIRA Mobile Connect 插件 的 JIRA 实例

在分发软件之前，您必须将 JIRAMobileConnect/JMCClasses/LICENSES 文件的内容放在您应用程序的某个位置，以及您可以在本文件中找到的许可证信息。

安装

Carthage

"Carthage 旨在向 Cocoa 应用程序添加框架的最简单方法。"

# Add to Cartfile:
git "https://bitbucket.org/atlassian/jiraconnect-apple.git" >= 1.2.6

CocoaPods

"CocoaPods 是 Swift 和 Objective-C Cocoa 项目的依赖管理器。它包含超过一万个库，可以帮助您优雅地扩展项目。"

# Add to Podfile:
pod "JIRAMobileConnect", "1.2.6"

手动

说明即将推出。

配置（iOS）

将 JIRAMobileConnect 导入您的 UIApplicationDelegate

Swift

  import JIRAMobileConnect

Objective-C

  @import JIRAMobileConnect

配置 JMC 共享实例

添加以下源代码并

1. 将字符串 @"https://connect.onjira.com" 替换为您想连接到的 JIRA 实例的位置。注意：我们强烈建议您使用 https（而不是 http）以确保 JMC 与用户之间的安全通信。
2. 将字符串 @"NERDS" 替换为您想用于收集用户或测试人员反馈的项目名称
3. 如果 JIRA 中的 JIRA Mobile Connect 插件启用了 API 密钥，请更新上述 apiKey 参数为您的项目密钥

Swift

func application(application: UIApplication,
  didFinishLaunchingWithOptions launchOptions: [NSObject: AnyObject]?) -> Bool {

    JMC.sharedInstance().configureJiraConnect("https://connect.onjira.com/",
      projectKey: "NERDS", apiKey: "591451a6-bc59-4ca9-8840-b67f8c1e440f")

    return true
}

Objective-C

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {

    [[JMC sharedInstance]
     configureJiraConnect:@"https://connect.onjira.com/"
     projectKey:@"NERDS"
     apiKey:@"591451a6-bc59-4ca9-8840-b67f8c1e440f"];

     return YES;
}

配置（JIRA）

上述配置的URL，JIRA实例需要具备以下功能

1. 安装JIRA Mobile Connect 插件

2. 为你的项目启用JIRA Mobile Connect

   ‘管理项目’ --> 你的项目 --> 设置 --> JIRA Mobile Connect

   

3. 授予 jiraconnectuser ‘创建问题’ 的权限。启用JIRA Mobile Connect插件将为项目自动创建一个用户，该用户将用于创建所有反馈和崩溃报告。此用户必须拥有你所启用的项目中‘创建问题’的权限。换句话说，jiraconnectuser必须在组、项目角色中或者明确添加到项目的权限方案中‘创建问题’的权限。更多信息请参见行政 --> --> 权限

高级配置

如果默认设置不符合你的要求，你可以选择其他一些配置选项。为此，请探索[JMC sharedInstance] configureXXX]方法。

JMCOptions JMCOptions支持大多数高级设置。当调用configure时，此对象将被传递给JMC -- 即在applicationDidFinishLaunching期间。

JMCOptions允许配置

• 截图
• 语音录音
• 定位跟踪
• 崩溃报告
• 自定义字段
• 应用的Console Log（NSLog输出）
• JMC视图的UIBarStyle
• JIRA项目密钥
• JIRA实例URL
• API密钥

参见JMC.h了解所有可用的JMCOptions。

JMCCustomDataSource JMCCustomDataSource可用于在运行时为JIRA提供额外数据。以下设置得到了支持

• 附加额外的附件（例如数据库文件）
• 自定义字段（如果JIRA项目中存在同名的自定义字段，则通过键名映射）
• 要设置的问题组件（例如iOS）
• JIRA问题类型（将问题类型的名称映射到JIRA中要使用的问题类型。例如，崩溃 --> 缺陷，反馈 --> 改进）
• notifierStartFrame（notifierEndFrame:用于控制通知器的动画起始和结束位置）

更多信息请参见JMCCustomDataSource.h。

用法

触发器

提供一个触发机制，允许用户打开反馈视图。这通常在‘关于’或‘信息’视图中进行。（或者，如果你有多创意：可以像示例Angry Nerds应用中那样将其添加到摇动手势中！）

例如

- (IBAction)triggerCreateIssueView
{
    [self presentModalViewController:[[JMC sharedInstance] viewController] animated:YES];
}

JMC共享实例的视图控制器返回的由viewController返回。这个视图控制器旨在以模态方式展示。[[JMC sharedInstance] viewController]将返回创建问题的视图，直到用户创建反馈。从那时起，将显示问题收件箱视图，用户可以从中点击创建图标发送更多反馈。

如果您的信息视图控制器位于UINavigationController栈中，那么您可以使用以下代码片段来展示反馈视图和历史视图。

如果您希望您的用户始终可以访问创建问题的视图，那么您可以通过直接展示[[JMC sharedInstance] feedbackViewController]来实现。例如，以下代码将程序性地展示创建问题的ViewController

- (IBAction)triggerCreateIssueView
{
    [self presentModalViewController:[[JMC sharedInstance] feedbackViewController] animated:YES];
}

使用[[JMC sharedInstance] issuesViewController]可以直接展示收件箱。

测试 & 调试

测试崩溃报告

您可以通过在代码中添加CFRelease(NULL);语句来测试崩溃报告。

调试

如果您希望在控制台中启用 JMC 调试日志记录，请在您的构建目标中定义预处理宏 JMC_DEBUG=1。在 Xcode 中：目标 --> 预处理宏 --> 调试 --> + --> JMC_DEBUG=1。

备注

集成备注

收到通知时向上滑动显示的通知视图被添加到应用程序的 keyWindow 中。

示例应用

（这些尚未更新。）

在 jiraconnect-apple/samples 目录中有一个演示提交反馈和崩溃到NERDS公共项目的示例 iPhone 和 iPad 应用。AngryNerds 和 AngryNerds4iPad 都演示了如何提交反馈和崩溃。

JIRA 插件

您需要访问安装了JIRA Mobile Connect 插件的 JIRA 实例。如果您还没有访问 JIRA 实例的权限，可以使用http://connect.onjira.com上的 NERDS 项目进行测试。

问题跟踪

使用http://connect.onjira.com/browse/CONNECT提交任何关于 JIRA Mobile Connect 库的问题。

关于

需要帮助？

如果您有任何关于 JIRA Mobile Connect 的问题，请访问Atlassian Answers。

贡献者

• Nick Pellow @niick
• Thomas Dohmke @ashtom
• Stefan Saasen @stefansaasen
• Shihab Hamid @shihabhamid
• Erik Romijn @erikpub
• Bindu Wavell @binduwavell
• Theodora Tse
• René Cacheaux @rcachATX

许可证

版权所有 2011-2015 Atlassian Software。

遵循 Apache License 2.0 许可协议（以下简称“许可协议”）；您只能按照许可协议使用这些文件。您可以在https://apache.ac.cn/licenses/LICENSE-2.0获得许可协议副本。

除非适用法律要求或经书面同意，否则在许可协议下分发的软件按照“现状”分发，不提供任何形式的明示或暗示保证。有关许可协议的管理权限和限制，请参阅许可协议的具体语言。

第三方包 - 许可证 - 版权 / 创建者

plcrashreporter MIT 版权 (c) 2008-2009 Plausible Labs Cooperative, Inc.

crash-reporter 版权 (c) 2009 Andreas Linde & Kent Sutherland.

UIImageCategories 由 Trevor Harmon 创建。

FMDB MIT 版权 (c) 2008 Flying Meat Inc.