AWFNetworkActivityIndicatorManager

Objective-C

@interface AWFNetworkActivityIndicatorManager : NSObject

Swift

class AWFNetworkActivityIndicatorManager : NSObject

AFNetworkActivityIndicatorManager manages the state of the network activity indicator in the status bar. When enabled, it will listen for notifications indicating that a session task 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.

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:

[[AFNetworkActivityIndicatorManager sharedManager] setEnabled:YES];

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.

See the Apple Human Interface Guidelines section about the Network Activity Indicator for more information: http://developer.apple.com/library/iOS/#documentation/UserExperience/Conceptual/MobileHIG/UIElementGuidelines/UIElementGuidelines.html#//apple_ref/doc/uid/TP40006556-CH13-SW44

  • A Boolean value indicating whether the manager is enabled.

    If YES, the manager will change status bar network activity indicator according to network operation notifications it receives. The default value is NO.

    Declaration

    Objective-C

    @property (nonatomic, getter=isEnabled) BOOL enabled;

    Swift

    var isEnabled: Bool { get set }

  • A Boolean value indicating whether the network activity indicator manager is currently active.

    Declaration

    Objective-C

    @property (nonatomic, assign, unsafe_unretained, readonly,
          getter=isNetworkActivityIndicatorVisible)
    BOOL networkActivityIndicatorVisible;

    Swift

    var isNetworkActivityIndicatorVisible: Bool { get }

  • A time interval indicating the minimum duration of networking activity that should occur before the activity indicator is displayed. The default value 1 second. If the network activity indicator should be displayed immediately when network activity occurs, this value should be set to 0 seconds.

    Apple’s HIG describes the following:

    Display the network activity indicator to provide feedback when your app accesses the network for more than a couple of seconds. If the operation finishes sooner than that, you don't have to show the network activity indicator, because the indicator is likely to disappear before users notice its presence.

    Declaration

    Objective-C

    @property (nonatomic) NSTimeInterval activationDelay;

    Swift

    var activationDelay: TimeInterval { get set }

  • A time interval indicating the duration of time of no networking activity required before the activity indicator is disabled. This allows for continuous display of the network activity indicator across multiple requests. The default value is 0.17 seconds.

    Declaration

    Objective-C

    @property (nonatomic) NSTimeInterval completionDelay;

    Swift

    var completionDelay: TimeInterval { get set }

  • Returns the shared network activity indicator manager object for the system.

    Declaration

    Objective-C

    + (nonnull instancetype)sharedManager;

    Swift

    class func shared() -> Self

    Return Value

    The systemwide network activity indicator manager.

  • Increments the number of active network requests. If this number was zero before incrementing, this will start animating the status bar network activity indicator.

    Declaration

    Objective-C

    - (void)incrementActivityCount;

    Swift

    func incrementActivityCount()

  • Decrements the number of active network requests. If this number becomes zero after decrementing, this will stop animating the status bar network activity indicator.

    Declaration

    Objective-C

    - (void)decrementActivityCount;

    Swift

    func decrementActivityCount()

  • Set the a custom method to be executed when the network activity indicator manager should be hidden/shown. By default, this is null, and the UIApplication Network Activity Indicator will be managed automatically. If this block is set, it is the responsiblity of the caller to manager the network activity indicator going forward.

    Declaration

    Objective-C

    - (void)setNetworkingActivityActionWithBlock:(nullable void (^)(BOOL))block;

    Swift

    func setNetworkingActivityAction() async -> Bool

    Parameters

    block

    A block to be executed when the network activity indicator status changes.