You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Feb 19, 2020. It is now read-only.
Copy file name to clipboardexpand all lines: Documentation/Guides/Changelog.md
+8
Original file line number
Diff line number
Diff line change
@@ -1,3 +1,11 @@
1
+
## 5.0.0-beta.1
2
+
3
+
This version drops support for iOS 7. There is not other breaking change at this point.
4
+
5
+
-[IMPROVEMENT] The code has been cleaned up as we have decided to drop support for iOS 7.
6
+
-[IMPROVEMENT]`properties` of type `NSString` now use the `copy` attribute.
7
+
-[BUGFIX] The logic that makes sure that the for HockeySDK-iOS is excluded from backups was changed to make sure it doesn't block app launch [#443](https://github.com/bitstadium/HockeySDK-iOS/pull/443).
8
+
1
9
## 4.1.6
2
10
3
11
-[BUGFIX] Fixed a string in the Italian translation [#430](https://github.com/bitstadium/HockeySDK-iOS/pull/430).
**NOTE** If your are using the binary integration of our SDK, make sure that the `HockeySDKResources.bundle` inside the `HockeySDK.embeddedframework`-folder has been added to your application.
11
11
@@ -84,7 +84,7 @@ Please see the "[How to create a new app](http://support.hockeyapp.net/kb/about-
84
84
85
85
From our experience, 3rd-party libraries usually reside inside a subdirectory (let's call our subdirectory `Vendor`), so if you don't have your project organized with a subdirectory for libraries, now would be a great start for it. To continue our example, create a folder called `Vendor` inside your project directory and move the unzipped `HockeySDK-iOS`-folder into it.
86
86
87
-
The SDK comes in four flavours:
87
+
The SDK comes in four flavors:
88
88
89
89
* Default SDK without Feedback: `HockeySDK.embeddedframework`
90
90
* Full featured SDK with Feedback: `HockeySDK.embeddedframework` in the subfolder `HockeySDKAllFeatures`.
@@ -97,7 +97,7 @@ Our examples will use the **default** SDK (`HockeySDK.embeddedframework`).
97
97
98
98
### 2.4 Add the SDK to the project in Xcode
99
99
100
-
> We recommend to use Xcode's group-feature to create a group for 3rd-party-libraries similar to the structure of our files on disk. For example, similar to the file structure in 2.3 above, our projects have a group called `Vendor`.
100
+
> We recommend using Xcode's group-feature to create a group for 3rd-party-libraries similar to the structure of our files on disk. For example, similar to the file structure in 2.3 above, our projects have a group called `Vendor`.
101
101
102
102
1. Make sure the `Project Navigator` is visible (⌘+1).
103
103
2. Drag & drop `HockeySDK.embeddedframework` from your `Finder` to the `Vendor` group in `Xcode` using the `Project Navigator` on the left side.
@@ -173,7 +173,7 @@ Our examples will use the **default** SDK (`HockeySDK.embeddedframework`).
173
173
```
174
174
175
175
176
-
*Note:* The SDK is optimized to defer everything possible to a later time while making sure e.g. crashes on startup can also be caught and each module executes other code with a delay some seconds. This ensures that `applicationDidFinishLaunching` will process as fast as possible and the SDK will not block the startup sequence resulting in a possible kill by the watchdog process.
176
+
*Note:* The SDK is optimized to defer everything possible to a later time while making sure e.g. crashes on start-up can also be caught and each module executes other code with a delay some seconds. This ensures that `applicationDidFinishLaunching` will process as fast as possible and the SDK will not block the start-up sequence resulting in a possible kill by the watchdog process.
177
177
178
178
179
179
**Congratulation, now you're all set to use HockeySDK!**
@@ -192,7 +192,6 @@ If you are working with an older project which doesn't support clang modules yet
192
192
4. Expand `Link Binary With Libraries`.
193
193
5. Add the following system frameworks, if they are missing:
194
194
1. Default SDK:
195
-
+`AssetsLibrary`
196
195
+`CoreText`
197
196
+`CoreGraphics`
198
197
+`Foundation`
@@ -205,7 +204,6 @@ If you are working with an older project which doesn't support clang modules yet
205
204
+`libc++`
206
205
+`libz`
207
206
2. SDK with all features:
208
-
+`AssetsLibrary`
209
207
+`CoreText`
210
208
+`CoreGraphics`
211
209
+`Foundation`
@@ -230,7 +228,7 @@ If you are working with an older project which doesn't support clang modules yet
230
228
+`SystemConfiguration`
231
229
+`libc++`
232
230
233
-
Note that this also means that you can't use the `@import` syntax mentioned in the [Modify Code](#modify) section but have to stick to the old `#import <HockeySDK/HockeySDK.h>`.
231
+
Note that not using clang modules also means that you can't use the `@import` syntax mentioned in the [Modify Code](#modify) section but have to stick to the old `#import <HockeySDK/HockeySDK.h>` imports.
234
232
235
233
<aid="cocoapods"></a>
236
234
### 3.2 CocoaPods
@@ -276,7 +274,7 @@ pod "HockeySDK", :subspecs => ['CrashOnlyExtensionsLib']
276
274
277
275
#### 3.2.2 Source Integration Options
278
276
279
-
Alternatively you can integrate the SDK by source if you want to do modifications or want a different feature set. The following entry will integrate the SDK:
277
+
Alternatively, you can integrate the SDK by source if you want to do modifications or want a different feature set. The following entry will integrate the SDK:
280
278
281
279
```ruby
282
280
pod "HockeySDK-Source"
@@ -404,7 +402,7 @@ The following points need to be considered to use HockeySDK with WatchKit 1 Exte
404
402
<aname="crashreporting"></a>
405
403
### 3.6 Crash Reporting
406
404
407
-
The following options only show some of possibilities to interact and fine-tune the crash reporting feature. For more please check the full documentation of the `BITCrashManager` class in our [documentation](#documentation).
405
+
The following options only show some of the possibilities to interact and fine-tune the crash reporting feature. For more please check the full documentation of the `BITCrashManager` class in our [documentation](#documentation).
408
406
409
407
#### 3.6.1 Disable Crash Reporting
410
408
The HockeySDK enables crash reporting **per default**. Crashes will be immediately sent to the server the next time the app is launched.
@@ -435,15 +433,15 @@ Crashes are send the next time the app starts. If `crashManagerStatus` is set to
435
433
436
434
The SDK is not sending the reports right when the crash happens deliberately, because if is not safe to implement such a mechanism while being async-safe (any Objective-C code is _NOT_ async-safe!) and not causing more danger like a deadlock of the device, than helping. We found that users do start the app again because most don't know what happened, and you will get by far most of the reports.
437
435
438
-
Sending the reports on startup is done asynchronously (non-blocking). This is the only safe way to ensure that the app won't be possibly killed by the iOS watchdog process, because startup could take too long and the app could not react to any user input when network conditions are bad or connectivity might be very slow.
436
+
Sending the reports on start-up is done asynchronously (non-blocking). This is the only safe way to ensure that the app won't be possibly killed by the iOS watchdog process, because start-up could take too long and the app could not react to any user input when network conditions are bad or connectivity might be very slow.
439
437
440
438
#### 3.6.3 Mach Exception Handling
441
439
442
440
By default the SDK is using the safe and proven in-process BSD Signals for catching crashes. This option provides an option to enable catching fatal signals via a Mach exception server instead.
443
441
444
-
We strongly advice_NOT_ to enable Mach exception handler in release versions of your apps!
442
+
We strongly advise_NOT_ to enable Mach exception handler in release versions of your apps!
445
443
446
-
*Warning:* The Mach exception handler executes in-process, and will interfere with debuggers when they attempt to suspend all active threads (which will include the Mach exception handler). Mach-based handling should _NOT_ be used when a debugger is attached. The SDK will not enabled catching exceptions if the app is started with the debugger running. If you attach the debugger during runtime, this may cause issues the Mach exception handler is enabled!
444
+
*Warning:* The Mach exception handler executes in-process, and will interfere with debuggers when they attempt to suspend all active threads (which will include the Mach exception handler). Mach-based handling should _NOT_ be used when a debugger is attached. The SDK will not enable catching exceptions if the app is started with the debugger running. If you attach the debugger during runtime, this may cause issues the Mach exception handler is enabled!
#### 3.7.2 Attaching custom properties and measurements to a custom event
535
533
536
-
It's possible to attach properties and/or measurements to a custom event. There is one limitation to attaching properties and measurements. They currently don't show up in the HockeyApp dashboard but you have to link your app to Application Insights to be able to query them. Please have a look at [our blogpost](https://www.hockeyapp.net/blog/2016/08/30/custom-events-public-preview.html) to find out how to do that.
534
+
It's possible to attach properties and/or measurements to a custom event. There is one limitation to attaching properties and measurements. They currently don't show up in the HockeyApp dashboard but you have to link your app to Application Insights to be able to query them. Please have a look at [our blog post](https://www.hockeyapp.net/blog/2016/08/30/custom-events-public-preview.html) to find out how to do that.
537
535
538
536
- Properties have to be a string.
539
537
- Measurements have to be of a numeric type.
@@ -570,15 +568,15 @@ As of HockeySDK 4.1.1, Feedback is no longer part of the default SDK. To use fee
570
568
571
569
#### 3.8.1 Integrate the full-featured SDK.
572
570
573
-
If you're integrating the binary yourself, use the `HockeySDK.embeddedframework` in the subfolder `HockeySDKAllFeatures`. If you're using Cocoapods, use
571
+
If you're integrating the binary yourself, use the `HockeySDK.embeddedframework` in the subfolder `HockeySDKAllFeatures`. If you're using CocoaPods, use
574
572
575
573
```ruby
576
574
pod "HockeySDK", :subspecs => ['AllFeaturesLib']
577
575
```
578
576
579
577
in your podfile.
580
578
581
-
`BITFeedbackManager` 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. This feature is only enabled, if you integrate the actual view controllers into your app.
579
+
`BITFeedbackManager` 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. This feature is only enabled if you integrate the actual view controllers into your app.
582
580
583
581
You should never create your own instance of `BITFeedbackManager` but use the one provided by the `[BITHockeyManager sharedHockeyManager]`:
584
582
@@ -600,7 +598,7 @@ If the value is missing from your `Info.plist`, the SDK will disable attaching p
600
598
601
599
This is the HockeySDK module for handling app updates when having your app released in the App Store.
602
600
603
-
When an update is detected, this module will show an alert asking the user if he/she wants to update or ignore this version. If update was chosen, it will open the apps page in the app store app.
601
+
When an update is detected, this module will show an alert asking the user if he/she wants to update or ignore this version. If the update was chosen, it will open the apps page in the app store app.
604
602
605
603
By default this module is **NOT** enabled! To enable it use the following code:
606
604
@@ -619,9 +617,9 @@ Please check the [documentation](#documentation) of the `BITStoreUpdateManager`
619
617
<a name="betaupdates"></a>
620
618
### 3.10 In-App-Updates (Beta & Enterprise only)
621
619
622
-
The following options only show some of possibilities to interact and fine-tune the update feature when using Ad-Hoc or Enterprise provisioning profiles. For more please check the full documentation of the `BITUpdateManager` class in our [documentation](#documentation).
620
+
The following options only show some of the possibilities to interact and fine-tune the update feature when using Ad-Hoc or Enterprise provisioning profiles. For more please check the full documentation of the `BITUpdateManager` class in our [documentation](#documentation).
623
621
624
-
The feature handles version updates, presents update and version information in a App Store like user interface, collects usage information and provides additional authorization options when using Ad-Hoc provisioning profiles.
622
+
The feature handles version updates, presents the update and version information in a App Store like user interface, collects usage information and provides additional authorization options when using Ad-Hoc provisioning profiles.
625
623
626
624
This module automatically disables itself when running in an App Store build by default!
627
625
@@ -655,7 +653,7 @@ To check if data is send properly to HockeyApp and also see some additional SDK
655
653
<a id="documentation"></a>
656
654
## 4. Documentation
657
655
658
-
Our documentation can be found on [HockeyApp](http://hockeyapp.net/help/sdk/ios/4.1.6/index.html).
656
+
Our documentation can be found on [HockeyApp](http://hockeyapp.net/help/sdk/ios/5.0.0-beta.1/index.html).
659
657
660
658
<a id="troubleshooting"></a>
661
659
## 5.Troubleshooting
@@ -669,7 +667,7 @@ Our documentation can be found on [HockeyApp](http://hockeyapp.net/help/sdk/ios/
669
667
Make sure none of the following files are copied into your app bundle, check under app target, `Build Phases`, `Copy Bundle Resources` or in the `.app` bundle after building:
670
668
671
669
- `HockeySDK.framework` (except if you build a dynamic framework version of the SDK yourself!)
0 commit comments