// // Author: Andreas Linde // // Copyright (c) 2012-2014 HockeyApp, Bit Stadium GmbH. All rights reserved. // See LICENSE.txt for author information. // // Permission is hereby granted, free of charge, to any person obtaining a copy // of this software and associated documentation files (the "Software"), to deal // in the Software without restriction, including without limitation the rights // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell // copies of the Software, and to permit persons to whom the Software is // furnished to do so, subject to the following conditions: // // The above copyright notice and this permission notice shall be included in // all copies or substantial portions of the Software. // // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN // THE SOFTWARE. @class BITCrashManager; @class BITFeedbackManager; @protocol BITHockeyManagerDelegate; /** The HockeySDK manager. Responsible for setup and management of all components This is the principal SDK class. It represents the entry point for the HockeySDK. The main promises of the class are initializing the SDK modules, providing access to global properties and to all modules. Initialization is divided into several distinct phases: 1. Setup the [HockeyApp](http://hockeyapp.net/) app identifier and the optional delegate: This is the least required information on setting up the SDK and using it. It does some simple validation of the app identifier. 2. Provides access to the SDK module `BITCrashManager`. This way all modules can be further configured to personal needs, if the defaults don't fit the requirements. 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 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. 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 autoSubmitCrashReport]` is enabled (default) Example: [[BITHockeyManager sharedHockeyManager] configureWithIdentifier:@""]; [[BITHockeyManager sharedHockeyManager] startManager]; @warning The SDK is **NOT** thread safe and has to be set up on the main thread! @warning You should **NOT** change any module configuration after calling `startManager`! */ @interface BITHockeyManager : NSObject { @private NSString *_appIdentifier; NSString *_serverURL; BOOL _validAppIdentifier; BOOL _startManagerIsInvoked; BITCrashManager *_crashManager; id _delegate; BOOL _disableCrashManager; BITFeedbackManager *_feedbackManager; BOOL _disableFeedbackManager; BOOL _debugLogEnabled; NSInteger _statusCode; NSURLConnection *_urlConnection; } #pragma mark - Public Methods ///----------------------------------------------------------------------------- /// @name Initialization ///----------------------------------------------------------------------------- /** * Returns the shared manager object * * @return A singleton BITHockeyManager instance ready use */ + (BITHockeyManager *)sharedHockeyManager; /** * Initializes the manager with a particular app identifier, company name and delegate * * Initialize the manager with a HockeyApp app identifier. * * @see BITCrashManagerDelegate * @see startManager * @see configureWithIdentifier:delegate: * @param appIdentifier The app identifier that should be used. */ - (void)configureWithIdentifier:(NSString *)appIdentifier; /** * Initializes the manager with a particular app identifier, company name and delegate * * Initialize the manager with a HockeyApp app identifier and assign the class that * implements the optional protocol `BITCrashManagerDelegate`. * * @see BITCrashManagerDelegate * @see startManager * @see configureWithIdentifier: * @param appIdentifier The app identifier that should be used. * @param delegate `nil` or the class implementing the optional protocols */ - (void)configureWithIdentifier:(NSString *)appIdentifier delegate:(id ) delegate; /** * Initializes the manager with a particular app identifier, company name and delegate * * Initialize the manager with a HockeyApp app identifier and assign the class that * implements the required protocol `BITCrashManagerDelegate`. * * @see BITCrashManagerDelegate * @see startManager * @see configureWithIdentifier: * @see configureWithIdentifier:delegate: * @param appIdentifier The app identifier that should be used. * @param companyName `nil` or the company name, this is not used anywhere any longer. * @param delegate `nil` or the class implementing the required protocols */ - (void)configureWithIdentifier:(NSString *)appIdentifier companyName:(NSString *)companyName delegate:(id ) delegate __attribute__((deprecated("Use configureWithIdentifier:delegate: instead"))); /** * Starts the manager and runs all modules * * Call this after configuring the manager and setting up all modules. * * @see configureWithIdentifier: * @see configureWithIdentifier:delegate: */ - (void)startManager; #pragma mark - Public Properties ///----------------------------------------------------------------------------- /// @name General ///----------------------------------------------------------------------------- /** * Set the delegate * * Defines the class that implements the optional protocol `BITHockeyManagerDelegate`. * * @see BITHockeyManagerDelegate * @see BITCrashManagerDelegate */ @property (nonatomic, unsafe_unretained) id delegate; ///----------------------------------------------------------------------------- /// @name Modules ///----------------------------------------------------------------------------- /** * Defines the server URL to send data to or request data from * * By default this is set to the HockeyApp servers and there rarely should be a * need to modify that. */ @property (nonatomic, strong) NSString *serverURL; /** * Reference to the initialized BITCrashManager module * * Returns the BITCrashManager instance initialized by BITHockeyManager * * @see configureWithIdentifier: * @see configureWithIdentifier:delegate: * @see startManager * @see disableCrashManager */ @property (nonatomic, strong, readonly) BITCrashManager *crashManager; /** * Flag the determines whether the Crash Manager should be disabled * * If this flag is enabled, then crash reporting is disabled and no crashes will * be send. * * Please note that the Crash Manager will be initialized anyway! * * *Default*: _NO_ * @see crashManager */ @property (nonatomic, getter = isCrashManagerDisabled) BOOL disableCrashManager; /** Reference to the initialized BITFeedbackManager module Returns the BITFeedbackManager instance initialized by BITHockeyManager @see configureWithIdentifier:delegate: @see configureWithBetaIdentifier:liveIdentifier:delegate: @see startManager @see disableFeedbackManager */ @property (nonatomic, strong, readonly) BITFeedbackManager *feedbackManager; /** Flag the determines whether the Feedback Manager should be disabled If this flag is enabled, then letting the user give feedback and get responses will be turned off! Please note that the Feedback Manager will be initialized anyway! *Default*: _NO_ @see feedbackManager */ @property (nonatomic, getter = isFeedbackManagerDisabled) BOOL disableFeedbackManager; ///----------------------------------------------------------------------------- /// @name Configuration ///----------------------------------------------------------------------------- /** Set the userid that should used in the SDK components Right now this is used by the `BITCrashMananger` to attach to a crash report and `BITFeedbackManager`. Note: the value is persisted in the keychain! To remove old values, call this setter with a `nil` value. @see [BITHockeyManagerDelegate userIDForHockeyManager:componentManager:] @see setUserName: @see setUserEmail: */ - (void)setUserID:(NSString *)userID; /** Set the user name that should used in the SDK components Right now this is used by the `BITCrashMananger` to attach to a crash report and `BITFeedbackManager`. Note: the value is persisted in the keychain! To remove old values, call this setter with a `nil` value. @see [BITHockeyManagerDelegate userNameForHockeyManager:componentManager:] @see setUserID: @see setUserEmail: */ - (void)setUserName:(NSString *)userName; /** Set the users email address that should used in the SDK components Right now this is used by the `BITCrashMananger` to attach to a crash report and `BITFeedbackManager`. Note: the value is persisted in the keychain! To remove old values, call this setter with a `nil` value. @see [BITHockeyManagerDelegate userEmailForHockeyManager:componentManager:] @see setUserID: @see setUserName: */ - (void)setUserEmail:(NSString *)userEmail; ///----------------------------------------------------------------------------- /// @name Debug Logging ///----------------------------------------------------------------------------- /** * Flag that determines whether additional logging output should be generated * by the manager and all modules. * * This is ignored if the app is running in the App Store and reverts to the * default value in that case. * * *Default*: _NO_ */ @property (nonatomic, assign, getter=isDebugLogEnabled) BOOL debugLogEnabled; ///----------------------------------------------------------------------------- /// @name Integration test ///----------------------------------------------------------------------------- /** Pings the server with the HockeyApp app identifiers used for initialization Call this method once for debugging purposes to test if your SDK setup code reaches the server successfully. Once invoked, check the apps page on HockeyApp for a verification. */ - (void)testIdentifier; @end