Close Menu

hockeysdk




Welcome to the documentation for HockeySDK! This guide will provide you with all the necessary information to integrate HockeySDK into your iOS or macOS app. HockeySDK is a powerful framework that allows you to leverage the HockeyApp service for various app management tasks such as crash reporting, user feedback, and in-app updates.




Before you can start using HockeySDK, you need to follow these steps:

1. Sign up for a HockeyApp account at [https://www.hockeyapp.net/](https://www.hockeyapp.net/).
2. Create a new app project in HockeyApp and obtain your App ID.
3. Install HockeySDK in your Xcode project.




To install HockeySDK, follow these steps:

1. Open your Xcode project.
2. Navigate to your project’s _Podfile_ and add the following line:
“`ruby
pod ‘HockeySDK’
“`
3. Run the command `pod install` in your terminal to install the HockeySDK dependency.
4. Open your app’s main target, select the `Build Settings` tab, and search for `Other Linker Flags`.
5. Add the flag `-ObjC` to ensure proper linking of the HockeySDK frameworks.
6. Import the HockeySDK framework in your AppDelegate file:
“`swift
import HockeySDK
“`
7. Initialize HockeySDK with your App ID in the `application(_:didFinishLaunchingWithOptions:)` method:
“`swift
BITHockeyManager.shared().configure(withIdentifier: “YOUR_APP_ID”)
BITHockeyManager.shared().start()
BITHockeyManager.shared().authenticator.authenticateInstallation()
“`




Once HockeySDK is successfully integrated into your project, you gain access to various features and functionalities:




#### Crash Reporting

HockeySDK provides robust crash reporting capabilities that enable you to easily gather crash reports from your users. The reports are automatically symbolicated, making it easier to identify and fix bugs. To enable crash reporting, simply follow these steps:

1. Enable crash reporting in HockeyApp by navigating to your app project and selecting `Manage App`.
2. Enable crash reports collection in your AppDelegate file:
“`swift
BITHockeyManager.shared().crashManager.crashManagerStatus = .autoSend
“`
3. You can also customize the behavior of the crash manager. Refer to the HockeySDK documentation for more information.




#### User Feedback

With HockeySDK, you can receive valuable feedback from your app users. This feedback can include bug reports, suggestions, or general comments. To integrate user feedback into your app, use the following steps:

1. Enable user feedback in HockeyApp by navigating to your app project and selecting `Manage App`.
2. Customize the feedback UI appearance using the provided methods in HockeySDK.
3. Implement the necessary code to collect and process user feedback.




#### In-App Updates

HockeySDK allows you to deliver in-app updates to your users without requiring them to download a new version from the App Store. Follow these steps to enable in-app updates:

1. Enable in-app updates in HockeyApp by navigating to your app project and selecting `Manage App`.
2. Customize the update behavior using the provided methods in HockeySDK. You can specify update frequency, force updates, or other relevant settings.




#### Resources

To further explore HockeySDK and its capabilities, refer to the following resources:

– [HockeySDK GitHub Repository](https://github.com/bitstadium/HockeySDK-iOS)
– [HockeyApp Documentation](https://support.hockeyapp.net/)




Congratulations! You’ve successfully integrated HockeySDK into your app. This documentation should provide you with enough information to get started with crash reporting, user feedback, and in-app updates. If you encounter any difficulties, make sure to consult the official HockeySDK documentation or reach out to the HockeyApp support team for assistance.