diff --git a/README.md b/README.md index 0f67eff..4f037a7 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,10 @@ -# HockeySDK for Xamarin +## Version 4.1.5 -## Version 4.1.4 -- Please have a look at the [Changelog](https://github.com/bitstadium/HockeySDK-Xamarin/releases). -- The Xamarin SDK wrapps our native SDKs, [HockeySDK-iOS 4.1.5](https://github.com/bitstadium/HockeySDK-iOS/releases/tag/4.1.5) and [HockeySDK-Android 4.1.4](https://github.com/bitstadium/HockeySDK-Android/releases/tag/4.1.4). - -- **If you are targeting iOS:** The HockeyApp Xamarin SDK includes the full version of the native HockeySDKs with all features. For iOS, this means that you must include the key `NSPhotoLibraryUsageDescription` in your app's `Info.plist` file - otherwise you risk an App Store rejection. Please read up on our blog on the [reason behind this change](https://www.hockeyapp.net/blog/2016/09/13/hockeysdk-ios-4-1-1-macos-tvos-4-1-0.html). This does not apply to the iOS CrashOnly variant of SDK, as this is not including the feedback feature. - -## Introduction HockeySDK-Xamarin implements support for HockeyApp in your iOS and Android applications. -Please have a look at the native platform SDKs [HockeySDK-iOS](https://github.com/bitstadium/HockeySDK-iOS) and [HockeySDK-Android](https://github.com/bitstadium/HockeySDK-Android) for advanced platform-specific behaviors. The following features are currently supported: -1. **Collect crash reports:** If your app crashes, a crash log is written to the device's storage. If the user starts the app again, they will be asked asked to submit the crash report to HockeyApp. This works for both beta and live apps, i.e. those submitted to the App Store. Crash logs contain viable information for you to help resolve the issue. Furthermore, you as a developer can add additional information to the report as well. +1. **Collect crash reports:** If your app crashes, a crash log is written to the device's storage. If the user starts the app again, they will be asked to submit the crash report to HockeyApp. This works for both beta and live apps, i.e. those submitted to the App Store. Crash logs contain viable information for you to help resolve the issue. Furthermore, you as a developer can add additional information to the report as well. 2. **User Metrics:** Understand user behavior to improve your app. Track usage through daily and monthly active users. Monitor crash impacted users. Measure customer engagement through session count. You can also track custom events and view the aggregate results on the HockeyApp dashboard. On Android, this feature requires a minimum API level of 14 (Android 4.x Ice Cream Sandwich). @@ -24,513 +16,33 @@ The following features are currently supported: 6. **Authenticate:** To help you stay in control of closed tester groups, you can identify and authenticate users against your registered testers with the HockeyApp backend. The authentication feature supports several ways of authentication. -This document contains the following sections: - -1. [Requirements](#requirements) -2. [Setup](#setup) - 1. [Obtain an App Identifier](#app-identifier) - 2. [Integrate HockeySDK](#integrate-sdk) - 3. [Add crash reporting](#crash-reporting) - 4. [Add user metrics](#user-metrics) - 5. [Add custom events](#custom-events) - 6. [Add Update Distribution](#updated-distribution) - 7. [Add in-app feedback](#feedback) - 8. [Add authentication](#authentication) -3. [Advanced setup](#advanced-setup) - 1. [Adding App ID to manifest (Android-Only)](#appid-manifest) - 2. [Permissions (Android-Only)](#permissions) - 3. [Control output to LogCat](#logcat-output) - 4. [Xamarin.Forms Project Integrate HockeySDK](#forms-integrate-sdk) -4. [Documentation](#documentation) -5. [Troubleshooting](#troubleshooting) -6. [Contributing](#contributing) - 1. [Code of Conduct](#codeofconduct) - 2. [Contributor license](#contributor-license) -7. [Contact](#contact) - - - -## 1. Requirements - -1. We assume that you have a project in Xamarin Studio or Xamarin for Visual Studio. -2. We assume you are not using other crash-analytic services on the same mobile application simultaneously. - -Currently, the following platforms are supported: - - - Xamarin.iOS - - Xamarin.Android - - - -## 2. Setup - - -### 2.1 Obtain an App Identifier - -Please see the "[How to create a new app](http://support.hockeyapp.net/kb/about-general-faq/how-to-create-a-new-app)" tutorial. This will provide you with an HockeyApp specific App Identifier to be used to initialize the SDK. - - -### 2.2 Integrate the SDK -For each iOS and Android project desired, add the HockeySDK-Xamarin nuget package. - -#### For Xamarin Studio -1. Navigate to `Project -> Add NuGet Packages...` -2. Search for `HockeySDK.Xamarin` - -#### For Xamarin for Visual Studio -1. Navigate `Project -> Manage NuGet Packages...` -2. Search `HockeySDK.Xamarin` - - -### 2.3 Add crash reporting -This will add crash reporting capabilities to your app. Advanced ways to configure crash reporting are covered in advanced setup: [iOS](https://github.com/bitstadium/HockeySDK-iOS#advancedsetup) | [Android](https://github.com/bitstadium/HockeySDK-Android#advancedsetup) - -#### For iOS -1. Open your `AppDelegate.cs` file. -2. Add the following lines: - -```csharp -using HockeyApp.iOS; - -namespace YourNameSpace { - - [Register("AppDelegate")] - public partial class AppDelegate : UIApplicationDelegate { - - public override bool FinishedLaunching(UIApplication application, NSDictionary launchOptions) { - var manager = BITHockeyManager.SharedHockeyManager; - manager.Configure("$Your_App_Id"); - manager.StartManager(); - manager.Authenticator.AuthenticateInstallation(); // This line is obsolete in crash only builds - } - } -} -``` - -Please make sure to replace `$Your_App_Id` with the app identifier of your app, otherwise it will not work. - -#### For Android -1. Open your `MainActivity.cs` file. -2. Add the following lines: - -```csharp -using HockeyApp.Android; - -namespace YourNameSpace { - - [Activity(Label = "Your.App", MainLauncher = true, Icon = "@mipmap/icon")] - public class MainActivity : Activity { - protected override void OnResume () - { - base.OnResume (); - CrashManager.Register(this, HOCKEYAPP_APPID); - } - } -} -``` - -Please make sure to replace `$Your_App_Id` with the app identifier of your app, otherwise it will not work. - -When the app is resumed, the crash manager is triggered and checks if a new crash was created in a previous session. If yes, it presents a dialog to ask the user whether they want to send the crash log to HockeyApp. On app launch the crash manager registers a new exception handler to recognize app crashes. - - -### 2.4 Add user metrics -HockeyApp automatically provides you with nice, intelligible, and informative metrics about how your app is used and by whom. - -- **Sessions**: A new session is tracked by the SDK whenever the containing app is restarted (this refers to a 'cold start', i.e. when the app has not already been in memory prior to being launched) or whenever it becomes active again after having been in the background for 20 seconds or more. -- **Users**: The SDK anonymously tracks the users of your app by creating a random UUID. -- **Batching & offline behavior**: The SDK batches up to 50 events or waits for 15 seconds and then persists and sends the events, whichever comes first. So for sessions, this might actually mean, we send one single event per batch. If you are sending Custom Events, it can be 1 session event plus X of your Custom Events (up to 50 events per batch total). In case the device is offline, up to 50 batches (of up to 50 events) are stored until the SDK starts to reject and drop new events, logging an error. - - -#### For iOS - -On iOS, the random UUID ist securely stored in the keychain. On iOS, User Metrics is enabled by default. If you want to turn off User Metrics, please use the following code: - -```csharp -// add the HockeyApp namespace -using HockeyApp.iOS; - -// in your FinishedLaunching-method add: -var manager = BITHockeyManager.SharedHockeyManager; -manager.Configure("$Your_App_Id"); -manager.DisableMetricsManager = true; -manager.StartManager(); -``` - -It is important that you set `DisableMetricsManager` before you start the manager. - -#### For Android - -On Android, User Metrics is not automatically enabled, you have to start this explicitly yourself: - -```csharp -// add the HockeyApp namespace -using HockeyApp.Android.Metrics; - -// in your main activity OnCreate-method add: -MetricsManager.Register(Application, "$Your_App_Id"); -``` - - -### 2.5 Add custom events -HockeyApp allows you to track custom events to understand user actions inside your app. - -Properties and measurements added to Custom Events are available in Application Insights Analytics as a preview. Please have a look at the [public announcement](https://www.hockeyapp.net/blog/2016/08/30/custom-events-public-preview.html) to find out more. - - -**Please note:** To use custom events, please first make sure that User Metrics is [set up correctly](#user-metrics) for your platform (e.g. you registered the MetricsManager on Android). - -Tracking custom events on iOS and Android uses the same code: - -1. Make sure to add the correct namespace: - ```csharp - using HockeyApp; - using System.Collections.Generic; - ``` - -2. Track custom events like this: - ```csharp - HockeyApp.MetricsManager.TrackEvent("Custom Event"); - ``` - if you want to add custom properties or measurements, use this: - - ```csharp - HockeyApp.MetricsManager.TrackEvent( - "Custom Event", - new Dictionary { { "property", "value" } }, - new Dictionary { { "time", 1.0 } } - ) - ``` - - -### 2.6 Add Update Distribution -This will add the in-app update mechanism to your app. Detailed configuration options are in the advanced setup sections for each platform: [iOS](https://github.com/bitstadium/HockeySDK-iOS#advancedsetup) | [Android](https://github.com/bitstadium/HockeySDK-Android#advancedsetup) - -#### For iOS -The feature handles version updates, presents update and version information in an App Store like user interface, collects usage information and provides additional authorization options when using Ad-Hoc provisioning profiles. - -To enable automatic in-app updates you need to make sure to add `manager.Authenticator.AuthenticateInstallation();` after starting the SDK: - -```csharp -using HockeyApp.iOS; - -var manager = BITHockeyManager.SharedHockeyManager; -manager.Configure("$Your_App_Id"); -manager.StartManager(); -manager.Authenticator.AuthenticateInstallation(); -``` - -**Please note:** This module automatically disables itself when running in an App Store build by default. - -If you manually want to disable the feature at some point, use this code: - -```csharp -using HockeyApp.iOS; - -var manager = BITHockeyManager.SharedHockeyManager; -manager.Configure("$Your_App_Id"); -manager.DisableUpdateManager = true; -manager.StartManager(); -manager.Authenticator.AuthenticateInstallation(); -``` - -If you want to see beta analytics, use the beta distribution feature with in-app updates, restrict versions to specific users. Or if you want to know who is actually testing your app, follow the instructions on our guide [Authenticating Users on iOS](https://support.hockeyapp.net/kb/client-integration-ios-mac-os-x-tvos/authenticating-users-on-ios). - -#### For Android +## 1. Setup -1. Open the activity where you want to inform the user about eventual updates. Typically you want to do this on startup of your main activity. -2. Add the following code and make sure to always balance `register(…)` calls to SDK managers with `unregister()` calls in the corresponding lifecycle callbacks: +It is super easy to use HockeyApp in your Xamarin app. Have a look at our [documentation](https://support.hockeyapp.net/kb/client-integration-cross-platform/how-to-integrate-hockeyapp-with-xamarin) and onboard your app within minutes. -```csharp -using HockeyApp.Android; +## 2. Documentation -namespace YourNameSpace { - [Activity(Label = "Your.App", MainLauncher = true, Icon = "@mipmap/icon")] - public class YourActivity : Activity { - protected override void OnCreate(Bundle savedInstanceState) { - base.OnCreate(savedInstanceState); - // Your own code to create the view - // ... - - CheckForUpdates(); - } +Please visit [our landing page](https://support.hockeyapp.net/kb) as a starting point for all of our documentation and check out our [getting started documentation](https://support.hockeyapp.net/kb/client-integration-cross-platform/how-to-integrate-hockeyapp-with-xamarin), [changelog](https://github.com/bitstadium/HockeySDK-Xamarin/releases), and our [troubleshooting section](https://support.hockeyapp.net/kb/client-integration-cross-platform/how-to-integrate-hockeyapp-with-xamarin#5-troubleshooting). - private void CheckForUpdates() { - // Remove this for store builds! - UpdateManager.Register(this, "$Your_App_Id"); - } - - private void UnregisterManagers() { - UpdateManager.Unregister(); - } +The Xamarin SDK wraps our native SDKs – [HockeySDK-iOS 4.1.6](https://github.com/bitstadium/HockeySDK-iOS/releases/tag/4.1.6) and [HockeySDK-Android 4.1.5](https://github.com/bitstadium/HockeySDK-Android/releases/tag/4.1.5). For more info on advanced, platform-specific behaviors, check out the documentation for [HockeySDK-iOS](https://support.hockeyapp.net/kb/client-integration-ios-mac-os-x-tvos/hockeyapp-for-ios) and [HockeySDK-Android](https://support.hockeyapp.net/kb/client-integration-android/hockeyapp-for-android-sdk). - protected override void OnPause() { - base.OnPause(); - UnregisterManagers(); - } - - protected override void OnDestroy() { - base.OnDestroy(); - UnregisterManagers(); - } - } -} -``` +## 3. Contributing -When the activity is created, the update manager checks for new updates in the background. If it finds a new update, an alert dialog will be shown. If the user presses `Show` in said dialog, they will be taken to the update activity. The reason to only do this once upon creation is that the update check causes network traffic and therefore potential costs for your users. +We're looking forward to your contributions via [pull requests on GitHub](https://github.com/bitstadium/HockeySDK-Xamarin). - -### 2.7 Add in-app feedback -The feedback manager lets your users communicate directly with you via the app and an integrated user interface. It provides a single threaded discussion with a user running your app. Detailed configuration options are in the advanced setup sections for each platform: [iOS](https://github.com/bitstadium/HockeySDK-iOS#advancedsetup) | [Android](https://github.com/bitstadium/HockeySDK-Android#advancedsetup) +### 3.1 Development environment -1. You'll typically only want to show the feedback interface upon user interaction, for this example, we assume you have a button `feedbackButton` in your view for this. -2. Add the following lines to your respective view controller/activity, handling the touch events and presenting the feedback interface: +* A Mac, running the latest version of macOS. +* Get the latest Xcode from the Mac App Store. -#### For iOS +### 3.2 Code of Conduct -You should never create your own instance of `BITFeedbackManager` but use the one provided by the `BITHockeyManager.sharedHockeyManager()`. - -```csharp -using HockeyApp.iOS; - -namespace YourNameSpace { -{ - - [Register ("AppDelegate")] - public partial class AppDelegate : UIApplicationDelegate - { - - public override bool FinishedLaunching(UIApplication application, NSDictionary launchOptions) { - { - // Initialise the Hockey SDK here - var manager = BITHockeyManager.SharedHockeyManager; - manager.Configure("$Your_App_Id"); - manager.StartManager(); - - // Create button and add action for click event - var app = new App (); - var ShowFeedbackListViewButton = new Xamarin.Forms.Button { - Text = "Show Feedback List View" - }; - ShowFeedbackListViewButton.Clicked += ShowFeedbackList; - app.AddChild (ShowFeedbackListViewButton); - } - - private static void ShowFeedbackList(object sender, EventArgs e) { - // This is where the feedback form gets displayed - var feedbackManager = BITHockeyManager.SharedHockeyManager.FeedbackManager; - feedbackManager.ShowFeedbackListView (); - } - } -} -``` - -Please check the [documentation](#documentation) of the `BITFeedbackManager` class on more information on how to leverage this feature. - -#### For Android - -1. You'll typically only want to show the feedback interface upon user interaction, for this example we assume you have a button `feedback_button` in your view for this. -2. Add the following lines to your respective activity, handling the touch events and showing the feedback interface: - -```csharp -using HockeyApp.Android; - -namespace YourNameSpace { - public class YourActivity : Activitiy { - protected override void OnCreate(Bundle savedInstanceState) { - base.OnCreate(savedInstanceState); - // Your own code to create the view - // ... - - FeedbackManager.Register(this, "$Your_App_Id"); - - Button feedbackButton = FindViewById