/HockeySDK-iOS

The official iOS SDK for the HockeyApp service

Primary LanguageObjective-COtherNOASSERTION

Introduction

HockeySDK-iOS implements support for using HockeyApp in your iOS applications.

The following features are currently supported:

  1. Update apps: The app will check with HockeyApp if a new version is available. If yes, it will show an alert view to the user and let him see the release notes, the version history and start the installation process right away.

  2. Collect crash reports: If you app crashes, a crash log with the same format as from the Apple Crash Reporter is written to the device's storage. If the user starts the app again, he is asked to submit the crash report to HockeyApp. This works for both beta and live apps, i.e. those submitted to the App Store!

The main SDK class is BITHockeyManager. It initializes all modules and provides access to them, so they can be further adjusted if required. Additionally all modules provide their own protocols.

Prerequisites

  1. Before you integrate HockeySDK into your own app, you should add the app to HockeyApp if you haven't already. Read this how-to on how to do it.
  2. We also assume that you already have a project in Xcode and that this project is opened in Xcode 4.
  3. The SDK supports iOS 4.0 or newer.

Installation & Setup

Xcode Documentation

This documentation provides integrated help in Xcode for all public APIs and a set of additional tutorials and HowTos.

  1. Download the latest HockeySDK-iOS documentation.

  2. Unzip the file. A new folder HockeySDK-iOS-documentation is created.

  3. Copy the content into ~/Library/Developer/Shared/Documentation/DocSet

Changelog

Version 2.5.1

  • General:

    • [BUGFIX] Typo in delegate shouldUseLiveIdentifier of BITHockeyManagerDelegate
    • [BUGFIX] Default updateManager delegate wasn't set

  • Crash Reporting:

    • [BUGFIX] Crash when developer sends the notification BITHockeyNetworkDidBecomeReachableNotification

Version 2.5.0

  • General:

    • [NEW] Unified SDK for accessing HockeyApp on iOS

      • Requires iOS 4.0 or newer

      • Replaces the previous separate SDKs for iOS: HockeyKit and QuincyKit.

        The previous SDKs are still available and are still working. But future HockeyApp features will only be integrated in this new unified SDK.

      • Integration either as framework or Xcode subproject using the sourcecode

        Check out Installation & Setup

    • [NEW] Cleaned up public interfaces and internal processing all across the SDK

    • [NEW] AppleDoc based documentation and HowTos

      This allows the documentation to be generated into HTML or DocSet.

  • Crash Reporting:

    • [NEW] Workflow to handle crashes that happen on startup.

      Check out How to handle crashes on startup for more details.

    • [NEW] Symbolicate iOS calls async-safe on the device

    • [NEW] Single property/option to deactivate, require user to agree submitting and autosubmit

      E.g. implement a settings screen with the three options and set [BITCrashManager crashManagerStatus] to the desired user value.

    • [UPDATED] Updated PLCrashReporter with updates and bugfixes (source available on GitHub)

    • [REMOVED] Feedback for Crash Groups Status

      Please keep using QuincyKit for now if you want this feature. This feature needs to be redesigned on SDK and server side to be more efficient and easier to use.

  • Updating:

    • [NEW] Expire beta versions with a given date

    • [REMOVED] Settings screen

      If you want users to be able not to send analytics data, implement the [BITUpdateManagerDelegate updateManagerShouldSendUsageData:] delegate and return the value depending on what the user defines in your settings UI.