Close Menu

hockeysdk-mac

HockeySDK is a powerful framework that simplifies the process of integrating HockeyApp into your macOS applications. By using HockeySDK, you can effortlessly distribute your application for beta testing, collect crash reports, and even get feedback from your users. This comprehensive guide will walk you through the step-by-step process of integrating and utilizing HockeySDK in your applications.

Getting Started

To get started with HockeySDK, follow the steps below:

  1. Start by signing up for a HockeyApp account at https://www.hockeyapp.net/. It’s free to create an account, and you’ll need it to access the necessary resources.
  2. Once you have an account, log in and create a new app to represent your macOS application. Make sure to specify the required details such as bundle identifier, version, and team.
  3. Next, navigate to the documentation section of HockeyApp and select the “macOS” category. This page contains all the information you need to integrate HockeySDK into your application and utilize its features.

Installing HockeySDK

Before diving into the integration process, you’ll need to install HockeySDK in your application. Follow these steps:

  1. Open Xcode and navigate to your project.
  2. Select your project in the project navigator, then choose the target for your macOS application.
  3. Go to the “General” tab and scroll down to the “Frameworks, Libraries, and Embedded Content” section.
  4. Click the “+” button and search for “HockeySDK-mac”. Select it from the search results.
  5. Make sure to set the “Type” to “Framework” in the dropdown menu next to HockeySDK-mac.
  6. Finally, click “Finish” to complete the installation.

Configuring HockeySDK

Once HockeySDK is installed, you need to configure it properly. Do the following:

  1. Open your application’s AppDelegate.swift file.
  2. Add the following import statement at the top of the file to import HockeySDK:

“`swift
import HockeySDK
“`

  1. In your AppDelegate.swift file’s `applicationDidFinishLaunching(_:)` method, insert the following code to configure HockeySDK:

“`swift
BITHockeyManager.shared().configure(withIdentifier: “YOUR_APP_IDENTIFIER”)
BITHockeyManager.shared().start()
BITHockeyManager.shared().authenticator.authenticateInstallation()
“`

Integrating HockeySDK Features

HockeySDK provides various features that you can integrate into your application:

Collecting Crash Reports

To collect crash reports using HockeySDK, follow these steps:

  1. Ensure that you have properly configured HockeySDK as mentioned in the previous section.
  2. In your AppDelegate.swift file, locate the `applicationDidFinishLaunching(_:)` method.
  3. Add the following code to enable HockeySDK crash reporting:

“`swift
BITHockeyManager.shared().crashManager.crashManagerStatus = .autoSend
“`

Distributing Beta Versions

If you want to distribute beta versions of your application to external testers, HockeySDK has got you covered:

  1. Ensure that you have completed the initial configuration of HockeySDK.
  2. Navigate to your HockeyApp account.
  3. Upload the latest build of your application by following the provided instructions on HockeyApp’s web interface.
  4. Once the build is uploaded, you can invite testers, create distribution groups, and manage the distribution process for your beta versions.

Gathering User Feedback

If you want to gather feedback from your users, HockeySDK offers a simple way to accomplish this:

  1. Once again, ensure that you have properly configured HockeySDK.
  2. In your application, create a feedback button or implement a gesture to trigger the feedback form UI.
  3. When the button or gesture is triggered, call the following function:

“`swift
BITHockeyManager.shared().feedbackManager.showFeedbackListView()
“`

Conclusion

Congratulations! You now have the knowledge to integrate and utilize HockeySDK in your macOS applications. With the ability to distribute beta builds, collect crash reports, and gather user feedback, you can enhance the overall stability and user experience of your applications. Happy coding!