| commit | author | age | ||
| 6e1425 | 1 | // AFNetworkActivityIndicatorManager.h |
| H | 2 | // Copyright (c) 2011–2015 Alamofire Software Foundation (http://alamofire.org/) |
| 3 | // | |
| 4 | // Permission is hereby granted, free of charge, to any person obtaining a copy | |
| 5 | // of this software and associated documentation files (the "Software"), to deal | |
| 6 | // in the Software without restriction, including without limitation the rights | |
| 7 | // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | |
| 8 | // copies of the Software, and to permit persons to whom the Software is | |
| 9 | // furnished to do so, subject to the following conditions: | |
| 10 | // | |
| 11 | // The above copyright notice and this permission notice shall be included in | |
| 12 | // all copies or substantial portions of the Software. | |
| 13 | // | |
| 14 | // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | |
| 15 | // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | |
| 16 | // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | |
| 17 | // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | |
| 18 | // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | |
| 19 | // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN | |
| 20 | // THE SOFTWARE. | |
| 21 | ||
| 22 | #import <Foundation/Foundation.h> | |
| 23 | ||
| 24 | #import <Availability.h> | |
| 25 | ||
| 26 | #if defined(__IPHONE_OS_VERSION_MIN_REQUIRED) | |
| 27 | ||
| 28 | #import <UIKit/UIKit.h> | |
| 29 | ||
| 30 | NS_ASSUME_NONNULL_BEGIN | |
| 31 | ||
| 32 | /** | |
| 33 | `AFNetworkActivityIndicatorManager` manages the state of the network activity indicator in the status bar. When enabled, it will listen for notifications indicating that a network request operation has started or finished, and start or stop animating the indicator accordingly. The number of active requests is incremented and decremented much like a stack or a semaphore, and the activity indicator will animate so long as that number is greater than zero. | |
| 34 | ||
| 35 | You should enable the shared instance of `AFNetworkActivityIndicatorManager` when your application finishes launching. In `AppDelegate application:didFinishLaunchingWithOptions:` you can do so with the following code: | |
| 36 | ||
| 37 | [[AFNetworkActivityIndicatorManager sharedManager] setEnabled:YES]; | |
| 38 | ||
| 39 | By setting `enabled` to `YES` for `sharedManager`, the network activity indicator will show and hide automatically as requests start and finish. You should not ever need to call `incrementActivityCount` or `decrementActivityCount` yourself. | |
| 40 | ||
| 41 | See the Apple Human Interface Guidelines section about the Network Activity Indicator for more information: | |
| 42 | http://developer.apple.com/library/iOS/#documentation/UserExperience/Conceptual/MobileHIG/UIElementGuidelines/UIElementGuidelines.html#//apple_ref/doc/uid/TP40006556-CH13-SW44 | |
| 43 | */ | |
| 44 | NS_EXTENSION_UNAVAILABLE_IOS("Use view controller based solutions where appropriate instead.") | |
| 45 | @interface AFNetworkActivityIndicatorManager : NSObject | |
| 46 | ||
| 47 | /** | |
| 48 | A Boolean value indicating whether the manager is enabled. | |
| 49 | ||
| 50 | If YES, the manager will change status bar network activity indicator according to network operation notifications it receives. The default value is NO. | |
| 51 | */ | |
| 52 | @property (nonatomic, assign, getter = isEnabled) BOOL enabled; | |
| 53 | ||
| 54 | /** | |
| 55 | A Boolean value indicating whether the network activity indicator is currently displayed in the status bar. | |
| 56 | */ | |
| 57 | @property (readonly, nonatomic, assign) BOOL isNetworkActivityIndicatorVisible; | |
| 58 | ||
| 59 | /** | |
| 60 | Returns the shared network activity indicator manager object for the system. | |
| 61 | ||
| 62 | @return The systemwide network activity indicator manager. | |
| 63 | */ | |
| 64 | + (instancetype)sharedManager; | |
| 65 | ||
| 66 | /** | |
| 67 | Increments the number of active network requests. If this number was zero before incrementing, this will start animating the status bar network activity indicator. | |
| 68 | */ | |
| 69 | - (void)incrementActivityCount; | |
| 70 | ||
| 71 | /** | |
| 72 | Decrements the number of active network requests. If this number becomes zero after decrementing, this will stop animating the status bar network activity indicator. | |
| 73 | */ | |
| 74 | - (void)decrementActivityCount; | |
| 75 | ||
| 76 | @end | |
| 77 | ||
| 78 | NS_ASSUME_NONNULL_END | |
| 79 | ||
| 80 | #endif | |
