UIProgressView+AFNetworking.h 3.4 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192
  1. // UIProgressView+AFNetworking.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. #import <Foundation/Foundation.h>
  22. #import <Availability.h>
  23. #if defined(__IPHONE_OS_VERSION_MIN_REQUIRED)
  24. #import <UIKit/UIKit.h>
  25. NS_ASSUME_NONNULL_BEGIN
  26. @class AFURLConnectionOperation;
  27. /**
  28. This category adds methods to the UIKit framework's `UIProgressView` class. The methods in this category provide support for binding the progress to the upload and download progress of a session task or request operation.
  29. */
  30. @interface UIProgressView (AFNetworking)
  31. ///------------------------------------
  32. /// @name Setting Session Task Progress
  33. ///------------------------------------
  34. /**
  35. Binds the progress to the upload progress of the specified session task.
  36. @param task The session task.
  37. @param animated `YES` if the change should be animated, `NO` if the change should happen immediately.
  38. */
  39. #if __IPHONE_OS_VERSION_MIN_REQUIRED >= 70000
  40. - (void)setProgressWithUploadProgressOfTask:(NSURLSessionUploadTask *)task
  41. animated:(BOOL)animated;
  42. #endif
  43. /**
  44. Binds the progress to the download progress of the specified session task.
  45. @param task The session task.
  46. @param animated `YES` if the change should be animated, `NO` if the change should happen immediately.
  47. */
  48. #if __IPHONE_OS_VERSION_MIN_REQUIRED >= 70000
  49. - (void)setProgressWithDownloadProgressOfTask:(NSURLSessionDownloadTask *)task
  50. animated:(BOOL)animated;
  51. #endif
  52. ///------------------------------------
  53. /// @name Setting Session Task Progress
  54. ///------------------------------------
  55. /**
  56. Binds the progress to the upload progress of the specified request operation.
  57. @param operation The request operation.
  58. @param animated `YES` if the change should be animated, `NO` if the change should happen immediately.
  59. */
  60. - (void)setProgressWithUploadProgressOfOperation:(AFURLConnectionOperation *)operation
  61. animated:(BOOL)animated;
  62. /**
  63. Binds the progress to the download progress of the specified request operation.
  64. @param operation The request operation.
  65. @param animated `YES` if the change should be animated, `NO` if the change should happen immediately.
  66. */
  67. - (void)setProgressWithDownloadProgressOfOperation:(AFURLConnectionOperation *)operation
  68. animated:(BOOL)animated;
  69. @end
  70. NS_ASSUME_NONNULL_END
  71. #endif