Some more documentation improvements

This commit is contained in:
Andreas Linde 2013-02-07 14:59:15 +01:00
parent 3e18ac13b3
commit e5f58960ac
2 changed files with 10 additions and 0 deletions

View File

@ -146,6 +146,9 @@ extern NSString *const kBITCrashManagerStatus;
Use this on startup, to check if the app starts the first time after it crashed
previously. You can use this also to disable specific events, like asking
the user to rate your app.
@warning This property only has a correct value, once `[BITHockeyManager startManager]` was
invoked!
*/
@property (nonatomic, readonly) BOOL didCrashInLastSession;

View File

@ -48,6 +48,13 @@
3. Configure each module.
4. Start up all modules.
The SDK is optimized to defer everything possible to a later time while making sure e.g. crashes on startup can also be catched 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.
All modules do **NOT** show any user interface if the module is not activated or not integrated.
`BITCrashManager`: Shows an alert on startup asking the user if he/she agrees on sending the crash report, if `[BITCrashManager crashManagerStatus]` is set to `BITCrashManagerStatusAlwaysAsk` (default)
`BITUpdateManager`: Is automatically deactivated when the SDK detects it is running from a build distributed via the App Store. Otherwise if it is not deactivated manually, it will show an alert after startup informing the user about a pending update, if one is available. If the user then decides to view the update another screen is presented with further details and an option to install the update.
`BITFeedbackManager`: If this module is deactivated or the user interface is nowhere added into the app, this module will not do anything. It will not fetch the server for data or show any user interface. If it is integrated, activated, and the user already used it to provide feedback, it will show an alert after startup if a new answer has been received from the server with the option to view it.
@warning You should **NOT** change any module configuration after calling `startManager`!
Example: