From 295dc1051da4808d247320c6723cb2ba09a29aed Mon Sep 17 00:00:00 2001 From: Christian Noon Date: Sun, 23 Feb 2020 10:10:29 -0800 Subject: [PATCH] Prepping 4.0.0 Release (#397) * Added release notes to the CHANGELOG and bumped podspec * Regenerate jazzy docs for 4.0.0 release --- AlamofireImage.podspec | 2 +- CHANGELOG.md | 47 + docs/Classes.html | 23 +- docs/Classes/AutoPurgingImageCache.html | 59 +- docs/Classes/ImageDownloader.html | 139 +- .../DownloadPrioritization.html | 11 +- docs/Classes/ImageResponseSerializer.html | 52 +- docs/Classes/RequestReceipt.html | 11 +- docs/Enums.html | 12 +- docs/Enums/AFIError.html | 28 +- docs/Extensions.html | 77 +- docs/Extensions/AlamofireExtension.html | 2202 +++++++++++++++++ docs/Extensions/DataRequest.html | 11 +- docs/Extensions/UIButton.html | 560 +---- docs/Extensions/UIImage.html | 342 +-- docs/Extensions/UIImageView.html | 410 +-- .../UIImageView/ImageTransition.html | 13 +- docs/Protocols.html | 51 +- docs/Protocols/CompositeImageFilter.html | 19 +- docs/Protocols/CoreImageFilter.html | 11 +- docs/Protocols/ImageCache.html | 11 +- docs/Protocols/ImageFilter.html | 188 +- docs/Protocols/ImageRequestCache.html | 11 +- docs/Protocols/Roundable.html | 11 +- docs/Protocols/Sizable.html | 11 +- docs/Structs.html | 67 +- .../AspectScaledToFillSizeCircleFilter.html | 11 +- .../Structs/AspectScaledToFillSizeFilter.html | 11 +- ...ledToFillSizeWithRoundedCornersFilter.html | 11 +- docs/Structs/AspectScaledToFitSizeFilter.html | 11 +- docs/Structs/BlurFilter.html | 11 +- docs/Structs/CircleFilter.html | 11 +- docs/Structs/DynamicCompositeImageFilter.html | 11 +- docs/Structs/DynamicImageFilter.html | 11 +- docs/Structs/RoundedCornersFilter.html | 11 +- docs/Structs/ScaledToSizeCircleFilter.html | 11 +- docs/Structs/ScaledToSizeFilter.html | 11 +- .../ScaledToSizeWithRoundedCornersFilter.html | 11 +- docs/Typealiases.html | 23 +- docs/badge.svg | 6 +- docs/css/jazzy.css | 22 +- .../Contents/Resources/Documents/Classes.html | 23 +- .../Classes/AutoPurgingImageCache.html | 59 +- .../Documents/Classes/ImageDownloader.html | 139 +- .../DownloadPrioritization.html | 11 +- .../Classes/ImageResponseSerializer.html | 52 +- .../Documents/Classes/RequestReceipt.html | 11 +- .../Contents/Resources/Documents/Enums.html | 12 +- .../Resources/Documents/Enums/AFIError.html | 28 +- .../Resources/Documents/Extensions.html | 77 +- .../Extensions/AlamofireExtension.html | 2202 +++++++++++++++++ .../Documents/Extensions/DataRequest.html | 11 +- .../Documents/Extensions/UIButton.html | 560 +---- .../Documents/Extensions/UIImage.html | 342 +-- .../Documents/Extensions/UIImageView.html | 410 +-- .../UIImageView/ImageTransition.html | 13 +- .../Resources/Documents/Protocols.html | 51 +- .../Protocols/CompositeImageFilter.html | 19 +- .../Documents/Protocols/CoreImageFilter.html | 11 +- .../Documents/Protocols/ImageCache.html | 11 +- .../Documents/Protocols/ImageFilter.html | 188 +- .../Protocols/ImageRequestCache.html | 11 +- .../Documents/Protocols/Roundable.html | 11 +- .../Documents/Protocols/Sizable.html | 11 +- .../Contents/Resources/Documents/Structs.html | 67 +- .../AspectScaledToFillSizeCircleFilter.html | 11 +- .../Structs/AspectScaledToFillSizeFilter.html | 11 +- ...ledToFillSizeWithRoundedCornersFilter.html | 11 +- .../Structs/AspectScaledToFitSizeFilter.html | 11 +- .../Documents/Structs/BlurFilter.html | 11 +- .../Documents/Structs/CircleFilter.html | 11 +- .../Structs/DynamicCompositeImageFilter.html | 11 +- .../Documents/Structs/DynamicImageFilter.html | 11 +- .../Structs/RoundedCornersFilter.html | 11 +- .../Structs/ScaledToSizeCircleFilter.html | 11 +- .../Documents/Structs/ScaledToSizeFilter.html | 11 +- .../ScaledToSizeWithRoundedCornersFilter.html | 11 +- .../Resources/Documents/Typealiases.html | 23 +- .../Resources/Documents/css/jazzy.css | 22 +- .../Contents/Resources/Documents/index.html | 114 +- .../Contents/Resources/Documents/search.json | 2 +- .../Contents/Resources/docSet.dsidx | Bin 69632 -> 86016 bytes docs/docsets/AlamofireImage.tgz | Bin 135793 -> 144468 bytes docs/docsets/AlamofireImage.xml | 2 +- docs/index.html | 114 +- docs/search.json | 2 +- docs/undocumented.json | 254 +- 87 files changed, 6507 insertions(+), 3050 deletions(-) create mode 100644 docs/Extensions/AlamofireExtension.html create mode 100644 docs/docsets/AlamofireImage.docset/Contents/Resources/Documents/Extensions/AlamofireExtension.html diff --git a/AlamofireImage.podspec b/AlamofireImage.podspec index 9506e3be..38a8752f 100644 --- a/AlamofireImage.podspec +++ b/AlamofireImage.podspec @@ -1,6 +1,6 @@ Pod::Spec.new do |s| s.name = 'AlamofireImage' - s.version = '4.0.0-beta.6' + s.version = '4.0.0' s.license = 'MIT' s.summary = 'AlamofireImage is an image component library for Alamofire' s.homepage = 'https://github.com/Alamofire/AlamofireImage' diff --git a/CHANGELOG.md b/CHANGELOG.md index 257a041e..57ad5c52 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -3,6 +3,7 @@ All notable changes to this project will be documented in this file. `AlamofireImage` adheres to [Semantic Versioning](http://semver.org/). #### 4.x Releases +- `4.0.0` - [4.0.0](#400) - `4.0.0` Betas - [4.0.0-beta.1](#400-beta1) | [4.0.0-beta.2](#400-beta2) | [4.0.0-beta.3](#400-beta3) | [4.0.0-beta.4](#400-beta4) | [4.0.0-beta.5](#400-beta5) | [4.0.0-beta.6](#400-beta6) #### 3.x Releases @@ -30,6 +31,52 @@ All notable changes to this project will be documented in this file. --- +## [4.0.0](https://github.com/Alamofire/AlamofireImage/releases/tag/4.0.0) +Released on 2020-02-23. All issues associated with this milestone can be found using this +[filter](https://github.com/Alamofire/AlamofireImage/milestone/23?closed=1). + +#### Added +- Custom `cacheKey` support to `ImageDownloader` and `UIImageView` and `UIButton` extensions. + - Added by [Måns Severin](https://github.com/graphiclife) in Pull Request [#324](https://github.com/Alamofire/AlamofireImage/pull/324) in regards to Issue [#222](https://github.com/Alamofire/AlamofireImage/issues/222). +- The `application/octet-stream` to the list of acceptable image content types to support iOS 13. + - Added by [Rafael Costa](https://github.com/rafaelc0sta) in Pull Request [#390](https://github.com/Alamofire/AlamofireImage/pull/390) in regards to Issues [#370](https://github.com/Alamofire/AlamofireImage/issues/370) and [#378](https://github.com/Alamofire/AlamofireImage/issues/378). +- Custom `ImageResponseSerializer` support to `ImageDownloader` and `UIImageView` and `UIButton` extensions. + - Added by [Christian Noon](https://github.com/cnoon) in regards to Issues [#277](https://github.com/Alamofire/AlamofireImage/issues/277) and [#332](https://github.com/Alamofire/AlamofireImage/issues/332). +- Tests to various types to verify they can handle `URLRequestConvertible` types that throw. + - Added by [Marina Gornostaeva](https://github.com/hybridcattt) in Pull Request [#392](https://github.com/Alamofire/AlamofireImage/pull/392). +- `AlamofireExtended` support to `UIImage`, `UIImageView`, and `UIButton` types to use `af.` prefixing instead of `af_`. + - Added by [Christian Noon](https://github.com/cnoon) in Pull Request [#394](https://github.com/Alamofire/AlamofireImage/pull/394) in regards to Issue [#197](https://github.com/Alamofire/AlamofireImage/issues/197). +- A 4.0 migration guide to the project and linked in the README. + - Added by [Christian Noon](https://github.com/cnoon) in Pull Request [#395](https://github.com/Alamofire/AlamofireImage/pull/395). +- SwiftFormat support to the project. + - Added by [Jon Shier](https://github.com/jshier) in Pull Request [#396](https://github.com/Alamofire/AlamofireImage/pull/396). + +#### Updated +- The license section of the README to link to the actual LICENSE file. + - Updated by [Yunsu Guk](https://github.com/krgoodnews) in Pull Request [#364](https://github.com/Alamofire/AlamofireImage/pull/364). +- The `ImageDownloader` download image logic by removing variable shadowing to simplify logic flow. + - Updated by [Marina Gornostaeva](https://github.com/hybridcattt) in Pull Request [#392](https://github.com/Alamofire/AlamofireImage/pull/392). +- The image cache capacity section in the README to improve in-memory setting recommendations. + - Updated by [Christian Noon](https://github.com/cnoon) in regards to Issue [#330](https://github.com/Alamofire/AlamofireImage/issues/330). +- The Alamofire dependency to `~> 5.0` across dependency management files. + - Updated by [Christian Noon](https://github.com/cnoon). +- The README to match all the newer conventions with the Alamofire 5 changes and `af.` prefixing on extensions. + - Updated by [Christian Noon](https://github.com/cnoon). + +#### Deprecated +- The `af_` APIs on `UIImage`, `UIImageView`, and `UIButton` in favor of the new `af.` equivalent APIs. These APIs will be removed in AFI5. + - Deprecated by [Christian Noon](https://github.com/cnoon) in Pull Request [#394](https://github.com/Alamofire/AlamofireImage/pull/394). + +#### Fixed +- Issue in the README where the documentation link was incorrect. + - Fixed by [Will Jessop](https://github.com/spnkr) in Pull Request [#367](https://github.com/Alamofire/AlamofireImage/pull/367). +- Issue where `af_setBackgroundImage` was not setting the filter correctly on the image download. + - Fixed by [Dan Koza](https://github.com/djk12587) in Pull Request [#260](https://github.com/Alamofire/AlamofireImage/pull/260). +- Issue where `runImageTransitionIfCached` on `UIImageView` was not setting the placeholder image correctly. + - Fixed by [Christian Noon](https://github.com/cnoon) in regards to Issue [#293](https://github.com/Alamofire/AlamofireImage/issues/293). + +--- + ## [4.0.0-beta.6](https://github.com/Alamofire/AlamofireImage/releases/tag/4.0.0-beta.6) Released on 2019-10-27. All issues associated with this milestone can be found using this [filter](https://github.com/Alamofire/AlamofireImage/milestone/35?closed=1). diff --git a/docs/Classes.html b/docs/Classes.html index c437e3fc..8a243be5 100644 --- a/docs/Classes.html +++ b/docs/Classes.html @@ -23,7 +23,7 @@ AlamofireImage Docs - (85% documented) + (77% documented)

@@ -87,6 +87,9 @@

  • Extensions - -
    -
    • @@ -279,10 +278,6 @@

      Declaration

      • -
    -
    -
    -
    • @@ -316,10 +311,6 @@

      Declaration

      • -
    -
    -
    -
    diff --git a/docs/Classes/AutoPurgingImageCache.html b/docs/Classes/AutoPurgingImageCache.html index ee286399..96eeebfe 100644 --- a/docs/Classes/AutoPurgingImageCache.html +++ b/docs/Classes/AutoPurgingImageCache.html @@ -23,7 +23,7 @@ AlamofireImage Docs - (85% documented) + (77% documented)

    @@ -87,6 +87,9 @@

  • Extensions
      +
    • + AlamofireExtension +
    • DataRequest
      • @@ -202,7 +205,7 @@
      -
      +

      AutoPurgingImageCache

      @@ -224,9 +227,11 @@

      AutoPurgingImageCache

      - -

      Properties

      -       +
      + +

      Properties

      +

      +
      -

      © 2019 Alamofire Software Foundation. All rights reserved. (Last updated: 2019-10-27)

      -

      Generated by jazzy ♪♫ v0.11.2, a Realm project.

      +

      © 2020 Alamofire Software Foundation. All rights reserved. (Last updated: 2020-02-23)

      +

      Generated by jazzy ♪♫ v0.13.1, a Realm project.

      diff --git a/docs/Classes/ImageDownloader.html b/docs/Classes/ImageDownloader.html index c4b9c44c..153b96a1 100644 --- a/docs/Classes/ImageDownloader.html +++ b/docs/Classes/ImageDownloader.html @@ -23,7 +23,7 @@ AlamofireImage Docs - (85% documented) + (77% documented)

      @@ -87,6 +87,9 @@

    • Extensions
        +
      • + AlamofireExtension +
      • DataRequest
        • @@ -202,7 +205,7 @@
        -
        +

        ImageDownloader

        @@ -284,9 +287,11 @@

        Declaration

        - -

        Helper Types

        -         +
        + +

        Helper Types

        +

        +
        @@ -654,11 +662,10 @@

        Return Value

        Declaration

        Swift

        - 
        public init(
-    session: Session,
-    downloadPrioritization: DownloadPrioritization = .fifo,
-    maximumActiveDownloads: Int = 4,
-    imageCache: ImageRequestCache? = AutoPurgingImageCache())
        + 
        public init(session: Session,
+            downloadPrioritization: DownloadPrioritization = .fifo,
+            maximumActiveDownloads: Int = 4,
+            imageCache: ImageRequestCache? = AutoPurgingImageCache())
        @@ -730,9 +737,11 @@

        Return Value

        - -

        Authentication

        -         +
        + +

        Authentication

        +

        +
        • @@ -755,10 +764,9 @@

          Authentication

          Declaration

          Swift

          - 
          open func addAuthentication(
-    user: String,
-    password: String,
-    persistence: URLCredential.Persistence = .forSession)
          + 
          open func addAuthentication(user: String,
+                            password: String,
+                            persistence: URLCredential.Persistence = .forSession)
        @@ -860,17 +868,19 @@

        Parameters

        - -

        Download

        -         +
        + +

        Download

        +

        +
        + + + + serializer + + + +
        +

        Image response serializer used to convert the image data to UIImage. Defaults + to nil which will fall back to the instance imageResponseSerializer.

        +
        + + @@ -1030,12 +1066,11 @@

        Declaration

        Swift

        @discardableResult
-open func download(
-    _ urlRequests: [URLRequestConvertible],
-    filter: ImageFilter? = nil,
-    progress: ProgressHandler? = nil,
-    progressQueue: DispatchQueue = DispatchQueue.main,
-    completion: CompletionHandler? = nil)
+open func download(_ urlRequests: [URLRequestConvertible],
+                   filter: ImageFilter? = nil,
+                   progress: ProgressHandler? = nil,
+                   progressQueue: DispatchQueue = DispatchQueue.main,
+                   completion: CompletionHandler? = nil)
     -> [RequestReceipt]
        @@ -1118,11 +1153,7 @@

        Return Value

        -

        Cancels the request in the receipt by removing the response handler and cancelling the request if necessary.

        - -

        If the request is pending in the queue, it will be cancelled if no other response handlers are registered with -the request. If the request is currently executing or is already completed, the response handler is removed and -will not be called.

        +

        Cancels the request contained inside the receipt calls the completion handler with a request cancelled error.

        @@ -1163,8 +1194,8 @@

        Parameters

        -

        © 2019 Alamofire Software Foundation. All rights reserved. (Last updated: 2019-10-27)

        -

        Generated by jazzy ♪♫ v0.11.2, a Realm project.

        +

        © 2020 Alamofire Software Foundation. All rights reserved. (Last updated: 2020-02-23)

        +

        Generated by jazzy ♪♫ v0.13.1, a Realm project.

        diff --git a/docs/Classes/ImageDownloader/DownloadPrioritization.html b/docs/Classes/ImageDownloader/DownloadPrioritization.html index 7dd62722..32d8009c 100644 --- a/docs/Classes/ImageDownloader/DownloadPrioritization.html +++ b/docs/Classes/ImageDownloader/DownloadPrioritization.html @@ -23,7 +23,7 @@ AlamofireImage Docs - (85% documented) + (77% documented)

        @@ -87,6 +87,9 @@

      • Extensions
          +
        • + AlamofireExtension +
        • DataRequest
          • @@ -202,7 +205,7 @@
          -
          +

          DownloadPrioritization

          @@ -286,8 +289,8 @@

          Declaration

          -

          © 2019 Alamofire Software Foundation. All rights reserved. (Last updated: 2019-10-27)

          -

          Generated by jazzy ♪♫ v0.11.2, a Realm project.

          +

          © 2020 Alamofire Software Foundation. All rights reserved. (Last updated: 2020-02-23)

          +

          Generated by jazzy ♪♫ v0.13.1, a Realm project.

          diff --git a/docs/Classes/ImageResponseSerializer.html b/docs/Classes/ImageResponseSerializer.html index 187e6518..0d59400a 100644 --- a/docs/Classes/ImageResponseSerializer.html +++ b/docs/Classes/ImageResponseSerializer.html @@ -23,7 +23,7 @@ AlamofireImage Docs - (85% documented) + (77% documented)

          @@ -87,6 +87,9 @@

        • Extensions
            +
          • + AlamofireExtension +
          • DataRequest
            • @@ -202,7 +205,7 @@
            -
            +

            ImageResponseSerializer

            @@ -221,9 +224,11 @@

            ImageResponseSerializer

            - -

            Properties

            -             +
            + +

            Properties

            +

            +
            • @@ -365,9 +370,11 @@

              Declaration

              - -

              Initialization

              -               +
              + +

              Initialization

              +

              +
              • @@ -390,11 +397,10 @@

                Initialization

                Declaration

                Swift

                - 
                public init(
-    imageScale: CGFloat = ImageResponseSerializer.deviceScreenScale,
-    inflateResponseImage: Bool = true,
-    emptyResponseCodes: Set<Int> = ImageResponseSerializer.defaultEmptyResponseCodes,
-    emptyRequestMethods: Set<HTTPMethod> = ImageResponseSerializer.defaultEmptyRequestMethods)
                + 
                public init(imageScale: CGFloat = ImageResponseSerializer.deviceScreenScale,
+            inflateResponseImage: Bool = true,
+            emptyResponseCodes: Set<Int> = ImageResponseSerializer.defaultEmptyResponseCodes,
+            emptyRequestMethods: Set<HTTPMethod> = ImageResponseSerializer.defaultEmptyRequestMethods)
            @@ -407,9 +413,11 @@

            Declaration

            - -

            Serialization

            -             +
            + +

            Serialization

            +

            +
            -

            © 2019 Alamofire Software Foundation. All rights reserved. (Last updated: 2019-10-27)

            -

            Generated by jazzy ♪♫ v0.11.2, a Realm project.

            +

            © 2020 Alamofire Software Foundation. All rights reserved. (Last updated: 2020-02-23)

            +

            Generated by jazzy ♪♫ v0.13.1, a Realm project.

            diff --git a/docs/Classes/RequestReceipt.html b/docs/Classes/RequestReceipt.html index bf393811..5699cfd4 100644 --- a/docs/Classes/RequestReceipt.html +++ b/docs/Classes/RequestReceipt.html @@ -23,7 +23,7 @@ AlamofireImage Docs - (85% documented) + (77% documented)

            @@ -87,6 +87,9 @@

          • Extensions
              +
            • + AlamofireExtension +
            • DataRequest
              • @@ -202,7 +205,7 @@
              -
              +

              RequestReceipt

              @@ -284,8 +287,8 @@

              Declaration

              -

              © 2019 Alamofire Software Foundation. All rights reserved. (Last updated: 2019-10-27)

              -

              Generated by jazzy ♪♫ v0.11.2, a Realm project.

              +

              © 2020 Alamofire Software Foundation. All rights reserved. (Last updated: 2020-02-23)

              +

              Generated by jazzy ♪♫ v0.13.1, a Realm project.

              diff --git a/docs/Enums.html b/docs/Enums.html index 1937669e..518f0bb7 100644 --- a/docs/Enums.html +++ b/docs/Enums.html @@ -23,7 +23,7 @@ AlamofireImage Docs - (85% documented) + (77% documented)

              @@ -87,6 +87,9 @@

            • Extensions
                +
              • + AlamofireExtension +
              • DataRequest
                • @@ -202,7 +205,7 @@
                -
                +

                Enumerations

                The following enumerations are available globally.

                @@ -240,6 +243,7 @@

                Declaration

                Swift

                public enum AFIError : Error
                +
                extension AFIError: LocalizedError
                @@ -254,8 +258,8 @@

                Declaration

                -

                © 2019 Alamofire Software Foundation. All rights reserved. (Last updated: 2019-10-27)

                -

                Generated by jazzy ♪♫ v0.11.2, a Realm project.

                +

                © 2020 Alamofire Software Foundation. All rights reserved. (Last updated: 2020-02-23)

                +

                Generated by jazzy ♪♫ v0.13.1, a Realm project.

                diff --git a/docs/Enums/AFIError.html b/docs/Enums/AFIError.html index e51ece82..ae969642 100644 --- a/docs/Enums/AFIError.html +++ b/docs/Enums/AFIError.html @@ -23,7 +23,7 @@ AlamofireImage Docs - (85% documented) + (77% documented)

                @@ -87,6 +87,9 @@

              • Extensions
                  +
                • + AlamofireExtension +
                • DataRequest
                  • @@ -202,11 +205,12 @@
                  -
                  +

                  AFIError

                  public enum AFIError : Error
                  +
                  extension AFIError: LocalizedError
                  @@ -311,9 +315,11 @@

                  Declaration

                  - -

                  Error Booleans

                  -                   +
                  + +

                  Error Booleans

                  +

                  +
                  • @@ -403,9 +409,11 @@

                    Declaration

                    - -

                    Error Descriptions

                    -                     +
                    + +

                    Error Descriptions

                    +

                    +
                    • @@ -442,8 +450,8 @@

                      Declaration

                  -

                  © 2019 Alamofire Software Foundation. All rights reserved. (Last updated: 2019-10-27)

                  -

                  Generated by jazzy ♪♫ v0.11.2, a Realm project.

                  +

                  © 2020 Alamofire Software Foundation. All rights reserved. (Last updated: 2020-02-23)

                  +

                  Generated by jazzy ♪♫ v0.13.1, a Realm project.

                  diff --git a/docs/Extensions.html b/docs/Extensions.html index f5f324fd..7c07f459 100644 --- a/docs/Extensions.html +++ b/docs/Extensions.html @@ -23,7 +23,7 @@ AlamofireImage Docs - (85% documented) + (77% documented)

                  @@ -87,6 +87,9 @@

                • Extensions - -
                  -
                  • @@ -301,7 +304,36 @@

                    macOS

                    Declaration

                    Swift

                    - 
                    extension UIButton
                    + 
                    extension UIButton: AlamofireExtended
                    + +
                    +
                    + +
                  +
                  • +
                • +
                  + + + + AlamofireExtension + +
                  +
                  +
                  +
                  +
                  +
                  + + See more +
                  +
                  +

                  Declaration

                  +
                  +

                  Swift

                  + 
                  extension AlamofireExtension where ExtendedType: UIButton
                  +
                  extension AlamofireExtension where ExtendedType: UIImage
                  +
                  extension AlamofireExtension where ExtendedType: UIImageView
                  @@ -314,9 +346,11 @@

                  Declaration

                  - -

                  Initialization

                  -                   +
                  + +

                  Initialization

                  +

                  +
                  • @@ -339,17 +373,13 @@

                    Initialization

                    Declaration

                    Swift

                    - 
                    extension UIImage
                    + 
                    extension UIImage: AlamofireExtended
                  • -
                - -
                -
                • @@ -371,6 +401,7 @@

                  Declaration

                  Swift

                  extension UIImageView
                  +
                  extension UIImageView: AlamofireExtended
                  @@ -385,8 +416,8 @@

                  Declaration

                -

                © 2019 Alamofire Software Foundation. All rights reserved. (Last updated: 2019-10-27)

                -

                Generated by jazzy ♪♫ v0.11.2, a Realm project.

                +

                © 2020 Alamofire Software Foundation. All rights reserved. (Last updated: 2020-02-23)

                +

                Generated by jazzy ♪♫ v0.13.1, a Realm project.

                diff --git a/docs/Extensions/AlamofireExtension.html b/docs/Extensions/AlamofireExtension.html new file mode 100644 index 00000000..baccabba --- /dev/null +++ b/docs/Extensions/AlamofireExtension.html @@ -0,0 +1,2202 @@ + + + + AlamofireExtension Extension Reference + + + + + + + + + + + + + + + + +
                +

                + + AlamofireImage Docs + + (77% documented) +

                + +

                +

                + +
                +

                + +

                + + + View on GitHub + +

                + +

                + + + Install in Dash + +

                +
                + +

                + AlamofireImage Reference + + AlamofireExtension Extension Reference +

                + +
                + +
                + +
                +
                +

                AlamofireExtension

                +
                +
                + 
                extension AlamofireExtension where ExtendedType: UIButton
                +
                extension AlamofireExtension where ExtendedType: UIImage
                +
                extension AlamofireExtension where ExtendedType: UIImageView
                + +
                +
                + +
                +
                + +
                +
                +
                +
                + + +
                + +

                Properties

                +

                +
                +
                +
                  +
                • +
                  + + + + imageDownloader + +
                  +
                  +
                  +
                  +
                  +
                  +

                  The instance image downloader used to download all images. If this property is nil, the UIButton will +fallback on the sharedImageDownloader for all downloads. The most common use case for needing to use a +custom instance image downloader is when images are behind different basic auth credentials.

                  + +
                  +
                  +

                  Declaration

                  +
                  +

                  Swift

                  + 
                  public var imageDownloader: ImageDownloader? { get nonmutating set }
                  + +
                  +
                  +
                  +
                  +
                  • +
                • +
                  + + + + sharedImageDownloader + +
                  +
                  +
                  +
                  +
                  +
                  +

                  The shared image downloader used to download all images. By default, this is the default ImageDownloader +instance backed with an AutoPurgingImageCache which automatically evicts images from the cache when the memory +capacity is reached or memory warning notifications occur. The shared image downloader is only used if the +imageDownloader is nil.

                  + +
                  +
                  +

                  Declaration

                  +
                  +

                  Swift

                  + 
                  public static var sharedImageDownloader: ImageDownloader { get set }
                  + +
                  +
                  +
                  +
                  +
                  • +
                +
                +
                +
                + + +
                + +

                Image Downloads

                +

                +
                +
                +
                  +
                • + +
                  +
                  +
                  +
                  +
                  +

                  Asynchronously downloads an image from the specified URL and sets it once the request is finished.

                  + +

                  If the image is cached locally, the image is set immediately. Otherwise the specified placeholder image will be +set immediately, and then the remote image will be set once the image request is finished.

                  + +
                  +
                  +

                  Declaration

                  +
                  +

                  Swift

                  + 
                  public func setImage(for state: ControlState,
+                     url: URL,
+                     cacheKey: String? = nil,
+                     placeholderImage: UIImage? = nil,
+                     serializer: ImageResponseSerializer? = nil,
+                     filter: ImageFilter? = nil,
+                     progress: ImageDownloader.ProgressHandler? = nil,
+                     progressQueue: DispatchQueue = DispatchQueue.main,
+                     completion: ((AFIDataResponse<UIImage>) -> Void)? = nil)
                  + +
                  +
                  +
                  +

                  Parameters

                  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                  + + state + + +
                  +

                  The control state of the button to set the image on.

                  +
                  +
                  + + url + + +
                  +

                  The URL used for your image request.

                  +
                  +
                  + + cacheKey + + +
                  +

                  An optional key used to identify the image in the cache. Defaults to nil.

                  +
                  +
                  + + placeholderImage + + +
                  +

                  The image to be set initially until the image request finished. If nil, the + image will not change its image until the image request finishes. Defaults + to nil.

                  +
                  +
                  + + serializer + + +
                  +

                  Image response serializer used to convert the image data to UIImage. Defaults + to nil which will fall back to the instance imageResponseSerializer set on + the ImageDownloader.

                  +
                  +
                  + + filter + + +
                  +

                  The image filter applied to the image after the image request is finished. + Defaults to nil.

                  +
                  +
                  + + progress + + +
                  +

                  The closure to be executed periodically during the lifecycle of the request. + Defaults to nil.

                  +
                  +
                  + + progressQueue + + +
                  +

                  The dispatch queue to call the progress closure on. Defaults to the main queue.

                  +
                  +
                  + + completion + + +
                  +

                  A closure to be executed when the image request finishes. The closure takes a + single response value containing either the image or the error that occurred. If + the image was returned from the image cache, the response will be nil. Defaults + to nil.

                  +
                  +
                  +
                  +
                  +
                  +
                  • +
                • + +
                  +
                  +
                  +
                  +
                  +

                  Asynchronously downloads an image from the specified URL and sets it once the request is finished.

                  + +

                  If the image is cached locally, the image is set immediately. Otherwise the specified placeholder image will be +set immediately, and then the remote image will be set once the image request is finished.

                  + +
                  +
                  +

                  Declaration

                  +
                  +

                  Swift

                  + 
                  public func setImage(for state: ControlState,
+                     urlRequest: URLRequestConvertible,
+                     cacheKey: String? = nil,
+                     placeholderImage: UIImage? = nil,
+                     serializer: ImageResponseSerializer? = nil,
+                     filter: ImageFilter? = nil,
+                     progress: ImageDownloader.ProgressHandler? = nil,
+                     progressQueue: DispatchQueue = DispatchQueue.main,
+                     completion: ((AFIDataResponse<UIImage>) -> Void)? = nil)
                  + +
                  +
                  +
                  +

                  Parameters

                  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                  + + state + + +
                  +

                  The control state of the button to set the image on.

                  +
                  +
                  + + urlRequest + + +
                  +

                  The URL request.

                  +
                  +
                  + + cacheKey + + +
                  +

                  An optional key used to identify the image in the cache. Defaults to nil.

                  +
                  +
                  + + placeholderImage + + +
                  +

                  The image to be set initially until the image request finished. If nil, the + image will not change its image until the image request finishes. Defaults + to nil.

                  +
                  +
                  + + serializer + + +
                  +

                  Image response serializer used to convert the image data to UIImage. Defaults + to nil which will fall back to the instance imageResponseSerializer set on + the ImageDownloader.

                  +
                  +
                  + + filter + + +
                  +

                  The image filter applied to the image after the image request is finished. + Defaults to nil.

                  +
                  +
                  + + progress + + +
                  +

                  The closure to be executed periodically during the lifecycle of the request. + Defaults to nil.

                  +
                  +
                  + + progressQueue + + +
                  +

                  The dispatch queue to call the progress closure on. Defaults to the main queue.

                  +
                  +
                  + + completion + + +
                  +

                  A closure to be executed when the image request finishes. The closure takes a + single response value containing either the image or the error that occurred. If + the image was returned from the image cache, the response will be nil. Defaults + to nil.

                  +
                  +
                  +
                  +
                  +
                  +
                  • +
                • + +
                  +
                  +
                  +
                  +
                  +

                  Cancels the active download request for the image, if one exists.

                  + +
                  +
                  +

                  Declaration

                  +
                  +

                  Swift

                  + 
                  public func cancelImageRequest(for state: ControlState)
                  + +
                  +
                  +
                  +
                  +
                  • +
                +
                +
                +
                + + +
                + +

                Background Image Downloads

                +

                +
                +
                +
                  +
                • + +
                  +
                  +
                  +
                  +
                  +

                  Asynchronously downloads an image from the specified URL and sets it once the request is finished.

                  + +

                  If the image is cached locally, the image is set immediately. Otherwise the specified placeholder image will be +set immediately, and then the remote image will be set once the image request is finished.

                  + +
                  +
                  +

                  Declaration

                  +
                  +

                  Swift

                  + 
                  public func setBackgroundImage(for state: ControlState,
+                               url: URL,
+                               cacheKey: String? = nil,
+                               placeholderImage: UIImage? = nil,
+                               serializer: ImageResponseSerializer? = nil,
+                               filter: ImageFilter? = nil,
+                               progress: ImageDownloader.ProgressHandler? = nil,
+                               progressQueue: DispatchQueue = DispatchQueue.main,
+                               completion: ((AFIDataResponse<UIImage>) -> Void)? = nil)
                  + +
                  +
                  +
                  +

                  Parameters

                  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                  + + state + + +
                  +

                  The control state of the button to set the image on.

                  +
                  +
                  + + url + + +
                  +

                  The URL used for the image request.

                  +
                  +
                  + + cacheKey + + +
                  +

                  An optional key used to identify the image in the cache. Defaults to nil.

                  +
                  +
                  + + placeholderImage + + +
                  +

                  The image to be set initially until the image request finished. If nil, the + background image will not change its image until the image request finishes. + Defaults to nil.

                  +
                  +
                  + + serializer + + +
                  +

                  Image response serializer used to convert the image data to UIImage. Defaults + to nil which will fall back to the instance imageResponseSerializer set on + the ImageDownloader.

                  +
                  +
                  + + filter + + +
                  +

                  The image filter applied to the image after the image request is finished. + Defaults to nil.

                  +
                  +
                  + + progress + + +
                  +

                  The closure to be executed periodically during the lifecycle of the request. + Defaults to nil.

                  +
                  +
                  + + progressQueue + + +
                  +

                  The dispatch queue to call the progress closure on. Defaults to the main queue.

                  +
                  +
                  + + completion + + +
                  +

                  A closure to be executed when the image request finishes. The closure takes a + single response value containing either the image or the error that occurred. If + the image was returned from the image cache, the response will be nil. Defaults + to nil.

                  +
                  +
                  +
                  +
                  +
                  +
                  • +
                • + +
                  +
                  +
                  +
                  +
                  +

                  Asynchronously downloads an image from the specified URL request and sets it once the request is finished.

                  + +

                  If the image is cached locally, the image is set immediately. Otherwise the specified placeholder image will be +set immediately, and then the remote image will be set once the image request is finished.

                  + +
                  +
                  +

                  Declaration

                  +
                  +

                  Swift

                  + 
                  public func setBackgroundImage(for state: ControlState,
+                               urlRequest: URLRequestConvertible,
+                               cacheKey: String? = nil,
+                               placeholderImage: UIImage? = nil,
+                               serializer: ImageResponseSerializer? = nil,
+                               filter: ImageFilter? = nil,
+                               progress: ImageDownloader.ProgressHandler? = nil,
+                               progressQueue: DispatchQueue = DispatchQueue.main,
+                               completion: ((AFIDataResponse<UIImage>) -> Void)? = nil)
                  + +
                  +
                  +
                  +

                  Parameters

                  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                  + + state + + +
                  +

                  The control state of the button to set the image on.

                  +
                  +
                  + + urlRequest + + +
                  +

                  The URL request.

                  +
                  +
                  + + cacheKey + + +
                  +

                  An optional key used to identify the image in the cache. Defaults to nil.

                  +
                  +
                  + + placeholderImage + + +
                  +

                  The image to be set initially until the image request finished. If nil, the + background image will not change its image until the image request finishes. + Defaults to nil.

                  +
                  +
                  + + serializer + + +
                  +

                  Image response serializer used to convert the image data to UIImage. Defaults + to nil which will fall back to the instance imageResponseSerializer set on + the ImageDownloader.

                  +
                  +
                  + + filter + + +
                  +

                  The image filter applied to the image after the image request is finished. + Defaults to nil.

                  +
                  +
                  + + progress + + +
                  +

                  The closure to be executed periodically during the lifecycle of the request. + Defaults to nil.

                  +
                  +
                  + + progressQueue + + +
                  +

                  The dispatch queue to call the progress closure on. Defaults to the main queue.

                  +
                  +
                  + + completion + + +
                  +

                  A closure to be executed when the image request finishes. The closure takes a + single response value containing either the image or the error that occurred. If + the image was returned from the image cache, the response will be nil. Defaults + to nil.

                  +
                  +
                  +
                  +
                  +
                  +
                  • +
                • + +
                  +
                  +
                  +
                  +
                  +

                  Cancels the active download request for the background image, if one exists.

                  + +
                  +
                  +

                  Declaration

                  +
                  +

                  Swift

                  + 
                  public func cancelBackgroundImageRequest(for state: ControlState)
                  + +
                  +
                  +
                  +
                  +
                  • +
                +
                +
                +
                + + +
                + +

                Available where ExtendedType: UIImage

                +

                +
                +
                +
                  +
                • + +
                  +
                  +
                  +
                  +
                  +

                  Initializes and returns the image object with the specified data in a thread-safe manner.

                  + +

                  It has been reported that there are thread-safety issues when initializing large amounts of images +simultaneously. In the event of these issues occurring, this method can be used in place of +the init?(data:) method.

                  + +
                  +
                  +

                  Declaration

                  +
                  +

                  Swift

                  + 
                  public static func threadSafeImage(with data: Data) -> UIImage?
                  + +
                  +
                  +
                  +

                  Parameters

                  + + + + + + + +
                  + + data + + +
                  +

                  The data object containing the image data.

                  +
                  +
                  +
                  +
                  +

                  Return Value

                  +

                  An initialized UIImage object, or nil if the method failed.

                  +
                  +
                  +
                  +
                  • +
                • + +
                  +
                  +
                  +
                  +
                  +

                  Initializes and returns the image object with the specified data and scale in a thread-safe manner.

                  + +

                  It has been reported that there are thread-safety issues when initializing large amounts of images +simultaneously. In the event of these issues occurring, this method can be used in place of +the init?(data:scale:) method.

                  + +
                  +
                  +

                  Declaration

                  +
                  +

                  Swift

                  + 
                  public static func threadSafeImage(with data: Data, scale: CGFloat) -> UIImage?
                  + +
                  +
                  +
                  +

                  Parameters

                  + + + + + + + + + + + +
                  + + data + + +
                  +

                  The data object containing the image data.

                  +
                  +
                  + + scale + + +
                  +

                  The scale factor to assume when interpreting the image data. Applying a scale factor of 1.0 + results in an image whose size matches the pixel-based dimensions of the image. Applying a + different scale factor changes the size of the image as reported by the size property.

                  +
                  +
                  +
                  +
                  +

                  Return Value

                  +

                  An initialized UIImage object, or nil if the method failed.

                  +
                  +
                  +
                  +
                  • +
                • +
                  + + + + isInflated + +
                  +
                  +
                  +
                  +
                  +
                  +

                  Returns whether the image is inflated.

                  + +
                  +
                  +

                  Declaration

                  +
                  +

                  Swift

                  + 
                  public var isInflated: Bool { get nonmutating set }
                  + +
                  +
                  +
                  +
                  +
                  • +
                • +
                  + + + + inflate() + +
                  +
                  +
                  +
                  +
                  +
                  +

                  Inflates the underlying compressed image data to be backed by an uncompressed bitmap representation.

                  + +

                  Inflating compressed image formats (such as PNG or JPEG) can significantly improve drawing performance as it +allows a bitmap representation to be constructed in the background rather than on the main thread.

                  + +
                  +
                  +

                  Declaration

                  +
                  +

                  Swift

                  + 
                  public func inflate()
                  + +
                  +
                  +
                  +
                  +
                  • +
                • + +
                  +
                  +
                  +
                  +
                  +

                  Returns whether the image contains an alpha component.

                  + +
                  +
                  +

                  Declaration

                  +
                  +

                  Swift

                  + 
                  public var containsAlphaComponent: Bool { get }
                  + +
                  +
                  +
                  +
                  +
                  • +
                • +
                  + + + + isOpaque + +
                  +
                  +
                  +
                  +
                  +
                  +

                  Returns whether the image is opaque.

                  + +
                  +
                  +

                  Declaration

                  +
                  +

                  Swift

                  + 
                  public var isOpaque: Bool { get }
                  + +
                  +
                  +
                  +
                  +
                  • +
                • + +
                  +
                  +
                  +
                  +
                  +

                  Returns a new version of the image scaled to the specified size.

                  + +
                  +
                  +

                  Declaration

                  +
                  +

                  Swift

                  + 
                  public func imageScaled(to size: CGSize, scale: CGFloat? = nil) -> UIImage
                  + +
                  +
                  +
                  +

                  Parameters

                  + + + + + + + + + + + +
                  + + size + + +
                  +

                  The size to use when scaling the new image.

                  +
                  +
                  + + scale + + +
                  +

                  The scale to set for the new image. Defaults to nil which will maintain the current image scale.

                  +
                  +
                  +
                  +
                  +

                  Return Value

                  +

                  The new image object.

                  +
                  +
                  +
                  +
                  • +
                • + +
                  +
                  +
                  +
                  +
                  +

                  Returns a new version of the image scaled from the center while maintaining the aspect ratio to fit within +a specified size.

                  + +

                  The resulting image contains an alpha component used to pad the width or height with the necessary transparent +pixels to fit the specified size. In high performance critical situations, this may not be the optimal approach. +To maintain an opaque image, you could compute the scaledSize manually, then use the af.imageScaledToSize +method in conjunction with a .Center content mode to achieve the same visual result.

                  + +
                  +
                  +

                  Declaration

                  +
                  +

                  Swift

                  + 
                  public func imageAspectScaled(toFit size: CGSize, scale: CGFloat? = nil) -> UIImage
                  + +
                  +
                  +
                  +

                  Parameters

                  + + + + + + + + + + + +
                  + + size + + +
                  +

                  The size to use when scaling the new image.

                  +
                  +
                  + + scale + + +
                  +

                  The scale to set for the new image. Defaults to nil which will maintain the current image scale.

                  +
                  +
                  +
                  +
                  +

                  Return Value

                  +

                  A new image object.

                  +
                  +
                  +
                  +
                  • +
                • + +
                  +
                  +
                  +
                  +
                  +

                  Returns a new version of the image scaled from the center while maintaining the aspect ratio to fill a +specified size. Any pixels that fall outside the specified size are clipped.

                  + +
                  +
                  +

                  Declaration

                  +
                  +

                  Swift

                  + 
                  public func imageAspectScaled(toFill size: CGSize, scale: CGFloat? = nil) -> UIImage
                  + +
                  +
                  +
                  +

                  Parameters

                  + + + + + + + + + + + +
                  + + size + + +
                  +

                  The size to use when scaling the new image.

                  +
                  +
                  + + scale + + +
                  +

                  The scale to set for the new image. Defaults to nil which will maintain the current image scale.

                  +
                  +
                  +
                  +
                  +

                  Return Value

                  +

                  A new image object.

                  +
                  +
                  +
                  +
                  • +
                • + +
                  +
                  +
                  +
                  +
                  +

                  Returns a new version of the image with the corners rounded to the specified radius.

                  + +
                  +
                  +

                  Declaration

                  +
                  +

                  Swift

                  + 
                  public func imageRounded(withCornerRadius radius: CGFloat, divideRadiusByImageScale: Bool = false) -> UIImage
                  + +
                  +
                  +
                  +

                  Parameters

                  + + + + + + + + + + + +
                  + + radius + + +
                  +

                  The radius to use when rounding the new image.

                  +
                  +
                  + + divideRadiusByImageScale + + +
                  +

                  Whether to divide the radius by the image scale. Set to true when the image has + the same resolution for all screen scales such as @1x, @2x and @3x (i.e. single + image from web server). Set to false for images loaded from an asset catalog + with varying resolutions for each screen scale. false by default.

                  +
                  +
                  +
                  +
                  +

                  Return Value

                  +

                  A new image object.

                  +
                  +
                  +
                  +
                  • +
                • + +
                  +
                  +
                  +
                  +
                  +

                  Returns a new version of the image rounded into a circle.

                  + +
                  +
                  +

                  Declaration

                  +
                  +

                  Swift

                  + 
                  public func imageRoundedIntoCircle() -> UIImage
                  + +
                  +
                  +
                  +

                  Return Value

                  +

                  A new image object.

                  +
                  +
                  +
                  +
                  • +
                • + +
                  +
                  +
                  +
                  +
                  +

                  Returns a new version of the image using a CoreImage filter with the specified name and parameters.

                  + +
                  +
                  +

                  Declaration

                  +
                  +

                  Swift

                  + 
                  public func imageFiltered(withCoreImageFilter name: String, parameters: [String : Any]? = nil) -> UIImage?
                  + +
                  +
                  +
                  +

                  Parameters

                  + + + + + + + + + + + +
                  + + name + + +
                  +

                  The name of the CoreImage filter to use on the new image.

                  +
                  +
                  + + parameters + + +
                  +

                  The parameters to apply to the CoreImage filter.

                  +
                  +
                  +
                  +
                  +

                  Return Value

                  +

                  A new image object, or nil if the filter failed for any reason.

                  +
                  +
                  +
                  +
                  • +
                +
                +
                +
                + + +
                + +

                Properties

                +

                +
                +
                +
                  +
                • +
                  + + + + imageDownloader + +
                  +
                  +
                  +
                  +
                  +
                  +

                  The instance image downloader used to download all images. If this property is nil, the UIImageView will +fallback on the sharedImageDownloader for all downloads. The most common use case for needing to use a custom +instance image downloader is when images are behind different basic auth credentials.

                  + +
                  +
                  +

                  Declaration

                  +
                  +

                  Swift

                  + 
                  public var imageDownloader: ImageDownloader? { get nonmutating set }
                  + +
                  +
                  +
                  +
                  +
                  • +
                • +
                  + + + + sharedImageDownloader + +
                  +
                  +
                  +
                  +
                  +
                  +

                  The shared image downloader used to download all images. By default, this is the default ImageDownloader +instance backed with an AutoPurgingImageCache which automatically evicts images from the cache when the memory +capacity is reached or memory warning notifications occur. The shared image downloader is only used if the +imageDownloader is nil.

                  + +
                  +
                  +

                  Declaration

                  +
                  +

                  Swift

                  + 
                  public static var sharedImageDownloader: ImageDownloader { get set }
                  + +
                  +
                  +
                  +
                  +
                  • +
                +
                +
                +
                + + +
                + +

                Image Download

                +

                +
                +
                +
                  +
                • + +
                  +
                  +
                  +
                  +
                  +

                  Asynchronously downloads an image from the specified URL, applies the specified image filter to the downloaded +image and sets it once finished while executing the image transition.

                  + +

                  If the image is cached locally, the image is set immediately. Otherwise the specified placeholder image will be +set immediately, and then the remote image will be set once the image request is finished.

                  + +

                  The completion closure is called after the image download and filtering are complete, but before the start of +the image transition. Please note it is no longer the responsibility of the completion closure to set the +image. It will be set automatically. If you require a second notification after the image transition completes, +use a .Custom image transition with a completion closure. The .Custom completion closure is called when +the image transition is finished.

                  + +
                  +
                  +

                  Declaration

                  +
                  +

                  Swift

                  + 
                  public func setImage(withURL url: URL,
+                     cacheKey: String? = nil,
+                     placeholderImage: UIImage? = nil,
+                     serializer: ImageResponseSerializer? = nil,
+                     filter: ImageFilter? = nil,
+                     progress: ImageDownloader.ProgressHandler? = nil,
+                     progressQueue: DispatchQueue = DispatchQueue.main,
+                     imageTransition: UIImageView.ImageTransition = .noTransition,
+                     runImageTransitionIfCached: Bool = false,
+                     completion: ((AFIDataResponse<UIImage>) -> Void)? = nil)
                  + +
                  +
                  +
                  +

                  Parameters

                  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                  + + url + + +
                  +

                  The URL used for the image request.

                  +
                  +
                  + + cacheKey + + +
                  +

                  An optional key used to identify the image in the cache. Defaults + to nil.

                  +
                  +
                  + + placeholderImage + + +
                  +

                  The image to be set initially until the image request finished. If + nil, the image view will not change its image until the image + request finishes. Defaults to nil.

                  +
                  +
                  + + serializer + + +
                  +

                  Image response serializer used to convert the image data to UIImage. + Defaults to nil which will fall back to the + instance imageResponseSerializer set on the ImageDownloader.

                  +
                  +
                  + + filter + + +
                  +

                  The image filter applied to the image after the image request is + finished. Defaults to nil.

                  +
                  +
                  + + progress + + +
                  +

                  The closure to be executed periodically during the lifecycle of the + request. Defaults to nil.

                  +
                  +
                  + + progressQueue + + +
                  +

                  The dispatch queue to call the progress closure on. Defaults to the + main queue.

                  +
                  +
                  + + imageTransition + + +
                  +

                  The image transition animation applied to the image when set. + Defaults to .None.

                  +
                  +
                  + + runImageTransitionIfCached + + +
                  +

                  Whether to run the image transition if the image is cached. Defaults + to false.

                  +
                  +
                  + + completion + + +
                  +

                  A closure to be executed when the image request finishes. The closure + has no return value and takes three arguments: the original request, + the response from the server and the result containing either the + image or the error that occurred. If the image was returned from the + image cache, the response will be nil. Defaults to nil.

                  +
                  +
                  +
                  +
                  +
                  +
                  • +
                • + +
                  +
                  +
                  +
                  +
                  +

                  Asynchronously downloads an image from the specified URL Request, applies the specified image filter to the downloaded +image and sets it once finished while executing the image transition.

                  + +

                  If the image is cached locally, the image is set immediately. Otherwise the specified placeholder image will be +set immediately, and then the remote image will be set once the image request is finished.

                  + +

                  The completion closure is called after the image download and filtering are complete, but before the start of +the image transition. Please note it is no longer the responsibility of the completion closure to set the +image. It will be set automatically. If you require a second notification after the image transition completes, +use a .Custom image transition with a completion closure. The .Custom completion closure is called when +the image transition is finished.

                  + +
                  +
                  +

                  Declaration

                  +
                  +

                  Swift

                  + 
                  public func setImage(withURLRequest urlRequest: URLRequestConvertible,
+                     cacheKey: String? = nil,
+                     placeholderImage: UIImage? = nil,
+                     serializer: ImageResponseSerializer? = nil,
+                     filter: ImageFilter? = nil,
+                     progress: ImageDownloader.ProgressHandler? = nil,
+                     progressQueue: DispatchQueue = DispatchQueue.main,
+                     imageTransition: UIImageView.ImageTransition = .noTransition,
+                     runImageTransitionIfCached: Bool = false,
+                     completion: ((AFIDataResponse<UIImage>) -> Void)? = nil)
                  + +
                  +
                  +
                  +

                  Parameters

                  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                  + + urlRequest + + +
                  +

                  The URL request.

                  +
                  +
                  + + cacheKey + + +
                  +

                  An optional key used to identify the image in the cache. Defaults + to nil.

                  +
                  +
                  + + placeholderImage + + +
                  +

                  The image to be set initially until the image request finished. If + nil, the image view will not change its image until the image + request finishes. Defaults to nil.

                  +
                  +
                  + + serializer + + +
                  +

                  Image response serializer used to convert the image data to UIImage. + Defaults to nil which will fall back to the + instance imageResponseSerializer set on the ImageDownloader.

                  +
                  +
                  + + filter + + +
                  +

                  The image filter applied to the image after the image request is + finished. Defaults to nil.

                  +
                  +
                  + + progress + + +
                  +

                  The closure to be executed periodically during the lifecycle of the + request. Defaults to nil.

                  +
                  +
                  + + progressQueue + + +
                  +

                  The dispatch queue to call the progress closure on. Defaults to the + main queue.

                  +
                  +
                  + + imageTransition + + +
                  +

                  The image transition animation applied to the image when set. + Defaults to .None.

                  +
                  +
                  + + runImageTransitionIfCached + + +
                  +

                  Whether to run the image transition if the image is cached. Defaults + to false.

                  +
                  +
                  + + completion + + +
                  +

                  A closure to be executed when the image request finishes. The closure + has no return value and takes three arguments: the original request, + the response from the server and the result containing either the + image or the error that occurred. If the image was returned from the + image cache, the response will be nil. Defaults to nil.

                  +
                  +
                  +
                  +
                  +
                  +
                  • +
                +
                +
                +
                + + +
                + +

                Image Download Cancellation

                +

                +
                +
                +
                  +
                • +
                  + + + + cancelImageRequest() + +
                  +
                  +
                  +
                  +
                  +
                  +

                  Cancels the active download request, if one exists.

                  + +
                  +
                  +

                  Declaration

                  +
                  +

                  Swift

                  + 
                  public func cancelImageRequest()
                  + +
                  +
                  +
                  +
                  +
                  • +
                +
                +
                +
                + + +
                + +

                Image Transition

                +

                +
                +
                +
                  +
                • +
                  + + + + run(_:with:) + +
                  +
                  +
                  +
                  +
                  +
                  +

                  Runs the image transition on the image view with the specified image.

                  + +
                  +
                  +

                  Declaration

                  +
                  +

                  Swift

                  + 
                  public func run(_ imageTransition: UIImageView.ImageTransition, with image: Image)
                  + +
                  +
                  +
                  +

                  Parameters

                  + + + + + + + + + + + +
                  + + imageTransition + + +
                  +

                  The image transition to ran on the image view.

                  +
                  +
                  + + image + + +
                  +

                  The image to use for the image transition.

                  +
                  +
                  +
                  +
                  +
                  +
                  • +
                +
                +
                +
                + +
                +
                +
                +

                © 2020 Alamofire Software Foundation. All rights reserved. (Last updated: 2020-02-23)

                +

                Generated by jazzy ♪♫ v0.13.1, a Realm project.

                +
                + + + diff --git a/docs/Extensions/DataRequest.html b/docs/Extensions/DataRequest.html index ed9dd935..46e7f623 100644 --- a/docs/Extensions/DataRequest.html +++ b/docs/Extensions/DataRequest.html @@ -23,7 +23,7 @@ AlamofireImage Docs - (85% documented) + (77% documented)

                @@ -87,6 +87,9 @@

              • Extensions
                  +
                • + AlamofireExtension +
                • DataRequest
                  • @@ -202,7 +205,7 @@
                  -
                  +

                  DataRequest

                  @@ -239,8 +242,8 @@

                  DataRequest

                  -

                  © 2019 Alamofire Software Foundation. All rights reserved. (Last updated: 2019-10-27)

                  -

                  Generated by jazzy ♪♫ v0.11.2, a Realm project.

                  +

                  © 2020 Alamofire Software Foundation. All rights reserved. (Last updated: 2020-02-23)

                  +

                  Generated by jazzy ♪♫ v0.13.1, a Realm project.

                  diff --git a/docs/Extensions/UIButton.html b/docs/Extensions/UIButton.html index 769a0f0c..9c195d9f 100644 --- a/docs/Extensions/UIButton.html +++ b/docs/Extensions/UIButton.html @@ -23,7 +23,7 @@ AlamofireImage Docs - (85% documented) + (77% documented)

                  @@ -87,6 +87,9 @@

                • Extensions
                    +
                  • + AlamofireExtension +
                  • DataRequest
                    • @@ -202,11 +205,11 @@
                    -
                    +

                    UIButton

                    - 
                    extension UIButton
                    + 
                    extension UIButton: AlamofireExtended
                    @@ -218,11 +221,13 @@

                    UIButton

                    - - - -

                    Properties

                    -                     + + +
                    + +

                    Deprecated

                    +

                    +
                    • @@ -238,9 +243,7 @@

                      Properties

                      -

                      The instance image downloader used to download all images. If this property is nil, the UIButton will -fallback on the af_sharedImageDownloader for all downloads. The most common use case for needing to use a -custom instance image downloader is when images are behind different basic auth credentials.

                      +

                      Undocumented

                      @@ -267,10 +270,7 @@

                      Declaration

                      -

                      The shared image downloader used to download all images. By default, this is the default ImageDownloader -instance backed with an AutoPurgingImageCache which automatically evicts images from the cache when the memory -capacity is reached or memory warning notifications occur. The shared image downloader is only used if the -af_imageDownloader is nil.

                      +

                      Undocumented

                      @@ -284,23 +284,12 @@

                      Declaration

                      • -
                    -
                    -
                    -
                    - - - -

                    Image Downloads

                    -                     -
                    -
                    • @@ -308,134 +297,34 @@

                      Image Downloads

                      -

                      Asynchronously downloads an image from the specified URL and sets it once the request is finished.

                      - -

                      If the image is cached locally, the image is set immediately. Otherwise the specified placeholder image will be -set immediately, and then the remote image will be set once the image request is finished.

                      +

                      Undocumented

                      Declaration

                      Swift

                      - 
                      public func af_setImage(
-    for state: ControlState,
-    url: URL,
-    placeholderImage: UIImage? = nil,
-    filter: ImageFilter? = nil,
-    progress: ImageDownloader.ProgressHandler? = nil,
-    progressQueue: DispatchQueue = DispatchQueue.main,
-    completion: ((AFIDataResponse<UIImage>) -> Void)? = nil)
                      + 
                      public func af_setImage(for state: ControlState,
+                        url: URL,
+                        cacheKey: String? = nil,
+                        placeholderImage: UIImage? = nil,
+                        serializer: ImageResponseSerializer? = nil,
+                        filter: ImageFilter? = nil,
+                        progress: ImageDownloader.ProgressHandler? = nil,
+                        progressQueue: DispatchQueue = DispatchQueue.main,
+                        completion: ((AFIDataResponse<UIImage>) -> Void)? = nil)
                      -
                      -

                      Parameters

                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                      - - state - - -
                      -

                      The control state of the button to set the image on.

                      -
                      -
                      - - url - - -
                      -

                      The URL used for your image request.

                      -
                      -
                      - - placeholderImage - - -
                      -

                      The image to be set initially until the image request finished. If nil, the - image will not change its image until the image request finishes. Defaults - to nil.

                      -
                      -
                      - - filter - - -
                      -

                      The image filter applied to the image after the image request is finished. - Defaults to nil.

                      -
                      -
                      - - progress - - -
                      -

                      The closure to be executed periodically during the lifecycle of the request. - Defaults to nil.

                      -
                      -
                      - - progressQueue - - -
                      -

                      The dispatch queue to call the progress closure on. Defaults to the main queue.

                      -
                      -
                      - - completion - - -
                      -

                      A closure to be executed when the image request finishes. The closure takes a - single response value containing either the image or the error that occurred. If - the image was returned from the image cache, the response will be nil. Defaults - to nil.

                      -
                      -
                      -
                    • @@ -443,125 +332,25 @@

                      Parameters

                      -

                      Asynchronously downloads an image from the specified URL request and sets it once the request is finished.

                      - -

                      If the image is cached locally, the image is set immediately. Otherwise the specified placeholder image will be -set immediately, and then the remote image will be set once the image request is finished.

                      +

                      Undocumented

                      Declaration

                      Swift

                      - 
                      public func af_setImage(
-    for state: ControlState,
-    urlRequest: URLRequestConvertible,
-    placeholderImage: UIImage? = nil,
-    filter: ImageFilter? = nil,
-    progress: ImageDownloader.ProgressHandler? = nil,
-    progressQueue: DispatchQueue = DispatchQueue.main,
-    completion: ((AFIDataResponse<UIImage>) -> Void)? = nil)
                      + 
                      public func af_setImage(for state: ControlState,
+                        urlRequest: URLRequestConvertible,
+                        cacheKey: String? = nil,
+                        placeholderImage: UIImage? = nil,
+                        serializer: ImageResponseSerializer? = nil,
+                        filter: ImageFilter? = nil,
+                        progress: ImageDownloader.ProgressHandler? = nil,
+                        progressQueue: DispatchQueue = DispatchQueue.main,
+                        completion: ((AFIDataResponse<UIImage>) -> Void)? = nil)
                      -
                      -

                      Parameters

                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                      - - state - - -
                      -

                      The control state of the button to set the image on.

                      -
                      -
                      - - urlRequest - - -
                      -

                      The URL request.

                      -
                      -
                      - - placeholderImage - - -
                      -

                      The image to be set initially until the image request finished. If nil, the - image will not change its image until the image request finishes. Defaults - to nil.

                      -
                      -
                      - - filter - - -
                      -

                      The image filter applied to the image after the image request is finished. - Defaults to nil.

                      -
                      -
                      - - progress - - -
                      -

                      The closure to be executed periodically during the lifecycle of the request. - Defaults to nil.

                      -
                      -
                      - - progressQueue - - -
                      -

                      The dispatch queue to call the progress closure on. Defaults to the main queue.

                      -
                      -
                      - - completion - - -
                      -

                      A closure to be executed when the image request finishes. The closure takes a - single response value containing either the image or the error that occurred. If - the image was returned from the image cache, the response will be nil. Defaults - to nil.

                      -
                      -
                      -
                      • @@ -592,23 +381,12 @@

                      Declaration

                    -
                  - -
                  -
                  - - - -

                  Background Image Downloads

                  -                   -
                  -
                  • @@ -616,134 +394,34 @@

                    Background Image Downloads

                    -

                    Asynchronously downloads an image from the specified URL and sets it once the request is finished.

                    - -

                    If the image is cached locally, the image is set immediately. Otherwise the specified placeholder image will be -set immediately, and then the remote image will be set once the image request is finished.

                    +

                    Undocumented

                    Declaration

                    Swift

                    - 
                    public func af_setBackgroundImage(
-    for state: ControlState,
-    url: URL,
-    placeholderImage: UIImage? = nil,
-    filter: ImageFilter? = nil,
-    progress: ImageDownloader.ProgressHandler? = nil,
-    progressQueue: DispatchQueue = DispatchQueue.main,
-    completion: ((AFIDataResponse<UIImage>) -> Void)? = nil)
                    + 
                    public func af_setBackgroundImage(for state: ControlState,
+                                  url: URL,
+                                  cacheKey: String? = nil,
+                                  placeholderImage: UIImage? = nil,
+                                  serializer: ImageResponseSerializer? = nil,
+                                  filter: ImageFilter? = nil,
+                                  progress: ImageDownloader.ProgressHandler? = nil,
+                                  progressQueue: DispatchQueue = DispatchQueue.main,
+                                  completion: ((AFIDataResponse<UIImage>) -> Void)? = nil)
                    -
                    -

                    Parameters

                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                    - - state - - -
                    -

                    The control state of the button to set the image on.

                    -
                    -
                    - - url - - -
                    -

                    The URL used for the image request.

                    -
                    -
                    - - placeholderImage - - -
                    -

                    The image to be set initially until the image request finished. If nil, the - background image will not change its image until the image request finishes. - Defaults to nil.

                    -
                    -
                    - - filter - - -
                    -

                    The image filter applied to the image after the image request is finished. - Defaults to nil.

                    -
                    -
                    - - progress - - -
                    -

                    The closure to be executed periodically during the lifecycle of the request. - Defaults to nil.

                    -
                    -
                    - - progressQueue - - -
                    -

                    The dispatch queue to call the progress closure on. Defaults to the main queue.

                    -
                    -
                    - - completion - - -
                    -

                    A closure to be executed when the image request finishes. The closure takes a - single response value containing either the image or the error that occurred. If - the image was returned from the image cache, the response will be nil. Defaults - to nil.

                    -
                    -
                    -
                  • @@ -751,125 +429,25 @@

                    Parameters

                    -

                    Asynchronously downloads an image from the specified URL request and sets it once the request is finished.

                    - -

                    If the image is cached locally, the image is set immediately. Otherwise the specified placeholder image will be -set immediately, and then the remote image will be set once the image request is finished.

                    +

                    Undocumented

                    Declaration

                    Swift

                    - 
                    public func af_setBackgroundImage(
-    for state: ControlState,
-    urlRequest: URLRequestConvertible,
-    placeholderImage: UIImage? = nil,
-    filter: ImageFilter? = nil,
-    progress: ImageDownloader.ProgressHandler? = nil,
-    progressQueue: DispatchQueue = DispatchQueue.main,
-    completion: ((AFIDataResponse<UIImage>) -> Void)? = nil)
                    + 
                    public func af_setBackgroundImage(for state: ControlState,
+                                  urlRequest: URLRequestConvertible,
+                                  cacheKey: String? = nil,
+                                  placeholderImage: UIImage? = nil,
+                                  serializer: ImageResponseSerializer? = nil,
+                                  filter: ImageFilter? = nil,
+                                  progress: ImageDownloader.ProgressHandler? = nil,
+                                  progressQueue: DispatchQueue = DispatchQueue.main,
+                                  completion: ((AFIDataResponse<UIImage>) -> Void)? = nil)
                    -
                    -

                    Parameters

                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                    - - state - - -
                    -

                    The control state of the button to set the image on.

                    -
                    -
                    - - urlRequest - - -
                    -

                    The URL request.

                    -
                    -
                    - - placeholderImage - - -
                    -

                    The image to be set initially until the image request finished. If nil, the - background image will not change its image until the image request finishes. - Defaults to nil.

                    -
                    -
                    - - filter - - -
                    -

                    The image filter applied to the image after the image request is finished. - Defaults to nil.

                    -
                    -
                    - - progress - - -
                    -

                    The closure to be executed periodically during the lifecycle of the request. - Defaults to nil.

                    -
                    -
                    - - progressQueue - - -
                    -

                    The dispatch queue to call the progress closure on. Defaults to the main queue.

                    -
                    -
                    - - completion - - -
                    -

                    A closure to be executed when the image request finishes. The closure takes a - single response value containing either the image or the error that occurred. If - the image was returned from the image cache, the response will be nil. Defaults - to nil.

                    -
                    -
                    -
                    • @@ -908,8 +486,8 @@

                    Declaration

                  -

                  © 2019 Alamofire Software Foundation. All rights reserved. (Last updated: 2019-10-27)

                  -

                  Generated by jazzy ♪♫ v0.11.2, a Realm project.

                  +

                  © 2020 Alamofire Software Foundation. All rights reserved. (Last updated: 2020-02-23)

                  +

                  Generated by jazzy ♪♫ v0.13.1, a Realm project.

                  diff --git a/docs/Extensions/UIImage.html b/docs/Extensions/UIImage.html index 01ba0904..f9709431 100644 --- a/docs/Extensions/UIImage.html +++ b/docs/Extensions/UIImage.html @@ -23,7 +23,7 @@ AlamofireImage Docs - (85% documented) + (77% documented)

                  @@ -87,6 +87,9 @@

                • Extensions
                    +
                  • + AlamofireExtension +
                  • DataRequest
                    • @@ -202,11 +205,11 @@
                    -
                    +

                    UIImage

                    - 
                    extension UIImage
                    + 
                    extension UIImage: AlamofireExtended
                    @@ -217,6 +220,15 @@

                    UIImage

                    +
                    + + +
                    + +

                    Initialization

                    +

                    +
                    +
                    • @@ -231,11 +243,7 @@

                      UIImage

                      -

                      Initializes and returns the image object with the specified data in a thread-safe manner.

                      - -

                      It has been reported that there are thread-safety issues when initializing large amounts of images -simultaneously. In the event of these issues occurring, this method can be used in place of -the init?(data:) method.

                      +

                      Undocumented

                      @@ -246,29 +254,6 @@

                      Declaration

                      -
                      -

                      Parameters

                      - - - - - - - -
                      - - data - - -
                      -

                      The data object containing the image data.

                      -
                      -
                      -
                      -
                      -

                      Return Value

                      -

                      An initialized UIImage object, or nil if the method failed.

                      -
                    @@ -285,11 +270,7 @@

                    Return Value

                    -

                    Initializes and returns the image object with the specified data and scale in a thread-safe manner.

                    - -

                    It has been reported that there are thread-safety issues when initializing large amounts of images -simultaneously. In the event of these issues occurring, this method can be used in place of -the init?(data:scale:) method.

                    +

                    Undocumented

                    @@ -300,49 +281,21 @@

                    Declaration

                    -
                    -

                    Parameters

                    - - - - - - - - - - - -
                    - - data - - -
                    -

                    The data object containing the image data.

                    -
                    -
                    - - scale - - -
                    -

                    The scale factor to assume when interpreting the image data. Applying a scale factor of 1.0 - results in an image whose size matches the pixel-based dimensions of the image. Applying a - different scale factor changes the size of the image as reported by the size property.

                    -
                    -
                    -
                    -
                    -

                    Return Value

                    -

                    An initialized UIImage object, or nil if the method failed.

                    -
                  +
                  + + +
                  + +

                  Inflation

                  +

                  +
                  +
                  • @@ -357,14 +310,14 @@

                    Return Value

                    -

                    Returns whether the image is inflated.

                    +

                    Undocumented

                    Declaration

                    Swift

                    - 
                    public var af_inflated: Bool { get set }
                    + 
                    public var af_inflated: Bool { get }
                    @@ -384,10 +337,7 @@

                    Declaration

                    -

                    Inflates the underlying compressed image data to be backed by an uncompressed bitmap representation.

                    - -

                    Inflating compressed image formats (such as PNG or JPEG) can significantly improve drawing performance as it -allows a bitmap representation to be constructed in the background rather than on the main thread.

                    +

                    Undocumented

                    @@ -404,6 +354,15 @@

                    Declaration

                  +
                  + + +
                  + +

                  Alpha

                  +

                  +
                  +
                  • @@ -418,7 +377,7 @@

                    Declaration

                    -

                    Returns whether the image contains an alpha component.

                    +

                    Undocumented

                    @@ -445,7 +404,7 @@

                    Declaration

                    -

                    Returns whether the image is opaque.

                    +

                    Undocumented

                    @@ -462,13 +421,22 @@

                    Declaration

                  +
                  + + +
                  + +

                  Scaling

                  +

                  +
                  +
                  • @@ -476,49 +444,26 @@

                    Declaration

                    -

                    Returns a new version of the image scaled to the specified size.

                    +

                    Undocumented

                    Declaration

                    Swift

                    - 
                    public func af_imageScaled(to size: CGSize) -> UIImage
                    + 
                    public func af_imageScaled(to size: CGSize, scale: CGFloat? = nil) -> UIImage
                    -
                    -

                    Parameters

                    - - - - - - - -
                    - - size - - -
                    -

                    The size to use when scaling the new image.

                    -
                    -
                    -
                    -
                    -

                    Return Value

                    -

                    A new image object.

                    -
                  • @@ -526,55 +471,26 @@

                    Return Value

                    -

                    Returns a new version of the image scaled from the center while maintaining the aspect ratio to fit within -a specified size.

                    - -

                    The resulting image contains an alpha component used to pad the width or height with the necessary transparent -pixels to fit the specified size. In high performance critical situations, this may not be the optimal approach. -To maintain an opaque image, you could compute the scaledSize manually, then use the af_imageScaledToSize -method in conjunction with a .Center content mode to achieve the same visual result.

                    +

                    Undocumented

                    Declaration

                    Swift

                    - 
                    public func af_imageAspectScaled(toFit size: CGSize) -> UIImage
                    + 
                    public func af_imageAspectScaled(toFit size: CGSize, scale: CGFloat? = nil) -> UIImage
                    -
                    -

                    Parameters

                    - - - - - - - -
                    - - size - - -
                    -

                    The size to use when scaling the new image.

                    -
                    -
                    -
                    -
                    -

                    Return Value

                    -

                    A new image object.

                    -
                  • @@ -582,47 +498,32 @@

                    Return Value

                    -

                    Returns a new version of the image scaled from the center while maintaining the aspect ratio to fill a -specified size. Any pixels that fall outside the specified size are clipped.

                    +

                    Undocumented

                    Declaration

                    Swift

                    - 
                    public func af_imageAspectScaled(toFill size: CGSize) -> UIImage
                    + 
                    public func af_imageAspectScaled(toFill size: CGSize, scale: CGFloat? = nil) -> UIImage
                    -
                    -

                    Parameters

                    - - - - - - - -
                    - - size - - -
                    -

                    The size to use when scaling the new image.

                    -
                    -
                    -
                    -
                    -

                    Return Value

                    -

                    A new image object.

                    -
                  +
                  + + +
                  + +

                  Rounded Corners

                  +

                  +
                  +
                  • @@ -637,7 +538,7 @@

                    Return Value

                    -

                    Returns a new version of the image with the corners rounded to the specified radius.

                    +

                    Undocumented

                    @@ -648,45 +549,6 @@

                    Declaration

                    -
                    -

                    Parameters

                    - - - - - - - - - - - -
                    - - radius - - -
                    -

                    The radius to use when rounding the new image.

                    -
                    -
                    - - divideRadiusByImageScale - - -
                    -

                    Whether to divide the radius by the image scale. Set to true when the - image has the same resolution for all screen scales such as @1x, @2x and - @3x (i.e. single image from web server). Set to false for images loaded - from an asset catalog with varying resolutions for each screen scale. - false by default.

                    -
                    -
                    -
                    -
                    -

                    Return Value

                    -

                    A new image object.

                    -
                  • @@ -703,7 +565,7 @@

                  Return Value

                  -

                  Returns a new version of the image rounded into a circle.

                  +

                  Undocumented

                  @@ -714,16 +576,21 @@

                  Declaration

                  -
                  -

                  Return Value

                  -

                  A new image object.

                  -
                +
                + + +
                + +

                Core Image Filters

                +

                +
                +
                • @@ -738,7 +605,7 @@

                  Return Value

                  -

                  Returns a new version of the image using a CoreImage filter with the specified name and parameters.

                  +

                  Undocumented

                  @@ -749,41 +616,6 @@

                  Declaration

                  -
                  -

                  Parameters

                  - - - - - - - - - - - -
                  - - name - - -
                  -

                  The name of the CoreImage filter to use on the new image.

                  -
                  -
                  - - parameters - - -
                  -

                  The parameters to apply to the CoreImage filter.

                  -
                  -
                  -
                  -
                  -

                  Return Value

                  -

                  A new image object, or nil if the filter failed for any reason.

                  -
                • @@ -795,8 +627,8 @@

                Return Value

                -

                © 2019 Alamofire Software Foundation. All rights reserved. (Last updated: 2019-10-27)

                -

                Generated by jazzy ♪♫ v0.11.2, a Realm project.

                +

                © 2020 Alamofire Software Foundation. All rights reserved. (Last updated: 2020-02-23)

                +

                Generated by jazzy ♪♫ v0.13.1, a Realm project.

                diff --git a/docs/Extensions/UIImageView.html b/docs/Extensions/UIImageView.html index ebd01849..b10b61b1 100644 --- a/docs/Extensions/UIImageView.html +++ b/docs/Extensions/UIImageView.html @@ -23,7 +23,7 @@ AlamofireImage Docs - (85% documented) + (77% documented)

                @@ -87,6 +87,9 @@

              • Extensions
                  +
                • + AlamofireExtension +
                • DataRequest
                  • @@ -202,11 +205,12 @@
                  -
                  +

                  UIImageView

                  extension UIImageView
                  +
                  extension UIImageView: AlamofireExtended
                  @@ -217,13 +221,6 @@

                  UIImageView

                  -
                  - - - -

                  ImageTransition

                  -                   -
                  • @@ -257,11 +254,13 @@

                    Declaration

                    - - - -

                    Associated Properties

                    -                     + + +
                    + +

                    Deprecated

                    +

                    +
                    • @@ -277,9 +276,7 @@

                      Associated Properties

                      -

                      The instance image downloader used to download all images. If this property is nil, the UIImageView will -fallback on the af_sharedImageDownloader for all downloads. The most common use case for needing to use a -custom instance image downloader is when images are behind different basic auth credentials.

                      +

                      Undocumented

                      @@ -306,10 +303,7 @@

                      Declaration

                      -

                      The shared image downloader used to download all images. By default, this is the default ImageDownloader -instance backed with an AutoPurgingImageCache which automatically evicts images from the cache when the memory -capacity is reached or memory warning notifications occur. The shared image downloader is only used if the -af_imageDownloader is nil.

                      +

                      Undocumented

                      @@ -323,23 +317,12 @@

                      Declaration

                      • -
                    -
                    -
                    -
                    - - - -

                    Image Download

                    -                     -
                    -
                    • @@ -347,158 +330,35 @@

                      Image Download

                      -

                      Asynchronously downloads an image from the specified URL, applies the specified image filter to the downloaded -image and sets it once finished while executing the image transition.

                      - -

                      If the image is cached locally, the image is set immediately. Otherwise the specified placeholder image will be -set immediately, and then the remote image will be set once the image request is finished.

                      - -

                      The completion closure is called after the image download and filtering are complete, but before the start of -the image transition. Please note it is no longer the responsibility of the completion closure to set the -image. It will be set automatically. If you require a second notification after the image transition completes, -use a .Custom image transition with a completion closure. The .Custom completion closure is called when -the image transition is finished.

                      +

                      Undocumented

                      Declaration

                      Swift

                      - 
                      public func af_setImage(
-    withURL url: URL,
-    placeholderImage: UIImage? = nil,
-    filter: ImageFilter? = nil,
-    progress: ImageDownloader.ProgressHandler? = nil,
-    progressQueue: DispatchQueue = DispatchQueue.main,
-    imageTransition: ImageTransition = .noTransition,
-    runImageTransitionIfCached: Bool = false,
-    completion: ((AFIDataResponse<UIImage>) -> Void)? = nil)
                      + 
                      public func af_setImage(withURL url: URL,
+                        cacheKey: String? = nil,
+                        placeholderImage: UIImage? = nil,
+                        serializer: ImageResponseSerializer? = nil,
+                        filter: ImageFilter? = nil,
+                        progress: ImageDownloader.ProgressHandler? = nil,
+                        progressQueue: DispatchQueue = DispatchQueue.main,
+                        imageTransition: ImageTransition = .noTransition,
+                        runImageTransitionIfCached: Bool = false,
+                        completion: ((AFIDataResponse<UIImage>) -> Void)? = nil)
                      -
                      -

                      Parameters

                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                      - - url - - -
                      -

                      The URL used for the image request.

                      -
                      -
                      - - placeholderImage - - -
                      -

                      The image to be set initially until the image request finished. If - nil, the image view will not change its image until the image - request finishes. Defaults to nil.

                      -
                      -
                      - - filter - - -
                      -

                      The image filter applied to the image after the image request is - finished. Defaults to nil.

                      -
                      -
                      - - progress - - -
                      -

                      The closure to be executed periodically during the lifecycle of the - request. Defaults to nil.

                      -
                      -
                      - - progressQueue - - -
                      -

                      The dispatch queue to call the progress closure on. Defaults to the - main queue.

                      -
                      -
                      - - imageTransition - - -
                      -

                      The image transition animation applied to the image when set. - Defaults to .None.

                      -
                      -
                      - - runImageTransitionIfCached - - -
                      -

                      Whether to run the image transition if the image is cached. Defaults - to false.

                      -
                      -
                      - - completion - - -
                      -

                      A closure to be executed when the image request finishes. The closure - has no return value and takes three arguments: the original request, - the response from the server and the result containing either the - image or the error that occurred. If the image was returned from the - image cache, the response will be nil. Defaults to nil.

                      -
                      -
                      -
                    • @@ -506,163 +366,29 @@

                      Parameters

                      -

                      Asynchronously downloads an image from the specified URL Request, applies the specified image filter to the downloaded -image and sets it once finished while executing the image transition.

                      - -

                      If the image is cached locally, the image is set immediately. Otherwise the specified placeholder image will be -set immediately, and then the remote image will be set once the image request is finished.

                      - -

                      The completion closure is called after the image download and filtering are complete, but before the start of -the image transition. Please note it is no longer the responsibility of the completion closure to set the -image. It will be set automatically. If you require a second notification after the image transition completes, -use a .Custom image transition with a completion closure. The .Custom completion closure is called when -the image transition is finished.

                      +

                      Undocumented

                      Declaration

                      Swift

                      - 
                      public func af_setImage(
-    withURLRequest urlRequest: URLRequestConvertible,
-    placeholderImage: UIImage? = nil,
-    filter: ImageFilter? = nil,
-    progress: ImageDownloader.ProgressHandler? = nil,
-    progressQueue: DispatchQueue = DispatchQueue.main,
-    imageTransition: ImageTransition = .noTransition,
-    runImageTransitionIfCached: Bool = false,
-    completion: ((AFIDataResponse<UIImage>) -> Void)? = nil)
                      + 
                      public func af_setImage(withURLRequest urlRequest: URLRequestConvertible,
+                        cacheKey: String? = nil,
+                        placeholderImage: UIImage? = nil,
+                        serializer: ImageResponseSerializer? = nil,
+                        filter: ImageFilter? = nil,
+                        progress: ImageDownloader.ProgressHandler? = nil,
+                        progressQueue: DispatchQueue = DispatchQueue.main,
+                        imageTransition: ImageTransition = .noTransition,
+                        runImageTransitionIfCached: Bool = false,
+                        completion: ((AFIDataResponse<UIImage>) -> Void)? = nil)
                      -
                      -

                      Parameters

                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                      - - urlRequest - - -
                      -

                      The URL request.

                      -
                      -
                      - - placeholderImage - - -
                      -

                      The image to be set initially until the image request finished. If - nil, the image view will not change its image until the image - request finishes. Defaults to nil.

                      -
                      -
                      - - filter - - -
                      -

                      The image filter applied to the image after the image request is - finished. Defaults to nil.

                      -
                      -
                      - - progress - - -
                      -

                      The closure to be executed periodically during the lifecycle of the - request. Defaults to nil.

                      -
                      -
                      - - progressQueue - - -
                      -

                      The dispatch queue to call the progress closure on. Defaults to the - main queue.

                      -
                      -
                      - - imageTransition - - -
                      -

                      The image transition animation applied to the image when set. - Defaults to .None.

                      -
                      -
                      - - runImageTransitionIfCached - - -
                      -

                      Whether to run the image transition if the image is cached. Defaults - to false.

                      -
                      -
                      - - completion - - -
                      -

                      A closure to be executed when the image request finishes. The closure - has no return value and takes three arguments: the original request, - the response from the server and the result containing either the - image or the error that occurred. If the image was returned from the - image cache, the response will be nil. Defaults to nil.

                      -
                      -
                      -
                      • -
                    -
                    -
                    -
                    - - - -

                    Image Download Cancellation

                    -                     -
                    -
                    • @@ -676,7 +402,7 @@

                      Image Download Cancellation

                      -

                      Cancels the active download request, if one exists.

                      +

                      Undocumented

                      @@ -690,17 +416,6 @@

                      Declaration

                      • -
                    -
                    -
                    -
                    - - - -

                    Image Transition

                    -                     -
                    -
                    • @@ -714,7 +429,7 @@

                      Image Transition

                      -

                      Runs the image transition on the image view with the specified image.

                      +

                      Undocumented

                      @@ -725,37 +440,6 @@

                      Declaration

                      -
                      -

                      Parameters

                      - - - - - - - - - - - -
                      - - imageTransition - - -
                      -

                      The image transition to ran on the image view.

                      -
                      -
                      - - image - - -
                      -

                      The image to use for the image transition.

                      -
                      -
                      -
                  @@ -767,8 +451,8 @@

                  Parameters

                  -

                  © 2019 Alamofire Software Foundation. All rights reserved. (Last updated: 2019-10-27)

                  -

                  Generated by jazzy ♪♫ v0.11.2, a Realm project.

                  +

                  © 2020 Alamofire Software Foundation. All rights reserved. (Last updated: 2020-02-23)

                  +

                  Generated by jazzy ♪♫ v0.13.1, a Realm project.

                  diff --git a/docs/Extensions/UIImageView/ImageTransition.html b/docs/Extensions/UIImageView/ImageTransition.html index 34c149b6..4b917fc9 100644 --- a/docs/Extensions/UIImageView/ImageTransition.html +++ b/docs/Extensions/UIImageView/ImageTransition.html @@ -23,7 +23,7 @@ AlamofireImage Docs - (85% documented) + (77% documented)

                  @@ -87,6 +87,9 @@

                • Extensions
                    +
                  • + AlamofireExtension +
                  • DataRequest
                    • @@ -202,7 +205,7 @@
                    -
                    +

                    ImageTransition

                    @@ -536,7 +539,7 @@

                    Declaration

                    Declaration

                    Swift

                    - 
                    public var animations: ((UIImageView, Image) -> Void) { get }
                    + 
                    public var animations: (UIImageView, Image) -> Void { get }
                    @@ -578,8 +581,8 @@

                    Declaration

                    -

                    © 2019 Alamofire Software Foundation. All rights reserved. (Last updated: 2019-10-27)

                    -

                    Generated by jazzy ♪♫ v0.11.2, a Realm project.

                    +

                    © 2020 Alamofire Software Foundation. All rights reserved. (Last updated: 2020-02-23)

                    +

                    Generated by jazzy ♪♫ v0.13.1, a Realm project.

                    diff --git a/docs/Protocols.html b/docs/Protocols.html index d2c9ec4b..af72684c 100644 --- a/docs/Protocols.html +++ b/docs/Protocols.html @@ -23,7 +23,7 @@ AlamofireImage Docs - (85% documented) + (77% documented)

                    @@ -87,6 +87,9 @@

                  • Extensions
                      +
                    • + AlamofireExtension +
                    • DataRequest
                      • @@ -202,7 +205,7 @@
                      -
                      +

                      Protocols

                      The following protocols are available globally.

                      @@ -215,9 +218,11 @@

                      Protocols

                      - -

                      ImageCache

                      -                       +
                      + +

                      ImageCache

                      +

                      +
                      -

                      © 2019 Alamofire Software Foundation. All rights reserved. (Last updated: 2019-10-27)

                      -

                      Generated by jazzy ♪♫ v0.11.2, a Realm project.

                      +

                      © 2020 Alamofire Software Foundation. All rights reserved. (Last updated: 2020-02-23)

                      +

                      Generated by jazzy ♪♫ v0.13.1, a Realm project.

                      diff --git a/docs/Protocols/CompositeImageFilter.html b/docs/Protocols/CompositeImageFilter.html index 0357abf0..1671bc9d 100644 --- a/docs/Protocols/CompositeImageFilter.html +++ b/docs/Protocols/CompositeImageFilter.html @@ -23,7 +23,7 @@ AlamofireImage Docs - (85% documented) + (77% documented)

                      @@ -87,6 +87,9 @@

                    • Extensions
                        +
                      • + AlamofireExtension +
                      • DataRequest
                        • @@ -202,7 +205,7 @@
                        -
                        +

                        CompositeImageFilter

                        @@ -252,9 +255,11 @@

                        Declaration

                        - -

                        CompositeImageFilter

                        -                         +
                        + +

                        CompositeImageFilter

                        +

                        +
                        • @@ -325,8 +330,8 @@

                          Declaration

                        -

                        © 2019 Alamofire Software Foundation. All rights reserved. (Last updated: 2019-10-27)

                        -

                        Generated by jazzy ♪♫ v0.11.2, a Realm project.

                        +

                        © 2020 Alamofire Software Foundation. All rights reserved. (Last updated: 2020-02-23)

                        +

                        Generated by jazzy ♪♫ v0.13.1, a Realm project.

                        diff --git a/docs/Protocols/CoreImageFilter.html b/docs/Protocols/CoreImageFilter.html index abc3b936..0b8dc0a3 100644 --- a/docs/Protocols/CoreImageFilter.html +++ b/docs/Protocols/CoreImageFilter.html @@ -23,7 +23,7 @@ AlamofireImage Docs - (85% documented) + (77% documented)

                        @@ -87,6 +87,9 @@

                      • Extensions
                          +
                        • + AlamofireExtension +
                        • DataRequest
                          • @@ -202,7 +205,7 @@
                          -
                          +

                          CoreImageFilter

                          @@ -282,8 +285,8 @@

                          Declaration

                          -

                          © 2019 Alamofire Software Foundation. All rights reserved. (Last updated: 2019-10-27)

                          -

                          Generated by jazzy ♪♫ v0.11.2, a Realm project.

                          +

                          © 2020 Alamofire Software Foundation. All rights reserved. (Last updated: 2020-02-23)

                          +

                          Generated by jazzy ♪♫ v0.13.1, a Realm project.

                          diff --git a/docs/Protocols/ImageCache.html b/docs/Protocols/ImageCache.html index 658762ae..684fb672 100644 --- a/docs/Protocols/ImageCache.html +++ b/docs/Protocols/ImageCache.html @@ -23,7 +23,7 @@ AlamofireImage Docs - (85% documented) + (77% documented)

                          @@ -87,6 +87,9 @@

                        • Extensions
                            +
                          • + AlamofireExtension +
                          • DataRequest
                            • @@ -202,7 +205,7 @@
                            -
                            +

                            ImageCache

                            @@ -336,8 +339,8 @@

                            Declaration

                            -

                            © 2019 Alamofire Software Foundation. All rights reserved. (Last updated: 2019-10-27)

                            -

                            Generated by jazzy ♪♫ v0.11.2, a Realm project.

                            +

                            © 2020 Alamofire Software Foundation. All rights reserved. (Last updated: 2020-02-23)

                            +

                            Generated by jazzy ♪♫ v0.13.1, a Realm project.

                            diff --git a/docs/Protocols/ImageFilter.html b/docs/Protocols/ImageFilter.html index 5577cf96..397ee220 100644 --- a/docs/Protocols/ImageFilter.html +++ b/docs/Protocols/ImageFilter.html @@ -23,7 +23,7 @@ AlamofireImage Docs - (85% documented) + (77% documented)

                            @@ -87,6 +87,9 @@

                          • Extensions
                              +
                            • + AlamofireExtension +
                            • DataRequest
                              • @@ -202,7 +205,7 @@
                              -
                              +

                              ImageFilter

                              @@ -225,6 +228,33 @@

                              ImageFilter

                              filter + +
                              +
                              +
                              +
                              +
                              +
                              +

                              A closure used to create an alternative representation of the given image.

                              + +
                              +
                              +

                              Declaration

                              +
                              +

                              Swift

                              + 
                              var filter: (Image) -> Image { get }
                              + +
                              +
                              +
                              +
                              + +
                            • +
                              + + + + identifier Default implementation @@ -235,8 +265,149 @@

                              ImageFilter

                              -

                              A closure used to create an alternative representation of the given image.

                              +

                              The string used to uniquely identify the filter operation.

                              + +
                              +

                              Default Implementation

                              +
                              +

                              The unique identifier for any ImageFilter type.

                              + +
                              +
                              +

                              Declaration

                              +
                              +

                              Swift

                              + 
                              var identifier: String { get }
                              + +
                              +
                              +
                              +
                              +
                              • +
                            + +
                            +
                            + + +
                            + +

                            Available where Self: Sizable

                            +

                            +
                            +
                            +
                              +
                            • +
                              + + + + identifier + + + Default implementation + +
                              +
                              +
                              +
                              +
                              +
                              + +
                              +

                              Default Implementation

                              +
                              +

                              The unique idenitifier for an ImageFilter conforming to the Sizable protocol.

                              +
                              +
                              +

                              Declaration

                              +
                              +

                              Swift

                              + 
                              public var identifier: String { get }
                              + +
                              +
                              +
                              +
                              +
                              • +
                            +
                            +
                            +
                            + + +
                            + +

                            Available where Self: Roundable

                            +

                            +
                            +
                            +
                              +
                            • +
                              + + + + identifier + + + Default implementation + +
                              +
                              +
                              +
                              +
                              +
                              + +
                              +

                              Default Implementation

                              +
                              +

                              The unique idenitifier for an ImageFilter conforming to the Roundable protocol.

                              + +
                              +
                              +

                              Declaration

                              +
                              +

                              Swift

                              + 
                              public var identifier: String { get }
                              + +
                              +
                              +
                              +
                              +
                              • +
                            +
                            +
                            +
                            + + +
                            + +

                            Available where Self: CoreImageFilter

                            +

                            +
                            +
                            +
                            -

                            © 2019 Alamofire Software Foundation. All rights reserved. (Last updated: 2019-10-27)

                            -

                            Generated by jazzy ♪♫ v0.11.2, a Realm project.

                            +

                            © 2020 Alamofire Software Foundation. All rights reserved. (Last updated: 2020-02-23)

                            +

                            Generated by jazzy ♪♫ v0.13.1, a Realm project.

                            diff --git a/docs/Protocols/Sizable.html b/docs/Protocols/Sizable.html index b8c7b482..f90f379a 100644 --- a/docs/Protocols/Sizable.html +++ b/docs/Protocols/Sizable.html @@ -23,7 +23,7 @@ AlamofireImage Docs - (85% documented) + (77% documented)

                            @@ -87,6 +87,9 @@

                          • Extensions
                              +
                            • + AlamofireExtension +
                            • DataRequest
                              • @@ -202,7 +205,7 @@
                              -
                              +

                              Sizable

                              @@ -254,8 +257,8 @@

                              Declaration

                              -

                              © 2019 Alamofire Software Foundation. All rights reserved. (Last updated: 2019-10-27)

                              -

                              Generated by jazzy ♪♫ v0.11.2, a Realm project.

                              +

                              © 2020 Alamofire Software Foundation. All rights reserved. (Last updated: 2020-02-23)

                              +

                              Generated by jazzy ♪♫ v0.13.1, a Realm project.

                              diff --git a/docs/Structs.html b/docs/Structs.html index b9a42c4b..d27c5840 100644 --- a/docs/Structs.html +++ b/docs/Structs.html @@ -23,7 +23,7 @@ AlamofireImage Docs - (85% documented) + (77% documented)

                              @@ -87,6 +87,9 @@

                            • Extensions - -
                              -
                              • @@ -391,10 +396,6 @@

                                Declaration

                                • -
                              -
                              -
                              -
                              • @@ -423,10 +424,6 @@

                                Declaration

                                • -
                              -
                              -
                              -
                              • @@ -455,10 +452,6 @@

                                Declaration

                                • -
                              -
                              -
                              - -
                              -
                              -
                              • @@ -592,10 +583,6 @@

                                Declaration

                                • -
                              -
                              -
                              -
                              diff --git a/docs/Structs/AspectScaledToFillSizeCircleFilter.html b/docs/Structs/AspectScaledToFillSizeCircleFilter.html index 8e2c8b01..6bfccc08 100644 --- a/docs/Structs/AspectScaledToFillSizeCircleFilter.html +++ b/docs/Structs/AspectScaledToFillSizeCircleFilter.html @@ -23,7 +23,7 @@ AlamofireImage Docs - (85% documented) + (77% documented)

                              @@ -87,6 +87,9 @@

                            • Extensions
                                +
                              • + AlamofireExtension +
                              • DataRequest
                                • @@ -202,7 +205,7 @@
                                -
                                +

                                AspectScaledToFillSizeCircleFilter

                                @@ -305,8 +308,8 @@

                                Declaration

                                -

                                © 2019 Alamofire Software Foundation. All rights reserved. (Last updated: 2019-10-27)

                                -

                                Generated by jazzy ♪♫ v0.11.2, a Realm project.

                                +

                                © 2020 Alamofire Software Foundation. All rights reserved. (Last updated: 2020-02-23)

                                +

                                Generated by jazzy ♪♫ v0.13.1, a Realm project.

                                diff --git a/docs/Structs/AspectScaledToFillSizeFilter.html b/docs/Structs/AspectScaledToFillSizeFilter.html index 1d71a0df..13f0084d 100644 --- a/docs/Structs/AspectScaledToFillSizeFilter.html +++ b/docs/Structs/AspectScaledToFillSizeFilter.html @@ -23,7 +23,7 @@ AlamofireImage Docs - (85% documented) + (77% documented)

                                @@ -87,6 +87,9 @@

                              • Extensions
                                  +
                                • + AlamofireExtension +
                                • DataRequest
                                  • @@ -202,7 +205,7 @@
                                  -
                                  +

                                  AspectScaledToFillSizeFilter

                                  @@ -332,8 +335,8 @@

                                  Declaration

                                  -

                                  © 2019 Alamofire Software Foundation. All rights reserved. (Last updated: 2019-10-27)

                                  -

                                  Generated by jazzy ♪♫ v0.11.2, a Realm project.

                                  +

                                  © 2020 Alamofire Software Foundation. All rights reserved. (Last updated: 2020-02-23)

                                  +

                                  Generated by jazzy ♪♫ v0.13.1, a Realm project.

                                  diff --git a/docs/Structs/AspectScaledToFillSizeWithRoundedCornersFilter.html b/docs/Structs/AspectScaledToFillSizeWithRoundedCornersFilter.html index 241d09f8..e3998de9 100644 --- a/docs/Structs/AspectScaledToFillSizeWithRoundedCornersFilter.html +++ b/docs/Structs/AspectScaledToFillSizeWithRoundedCornersFilter.html @@ -23,7 +23,7 @@ AlamofireImage Docs - (85% documented) + (77% documented)

                                  @@ -87,6 +87,9 @@

                                • Extensions
                                    +
                                  • + AlamofireExtension +
                                  • DataRequest
                                    • @@ -202,7 +205,7 @@
                                    -
                                    +

                                    AspectScaledToFillSizeWithRoundedCornersFilter

                                    @@ -333,8 +336,8 @@

                                    Declaration

                                    -

                                    © 2019 Alamofire Software Foundation. All rights reserved. (Last updated: 2019-10-27)

                                    -

                                    Generated by jazzy ♪♫ v0.11.2, a Realm project.

                                    +

                                    © 2020 Alamofire Software Foundation. All rights reserved. (Last updated: 2020-02-23)

                                    +

                                    Generated by jazzy ♪♫ v0.13.1, a Realm project.

                                    diff --git a/docs/Structs/AspectScaledToFitSizeFilter.html b/docs/Structs/AspectScaledToFitSizeFilter.html index dfbc8c90..c1c1f54e 100644 --- a/docs/Structs/AspectScaledToFitSizeFilter.html +++ b/docs/Structs/AspectScaledToFitSizeFilter.html @@ -23,7 +23,7 @@ AlamofireImage Docs - (85% documented) + (77% documented)

                                    @@ -87,6 +87,9 @@

                                  • Extensions
                                      +
                                    • + AlamofireExtension +
                                    • DataRequest
                                      • @@ -202,7 +205,7 @@
                                      -
                                      +

                                      AspectScaledToFitSizeFilter

                                      @@ -331,8 +334,8 @@

                                      Declaration

                                      -

                                      © 2019 Alamofire Software Foundation. All rights reserved. (Last updated: 2019-10-27)

                                      -

                                      Generated by jazzy ♪♫ v0.11.2, a Realm project.

                                      +

                                      © 2020 Alamofire Software Foundation. All rights reserved. (Last updated: 2020-02-23)

                                      +

                                      Generated by jazzy ♪♫ v0.13.1, a Realm project.

                                      diff --git a/docs/Structs/BlurFilter.html b/docs/Structs/BlurFilter.html index b72dd026..97bd2090 100644 --- a/docs/Structs/BlurFilter.html +++ b/docs/Structs/BlurFilter.html @@ -23,7 +23,7 @@ AlamofireImage Docs - (85% documented) + (77% documented)

                                      @@ -87,6 +87,9 @@

                                    • Extensions
                                        +
                                      • + AlamofireExtension +
                                      • DataRequest
                                        • @@ -202,7 +205,7 @@
                                        -
                                        +

                                        BlurFilter

                                        @@ -332,8 +335,8 @@

                                        Return Value

                                        -

                                        © 2019 Alamofire Software Foundation. All rights reserved. (Last updated: 2019-10-27)

                                        -

                                        Generated by jazzy ♪♫ v0.11.2, a Realm project.

                                        +

                                        © 2020 Alamofire Software Foundation. All rights reserved. (Last updated: 2020-02-23)

                                        +

                                        Generated by jazzy ♪♫ v0.13.1, a Realm project.

                                        diff --git a/docs/Structs/CircleFilter.html b/docs/Structs/CircleFilter.html index 5ed12103..02bd5b9d 100644 --- a/docs/Structs/CircleFilter.html +++ b/docs/Structs/CircleFilter.html @@ -23,7 +23,7 @@ AlamofireImage Docs - (85% documented) + (77% documented)

                                        @@ -87,6 +87,9 @@

                                      • Extensions
                                          +
                                        • + AlamofireExtension +
                                        • DataRequest
                                          • @@ -202,7 +205,7 @@
                                          -
                                          +

                                          CircleFilter

                                          @@ -285,8 +288,8 @@

                                          Declaration

                                          -

                                          © 2019 Alamofire Software Foundation. All rights reserved. (Last updated: 2019-10-27)

                                          -

                                          Generated by jazzy ♪♫ v0.11.2, a Realm project.

                                          +

                                          © 2020 Alamofire Software Foundation. All rights reserved. (Last updated: 2020-02-23)

                                          +

                                          Generated by jazzy ♪♫ v0.13.1, a Realm project.

                                          diff --git a/docs/Structs/DynamicCompositeImageFilter.html b/docs/Structs/DynamicCompositeImageFilter.html index 696e69cf..80b3a6ff 100644 --- a/docs/Structs/DynamicCompositeImageFilter.html +++ b/docs/Structs/DynamicCompositeImageFilter.html @@ -23,7 +23,7 @@ AlamofireImage Docs - (85% documented) + (77% documented)

                                          @@ -87,6 +87,9 @@

                                        • Extensions
                                            +
                                          • + AlamofireExtension +
                                          • DataRequest
                                            • @@ -202,7 +205,7 @@
                                            -
                                            +

                                            DynamicCompositeImageFilter

                                            @@ -354,8 +357,8 @@

                                            Return Value

                                            -

                                            © 2019 Alamofire Software Foundation. All rights reserved. (Last updated: 2019-10-27)

                                            -

                                            Generated by jazzy ♪♫ v0.11.2, a Realm project.

                                            +

                                            © 2020 Alamofire Software Foundation. All rights reserved. (Last updated: 2020-02-23)

                                            +

                                            Generated by jazzy ♪♫ v0.13.1, a Realm project.

                                            diff --git a/docs/Structs/DynamicImageFilter.html b/docs/Structs/DynamicImageFilter.html index 32c4bc0e..6c6d2504 100644 --- a/docs/Structs/DynamicImageFilter.html +++ b/docs/Structs/DynamicImageFilter.html @@ -23,7 +23,7 @@ AlamofireImage Docs - (85% documented) + (77% documented)

                                            @@ -87,6 +87,9 @@

                                          • Extensions
                                              +
                                            • + AlamofireExtension +
                                            • DataRequest
                                              • @@ -202,7 +205,7 @@
                                              -
                                              +

                                              DynamicImageFilter

                                              @@ -343,8 +346,8 @@

                                              Return Value

                                              -

                                              © 2019 Alamofire Software Foundation. All rights reserved. (Last updated: 2019-10-27)

                                              -

                                              Generated by jazzy ♪♫ v0.11.2, a Realm project.

                                              +

                                              © 2020 Alamofire Software Foundation. All rights reserved. (Last updated: 2020-02-23)

                                              +

                                              Generated by jazzy ♪♫ v0.13.1, a Realm project.

                                              diff --git a/docs/Structs/RoundedCornersFilter.html b/docs/Structs/RoundedCornersFilter.html index c74e03ca..6811f147 100644 --- a/docs/Structs/RoundedCornersFilter.html +++ b/docs/Structs/RoundedCornersFilter.html @@ -23,7 +23,7 @@ AlamofireImage Docs - (85% documented) + (77% documented)

                                              @@ -87,6 +87,9 @@

                                            • Extensions
                                                +
                                              • + AlamofireExtension +
                                              • DataRequest
                                                • @@ -202,7 +205,7 @@
                                                -
                                                +

                                                RoundedCornersFilter

                                                @@ -401,8 +404,8 @@

                                                Declaration

                                                -

                                                © 2019 Alamofire Software Foundation. All rights reserved. (Last updated: 2019-10-27)

                                                -

                                                Generated by jazzy ♪♫ v0.11.2, a Realm project.

                                                +

                                                © 2020 Alamofire Software Foundation. All rights reserved. (Last updated: 2020-02-23)

                                                +

                                                Generated by jazzy ♪♫ v0.13.1, a Realm project.

                                                diff --git a/docs/Structs/ScaledToSizeCircleFilter.html b/docs/Structs/ScaledToSizeCircleFilter.html index 23acf8da..a66133f6 100644 --- a/docs/Structs/ScaledToSizeCircleFilter.html +++ b/docs/Structs/ScaledToSizeCircleFilter.html @@ -23,7 +23,7 @@ AlamofireImage Docs - (85% documented) + (77% documented)

                                                @@ -87,6 +87,9 @@

                                              • Extensions
                                                  +
                                                • + AlamofireExtension +
                                                • DataRequest
                                                  • @@ -202,7 +205,7 @@
                                                  -
                                                  +

                                                  ScaledToSizeCircleFilter

                                                  @@ -304,8 +307,8 @@

                                                  Declaration

                                                  -

                                                  © 2019 Alamofire Software Foundation. All rights reserved. (Last updated: 2019-10-27)

                                                  -

                                                  Generated by jazzy ♪♫ v0.11.2, a Realm project.

                                                  +

                                                  © 2020 Alamofire Software Foundation. All rights reserved. (Last updated: 2020-02-23)

                                                  +

                                                  Generated by jazzy ♪♫ v0.13.1, a Realm project.

                                                  diff --git a/docs/Structs/ScaledToSizeFilter.html b/docs/Structs/ScaledToSizeFilter.html index 95532280..17c39dbb 100644 --- a/docs/Structs/ScaledToSizeFilter.html +++ b/docs/Structs/ScaledToSizeFilter.html @@ -23,7 +23,7 @@ AlamofireImage Docs - (85% documented) + (77% documented)

                                                  @@ -87,6 +87,9 @@

                                                • Extensions
                                                    +
                                                  • + AlamofireExtension +
                                                  • DataRequest
                                                    • @@ -202,7 +205,7 @@
                                                    -
                                                    +

                                                    ScaledToSizeFilter

                                                    @@ -331,8 +334,8 @@

                                                    Declaration

                                                    -

                                                    © 2019 Alamofire Software Foundation. All rights reserved. (Last updated: 2019-10-27)

                                                    -

                                                    Generated by jazzy ♪♫ v0.11.2, a Realm project.

                                                    +

                                                    © 2020 Alamofire Software Foundation. All rights reserved. (Last updated: 2020-02-23)

                                                    +

                                                    Generated by jazzy ♪♫ v0.13.1, a Realm project.

                                                    diff --git a/docs/Structs/ScaledToSizeWithRoundedCornersFilter.html b/docs/Structs/ScaledToSizeWithRoundedCornersFilter.html index 09114efc..b5330a83 100644 --- a/docs/Structs/ScaledToSizeWithRoundedCornersFilter.html +++ b/docs/Structs/ScaledToSizeWithRoundedCornersFilter.html @@ -23,7 +23,7 @@ AlamofireImage Docs - (85% documented) + (77% documented)

                                                    @@ -87,6 +87,9 @@

                                                  • Extensions
                                                      +
                                                    • + AlamofireExtension +
                                                    • DataRequest
                                                      • @@ -202,7 +205,7 @@
                                                      -
                                                      +

                                                      ScaledToSizeWithRoundedCornersFilter

                                                      @@ -332,8 +335,8 @@

                                                      Declaration

                                                      -

                                                      © 2019 Alamofire Software Foundation. All rights reserved. (Last updated: 2019-10-27)

                                                      -

                                                      Generated by jazzy ♪♫ v0.11.2, a Realm project.

                                                      +

                                                      © 2020 Alamofire Software Foundation. All rights reserved. (Last updated: 2020-02-23)

                                                      +

                                                      Generated by jazzy ♪♫ v0.13.1, a Realm project.

                                                      diff --git a/docs/Typealiases.html b/docs/Typealiases.html index d4c5c868..44501bd9 100644 --- a/docs/Typealiases.html +++ b/docs/Typealiases.html @@ -23,7 +23,7 @@ AlamofireImage Docs - (85% documented) + (77% documented)

                                                      @@ -87,6 +87,9 @@

                                                    • Extensions
                                                        +
                                                      • + AlamofireExtension +
                                                      • DataRequest
                                                        • @@ -202,7 +205,7 @@
                                                        -
                                                        +

                                                        Type Aliases

                                                        The following type aliases are available globally.

                                                        @@ -258,10 +261,6 @@

                                                        Declaration

                                                        -
                                                      - -
                                                      -
                                                      • @@ -316,10 +315,6 @@

                                                        Declaration

                                                        • -
                                                      -
                                                      -
                                                      -
                                                      • @@ -347,10 +342,6 @@

                                                        Declaration

                                                        • -
                                                      -
                                                      -
                                                      -
                                                      diff --git a/docs/badge.svg b/docs/badge.svg index 09c23006..f6985a8a 100644 --- a/docs/badge.svg +++ b/docs/badge.svg @@ -8,7 +8,7 @@ - + @@ -19,10 +19,10 @@ documentation - 85% + 77% - 85% + 77% diff --git a/docs/css/jazzy.css b/docs/css/jazzy.css index 833be0d2..3ca6b317 100644 --- a/docs/css/jazzy.css +++ b/docs/css/jazzy.css @@ -94,10 +94,10 @@ pre { code { font-family: Consolas, "Liberation Mono", Menlo, Courier, monospace; } -p > code, li > code { +.item-container p > code, .item-container li > code, .top-matter p > code, .top-matter li > code { background: #f7f7f7; padding: .2em; } - p > code:before, p > code:after, li > code:before, li > code:after { + .item-container p > code:before, .item-container p > code:after, .item-container li > code:before, .item-container li > code:after, .top-matter p > code:before, .top-matter p > code:after, .top-matter li > code:before, .top-matter li > code:after { letter-spacing: -.2em; content: "\00a0"; } @@ -201,6 +201,8 @@ pre code { .section-name { color: #666; display: block; } + .section-name p { + margin-bottom: inherit; } .declaration .highlight { overflow-x: initial; @@ -219,6 +221,22 @@ pre code { content: ""; display: block; } +.section-name-container { + position: relative; } + .section-name-container .section-name-link { + position: absolute; + top: 0; + left: 0; + bottom: 0; + right: 0; + margin-bottom: 0; } + .section-name-container .section-name { + position: relative; + pointer-events: none; + z-index: 1; } + .section-name-container .section-name a { + pointer-events: auto; } + .item-container { padding: 0; } diff --git a/docs/docsets/AlamofireImage.docset/Contents/Resources/Documents/Classes.html b/docs/docsets/AlamofireImage.docset/Contents/Resources/Documents/Classes.html index c437e3fc..8a243be5 100644 --- a/docs/docsets/AlamofireImage.docset/Contents/Resources/Documents/Classes.html +++ b/docs/docsets/AlamofireImage.docset/Contents/Resources/Documents/Classes.html @@ -23,7 +23,7 @@ AlamofireImage Docs - (85% documented) + (77% documented)

                                                      @@ -87,6 +87,9 @@

                                                    • Extensions
                                                        +
                                                      • + AlamofireExtension +
                                                      • DataRequest
                                                        • @@ -202,7 +205,7 @@
                                                        -
                                                        +

                                                        Classes

                                                        The following classes are available globally.

                                                        @@ -244,10 +247,6 @@

                                                        Declaration

                                                        -
                                                      - -
                                                      -
                                                      • @@ -279,10 +278,6 @@

                                                        Declaration

                                                        • -
                                                      -
                                                      -
                                                      -
                                                      • @@ -316,10 +311,6 @@

                                                        Declaration

                                                        • -
                                                      -
                                                      -
                                                      -
                                                      diff --git a/docs/docsets/AlamofireImage.docset/Contents/Resources/Documents/Classes/AutoPurgingImageCache.html b/docs/docsets/AlamofireImage.docset/Contents/Resources/Documents/Classes/AutoPurgingImageCache.html index ee286399..96eeebfe 100644 --- a/docs/docsets/AlamofireImage.docset/Contents/Resources/Documents/Classes/AutoPurgingImageCache.html +++ b/docs/docsets/AlamofireImage.docset/Contents/Resources/Documents/Classes/AutoPurgingImageCache.html @@ -23,7 +23,7 @@ AlamofireImage Docs - (85% documented) + (77% documented)

                                                      @@ -87,6 +87,9 @@

                                                    • Extensions
                                                        +
                                                      • + AlamofireExtension +
                                                      • DataRequest
                                                        • @@ -202,7 +205,7 @@
                                                        -
                                                        +

                                                        AutoPurgingImageCache

                                                        @@ -224,9 +227,11 @@

                                                        AutoPurgingImageCache

                                                        - -

                                                        Properties

                                                        -                                                         +
                                                        + +

                                                        Properties

                                                        +

                                                        +
                                                        -

                                                        © 2019 Alamofire Software Foundation. All rights reserved. (Last updated: 2019-10-27)

                                                        -

                                                        Generated by jazzy ♪♫ v0.11.2, a Realm project.

                                                        +

                                                        © 2020 Alamofire Software Foundation. All rights reserved. (Last updated: 2020-02-23)

                                                        +

                                                        Generated by jazzy ♪♫ v0.13.1, a Realm project.

                                                        diff --git a/docs/docsets/AlamofireImage.docset/Contents/Resources/Documents/Classes/ImageDownloader.html b/docs/docsets/AlamofireImage.docset/Contents/Resources/Documents/Classes/ImageDownloader.html index c4b9c44c..153b96a1 100644 --- a/docs/docsets/AlamofireImage.docset/Contents/Resources/Documents/Classes/ImageDownloader.html +++ b/docs/docsets/AlamofireImage.docset/Contents/Resources/Documents/Classes/ImageDownloader.html @@ -23,7 +23,7 @@ AlamofireImage Docs - (85% documented) + (77% documented)

                                                        @@ -87,6 +87,9 @@

                                                      • Extensions
                                                          +
                                                        • + AlamofireExtension +
                                                        • DataRequest
                                                          • @@ -202,7 +205,7 @@
                                                          -
                                                          +

                                                          ImageDownloader

                                                          @@ -284,9 +287,11 @@

                                                          Declaration

                                                          - -

                                                          Helper Types

                                                          -                                                           +
                                                          + +

                                                          Helper Types

                                                          +

                                                          +
                                                          @@ -654,11 +662,10 @@

                                                          Return Value

                                                          Declaration

                                                          Swift

                                                          - 
                                                          public init(
-    session: Session,
-    downloadPrioritization: DownloadPrioritization = .fifo,
-    maximumActiveDownloads: Int = 4,
-    imageCache: ImageRequestCache? = AutoPurgingImageCache())
                                                          + 
                                                          public init(session: Session,
+            downloadPrioritization: DownloadPrioritization = .fifo,
+            maximumActiveDownloads: Int = 4,
+            imageCache: ImageRequestCache? = AutoPurgingImageCache())
                                                          @@ -730,9 +737,11 @@

                                                          Return Value

                                                          - -

                                                          Authentication

                                                          -                                                           +
                                                          + +

                                                          Authentication

                                                          +

                                                          +
                                                          • @@ -755,10 +764,9 @@

                                                            Authentication

                                                            Declaration

                                                            Swift

                                                            - 
                                                            open func addAuthentication(
-    user: String,
-    password: String,
-    persistence: URLCredential.Persistence = .forSession)
                                                            + 
                                                            open func addAuthentication(user: String,
+                            password: String,
+                            persistence: URLCredential.Persistence = .forSession)
                                                          @@ -860,17 +868,19 @@

                                                          Parameters

                                                          - -

                                                          Download

                                                          -                                                           +
                                                          + +

                                                          Download

                                                          +

                                                          +
                                                          + + + + serializer + + + +
                                                          +

                                                          Image response serializer used to convert the image data to UIImage. Defaults + to nil which will fall back to the instance imageResponseSerializer.

                                                          +
                                                          + + @@ -1030,12 +1066,11 @@

                                                          Declaration

                                                          Swift

                                                          @discardableResult
-open func download(
-    _ urlRequests: [URLRequestConvertible],
-    filter: ImageFilter? = nil,
-    progress: ProgressHandler? = nil,
-    progressQueue: DispatchQueue = DispatchQueue.main,
-    completion: CompletionHandler? = nil)
+open func download(_ urlRequests: [URLRequestConvertible],
+                   filter: ImageFilter? = nil,
+                   progress: ProgressHandler? = nil,
+                   progressQueue: DispatchQueue = DispatchQueue.main,
+                   completion: CompletionHandler? = nil)
     -> [RequestReceipt]
                                                          @@ -1118,11 +1153,7 @@

                                                          Return Value

                                                          -

                                                          Cancels the request in the receipt by removing the response handler and cancelling the request if necessary.

                                                          - -

                                                          If the request is pending in the queue, it will be cancelled if no other response handlers are registered with -the request. If the request is currently executing or is already completed, the response handler is removed and -will not be called.

                                                          +

                                                          Cancels the request contained inside the receipt calls the completion handler with a request cancelled error.

                                                          @@ -1163,8 +1194,8 @@

                                                          Parameters

                                                          -

                                                          © 2019 Alamofire Software Foundation. All rights reserved. (Last updated: 2019-10-27)

                                                          -

                                                          Generated by jazzy ♪♫ v0.11.2, a Realm project.

                                                          +

                                                          © 2020 Alamofire Software Foundation. All rights reserved. (Last updated: 2020-02-23)

                                                          +

                                                          Generated by jazzy ♪♫ v0.13.1, a Realm project.

                                                          diff --git a/docs/docsets/AlamofireImage.docset/Contents/Resources/Documents/Classes/ImageDownloader/DownloadPrioritization.html b/docs/docsets/AlamofireImage.docset/Contents/Resources/Documents/Classes/ImageDownloader/DownloadPrioritization.html index 7dd62722..32d8009c 100644 --- a/docs/docsets/AlamofireImage.docset/Contents/Resources/Documents/Classes/ImageDownloader/DownloadPrioritization.html +++ b/docs/docsets/AlamofireImage.docset/Contents/Resources/Documents/Classes/ImageDownloader/DownloadPrioritization.html @@ -23,7 +23,7 @@ AlamofireImage Docs - (85% documented) + (77% documented)

                                                          @@ -87,6 +87,9 @@

                                                        • Extensions
                                                            +
                                                          • + AlamofireExtension +
                                                          • DataRequest
                                                            • @@ -202,7 +205,7 @@
                                                            -
                                                            +

                                                            DownloadPrioritization

                                                            @@ -286,8 +289,8 @@

                                                            Declaration

                                                            -

                                                            © 2019 Alamofire Software Foundation. All rights reserved. (Last updated: 2019-10-27)

                                                            -

                                                            Generated by jazzy ♪♫ v0.11.2, a Realm project.

                                                            +

                                                            © 2020 Alamofire Software Foundation. All rights reserved. (Last updated: 2020-02-23)

                                                            +

                                                            Generated by jazzy ♪♫ v0.13.1, a Realm project.

                                                            diff --git a/docs/docsets/AlamofireImage.docset/Contents/Resources/Documents/Classes/ImageResponseSerializer.html b/docs/docsets/AlamofireImage.docset/Contents/Resources/Documents/Classes/ImageResponseSerializer.html index 187e6518..0d59400a 100644 --- a/docs/docsets/AlamofireImage.docset/Contents/Resources/Documents/Classes/ImageResponseSerializer.html +++ b/docs/docsets/AlamofireImage.docset/Contents/Resources/Documents/Classes/ImageResponseSerializer.html @@ -23,7 +23,7 @@ AlamofireImage Docs - (85% documented) + (77% documented)

                                                            @@ -87,6 +87,9 @@

                                                          • Extensions
                                                              +
                                                            • + AlamofireExtension +
                                                            • DataRequest
                                                              • @@ -202,7 +205,7 @@
                                                              -
                                                              +

                                                              ImageResponseSerializer

                                                              @@ -221,9 +224,11 @@

                                                              ImageResponseSerializer

                                                              - -

                                                              Properties

                                                              -                                                               +
                                                              + +

                                                              Properties

                                                              +

                                                              +
                                                              • @@ -365,9 +370,11 @@

                                                                Declaration

                                                                - -

                                                                Initialization

                                                                -                                                                 +
                                                                + +

                                                                Initialization

                                                                +

                                                                +
                                                                • @@ -390,11 +397,10 @@

                                                                  Initialization

                                                                  Declaration

                                                                  Swift

                                                                  - 
                                                                  public init(
-    imageScale: CGFloat = ImageResponseSerializer.deviceScreenScale,
-    inflateResponseImage: Bool = true,
-    emptyResponseCodes: Set<Int> = ImageResponseSerializer.defaultEmptyResponseCodes,
-    emptyRequestMethods: Set<HTTPMethod> = ImageResponseSerializer.defaultEmptyRequestMethods)
                                                                  + 
                                                                  public init(imageScale: CGFloat = ImageResponseSerializer.deviceScreenScale,
+            inflateResponseImage: Bool = true,
+            emptyResponseCodes: Set<Int> = ImageResponseSerializer.defaultEmptyResponseCodes,
+            emptyRequestMethods: Set<HTTPMethod> = ImageResponseSerializer.defaultEmptyRequestMethods)
                                                              @@ -407,9 +413,11 @@

                                                              Declaration

                                                              - -

                                                              Serialization

                                                              -                                                               +
                                                              + +

                                                              Serialization

                                                              +

                                                              +
                                                              -

                                                              © 2019 Alamofire Software Foundation. All rights reserved. (Last updated: 2019-10-27)

                                                              -

                                                              Generated by jazzy ♪♫ v0.11.2, a Realm project.

                                                              +

                                                              © 2020 Alamofire Software Foundation. All rights reserved. (Last updated: 2020-02-23)

                                                              +

                                                              Generated by jazzy ♪♫ v0.13.1, a Realm project.

                                                              diff --git a/docs/docsets/AlamofireImage.docset/Contents/Resources/Documents/Classes/RequestReceipt.html b/docs/docsets/AlamofireImage.docset/Contents/Resources/Documents/Classes/RequestReceipt.html index bf393811..5699cfd4 100644 --- a/docs/docsets/AlamofireImage.docset/Contents/Resources/Documents/Classes/RequestReceipt.html +++ b/docs/docsets/AlamofireImage.docset/Contents/Resources/Documents/Classes/RequestReceipt.html @@ -23,7 +23,7 @@ AlamofireImage Docs - (85% documented) + (77% documented)

                                                              @@ -87,6 +87,9 @@

                                                            • Extensions
                                                                +
                                                              • + AlamofireExtension +
                                                              • DataRequest
                                                                • @@ -202,7 +205,7 @@
                                                                -
                                                                +

                                                                RequestReceipt

                                                                @@ -284,8 +287,8 @@

                                                                Declaration

                                                                -

                                                                © 2019 Alamofire Software Foundation. All rights reserved. (Last updated: 2019-10-27)

                                                                -

                                                                Generated by jazzy ♪♫ v0.11.2, a Realm project.

                                                                +

                                                                © 2020 Alamofire Software Foundation. All rights reserved. (Last updated: 2020-02-23)

                                                                +

                                                                Generated by jazzy ♪♫ v0.13.1, a Realm project.

                                                                diff --git a/docs/docsets/AlamofireImage.docset/Contents/Resources/Documents/Enums.html b/docs/docsets/AlamofireImage.docset/Contents/Resources/Documents/Enums.html index 1937669e..518f0bb7 100644 --- a/docs/docsets/AlamofireImage.docset/Contents/Resources/Documents/Enums.html +++ b/docs/docsets/AlamofireImage.docset/Contents/Resources/Documents/Enums.html @@ -23,7 +23,7 @@ AlamofireImage Docs - (85% documented) + (77% documented)

                                                                @@ -87,6 +87,9 @@

                                                              • Extensions
                                                                  +
                                                                • + AlamofireExtension +
                                                                • DataRequest
                                                                  • @@ -202,7 +205,7 @@
                                                                  -
                                                                  +

                                                                  Enumerations

                                                                  The following enumerations are available globally.

                                                                  @@ -240,6 +243,7 @@

                                                                  Declaration

                                                                  Swift

                                                                  public enum AFIError : Error
                                                                  +
                                                                  extension AFIError: LocalizedError
                                                                  @@ -254,8 +258,8 @@

                                                                  Declaration

                                                                  -

                                                                  © 2019 Alamofire Software Foundation. All rights reserved. (Last updated: 2019-10-27)

                                                                  -

                                                                  Generated by jazzy ♪♫ v0.11.2, a Realm project.

                                                                  +

                                                                  © 2020 Alamofire Software Foundation. All rights reserved. (Last updated: 2020-02-23)

                                                                  +

                                                                  Generated by jazzy ♪♫ v0.13.1, a Realm project.

                                                                  diff --git a/docs/docsets/AlamofireImage.docset/Contents/Resources/Documents/Enums/AFIError.html b/docs/docsets/AlamofireImage.docset/Contents/Resources/Documents/Enums/AFIError.html index e51ece82..ae969642 100644 --- a/docs/docsets/AlamofireImage.docset/Contents/Resources/Documents/Enums/AFIError.html +++ b/docs/docsets/AlamofireImage.docset/Contents/Resources/Documents/Enums/AFIError.html @@ -23,7 +23,7 @@ AlamofireImage Docs - (85% documented) + (77% documented)

                                                                  @@ -87,6 +87,9 @@

                                                                • Extensions
                                                                    +
                                                                  • + AlamofireExtension +
                                                                  • DataRequest
                                                                    • @@ -202,11 +205,12 @@
                                                                    -
                                                                    +

                                                                    AFIError

                                                                    public enum AFIError : Error
                                                                    +
                                                                    extension AFIError: LocalizedError
                                                                    @@ -311,9 +315,11 @@

                                                                    Declaration

                                                                    - -

                                                                    Error Booleans

                                                                    -                                                                     +
                                                                    + +

                                                                    Error Booleans

                                                                    +

                                                                    +
                                                                    • @@ -403,9 +409,11 @@

                                                                      Declaration

                                                                      - -

                                                                      Error Descriptions

                                                                      -                                                                       +
                                                                      + +

                                                                      Error Descriptions

                                                                      +

                                                                      +
                                                                      • @@ -442,8 +450,8 @@

                                                                        Declaration

                                                                    -

                                                                    © 2019 Alamofire Software Foundation. All rights reserved. (Last updated: 2019-10-27)

                                                                    -

                                                                    Generated by jazzy ♪♫ v0.11.2, a Realm project.

                                                                    +

                                                                    © 2020 Alamofire Software Foundation. All rights reserved. (Last updated: 2020-02-23)

                                                                    +

                                                                    Generated by jazzy ♪♫ v0.13.1, a Realm project.

                                                                    diff --git a/docs/docsets/AlamofireImage.docset/Contents/Resources/Documents/Extensions.html b/docs/docsets/AlamofireImage.docset/Contents/Resources/Documents/Extensions.html index f5f324fd..7c07f459 100644 --- a/docs/docsets/AlamofireImage.docset/Contents/Resources/Documents/Extensions.html +++ b/docs/docsets/AlamofireImage.docset/Contents/Resources/Documents/Extensions.html @@ -23,7 +23,7 @@ AlamofireImage Docs - (85% documented) + (77% documented)

                                                                    @@ -87,6 +87,9 @@

                                                                  • Extensions - -
                                                                    -
                                                                    • @@ -301,7 +304,36 @@

                                                                      macOS

                                                                      Declaration

                                                                      Swift

                                                                      - 
                                                                      extension UIButton
                                                                      + 
                                                                      extension UIButton: AlamofireExtended
                                                                      + +
                                                                      +
                                                                      + +
                                                                    +
                                                                    • +
                                                                  • +
                                                                    + + + + AlamofireExtension + +
                                                                    +
                                                                    +
                                                                    +
                                                                    +
                                                                    +
                                                                    + + See more +
                                                                    +
                                                                    +

                                                                    Declaration

                                                                    +
                                                                    +

                                                                    Swift

                                                                    + 
                                                                    extension AlamofireExtension where ExtendedType: UIButton
                                                                    +
                                                                    extension AlamofireExtension where ExtendedType: UIImage
                                                                    +
                                                                    extension AlamofireExtension where ExtendedType: UIImageView
                                                                    @@ -314,9 +346,11 @@

                                                                    Declaration

                                                                    - -

                                                                    Initialization

                                                                    -                                                                     +
                                                                    + +

                                                                    Initialization

                                                                    +

                                                                    +
                                                                    • @@ -339,17 +373,13 @@

                                                                      Initialization

                                                                      Declaration

                                                                      Swift

                                                                      - 
                                                                      extension UIImage
                                                                      + 
                                                                      extension UIImage: AlamofireExtended
                                                                    • -
                                                                  - -
                                                                  -
                                                                  • @@ -371,6 +401,7 @@

                                                                    Declaration

                                                                    Swift

                                                                    extension UIImageView
                                                                    +
                                                                    extension UIImageView: AlamofireExtended
                                                                    @@ -385,8 +416,8 @@

                                                                    Declaration

                                                                  -

                                                                  © 2019 Alamofire Software Foundation. All rights reserved. (Last updated: 2019-10-27)

                                                                  -

                                                                  Generated by jazzy ♪♫ v0.11.2, a Realm project.

                                                                  +

                                                                  © 2020 Alamofire Software Foundation. All rights reserved. (Last updated: 2020-02-23)

                                                                  +

                                                                  Generated by jazzy ♪♫ v0.13.1, a Realm project.

                                                                  diff --git a/docs/docsets/AlamofireImage.docset/Contents/Resources/Documents/Extensions/AlamofireExtension.html b/docs/docsets/AlamofireImage.docset/Contents/Resources/Documents/Extensions/AlamofireExtension.html new file mode 100644 index 00000000..baccabba --- /dev/null +++ b/docs/docsets/AlamofireImage.docset/Contents/Resources/Documents/Extensions/AlamofireExtension.html @@ -0,0 +1,2202 @@ + + + + AlamofireExtension Extension Reference + + + + + + + + + + + + + + + + +
                                                                  +

                                                                  + + AlamofireImage Docs + + (77% documented) +

                                                                  + +

                                                                  +

                                                                  + +
                                                                  +

                                                                  + +

                                                                  + + + View on GitHub + +

                                                                  + +

                                                                  + + + Install in Dash + +

                                                                  +
                                                                  + +

                                                                  + AlamofireImage Reference + + AlamofireExtension Extension Reference +

                                                                  + +
                                                                  + +
                                                                  + +
                                                                  +
                                                                  +

                                                                  AlamofireExtension

                                                                  +
                                                                  +
                                                                  + 
                                                                  extension AlamofireExtension where ExtendedType: UIButton
                                                                  +
                                                                  extension AlamofireExtension where ExtendedType: UIImage
                                                                  +
                                                                  extension AlamofireExtension where ExtendedType: UIImageView
                                                                  + +
                                                                  +
                                                                  + +
                                                                  +
                                                                  + +
                                                                  +
                                                                  +
                                                                  +
                                                                  + + +
                                                                  + +

                                                                  Properties

                                                                  +

                                                                  +
                                                                  +
                                                                  +
                                                                    +
                                                                  • +
                                                                    + + + + imageDownloader + +
                                                                    +
                                                                    +
                                                                    +
                                                                    +
                                                                    +
                                                                    +

                                                                    The instance image downloader used to download all images. If this property is nil, the UIButton will +fallback on the sharedImageDownloader for all downloads. The most common use case for needing to use a +custom instance image downloader is when images are behind different basic auth credentials.

                                                                    + +
                                                                    +
                                                                    +

                                                                    Declaration

                                                                    +
                                                                    +

                                                                    Swift

                                                                    + 
                                                                    public var imageDownloader: ImageDownloader? { get nonmutating set }
                                                                    + +
                                                                    +
                                                                    +
                                                                    +
                                                                    +
                                                                    • +
                                                                  • +
                                                                    + + + + sharedImageDownloader + +
                                                                    +
                                                                    +
                                                                    +
                                                                    +
                                                                    +
                                                                    +

                                                                    The shared image downloader used to download all images. By default, this is the default ImageDownloader +instance backed with an AutoPurgingImageCache which automatically evicts images from the cache when the memory +capacity is reached or memory warning notifications occur. The shared image downloader is only used if the +imageDownloader is nil.

                                                                    + +
                                                                    +
                                                                    +

                                                                    Declaration

                                                                    +
                                                                    +

                                                                    Swift

                                                                    + 
                                                                    public static var sharedImageDownloader: ImageDownloader { get set }
                                                                    + +
                                                                    +
                                                                    +
                                                                    +
                                                                    +
                                                                    • +
                                                                  +
                                                                  +
                                                                  +
                                                                  + + +
                                                                  + +

                                                                  Image Downloads

                                                                  +

                                                                  +
                                                                  +
                                                                  +
                                                                    +
                                                                  • + +
                                                                    +
                                                                    +
                                                                    +
                                                                    +
                                                                    +

                                                                    Asynchronously downloads an image from the specified URL and sets it once the request is finished.

                                                                    + +

                                                                    If the image is cached locally, the image is set immediately. Otherwise the specified placeholder image will be +set immediately, and then the remote image will be set once the image request is finished.

                                                                    + +
                                                                    +
                                                                    +

                                                                    Declaration

                                                                    +
                                                                    +

                                                                    Swift

                                                                    + 
                                                                    public func setImage(for state: ControlState,
+                     url: URL,
+                     cacheKey: String? = nil,
+                     placeholderImage: UIImage? = nil,
+                     serializer: ImageResponseSerializer? = nil,
+                     filter: ImageFilter? = nil,
+                     progress: ImageDownloader.ProgressHandler? = nil,
+                     progressQueue: DispatchQueue = DispatchQueue.main,
+                     completion: ((AFIDataResponse<UIImage>) -> Void)? = nil)
                                                                    + +
                                                                    +
                                                                    +
                                                                    +

                                                                    Parameters

                                                                    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                    + + state + + +
                                                                    +

                                                                    The control state of the button to set the image on.

                                                                    +
                                                                    +
                                                                    + + url + + +
                                                                    +

                                                                    The URL used for your image request.

                                                                    +
                                                                    +
                                                                    + + cacheKey + + +
                                                                    +

                                                                    An optional key used to identify the image in the cache. Defaults to nil.

                                                                    +
                                                                    +
                                                                    + + placeholderImage + + +
                                                                    +

                                                                    The image to be set initially until the image request finished. If nil, the + image will not change its image until the image request finishes. Defaults + to nil.

                                                                    +
                                                                    +
                                                                    + + serializer + + +
                                                                    +

                                                                    Image response serializer used to convert the image data to UIImage. Defaults + to nil which will fall back to the instance imageResponseSerializer set on + the ImageDownloader.

                                                                    +
                                                                    +
                                                                    + + filter + + +
                                                                    +

                                                                    The image filter applied to the image after the image request is finished. + Defaults to nil.

                                                                    +
                                                                    +
                                                                    + + progress + + +
                                                                    +

                                                                    The closure to be executed periodically during the lifecycle of the request. + Defaults to nil.

                                                                    +
                                                                    +
                                                                    + + progressQueue + + +
                                                                    +

                                                                    The dispatch queue to call the progress closure on. Defaults to the main queue.

                                                                    +
                                                                    +
                                                                    + + completion + + +
                                                                    +

                                                                    A closure to be executed when the image request finishes. The closure takes a + single response value containing either the image or the error that occurred. If + the image was returned from the image cache, the response will be nil. Defaults + to nil.

                                                                    +
                                                                    +
                                                                    +
                                                                    +
                                                                    +
                                                                    +
                                                                    • +
                                                                  • + +
                                                                    +
                                                                    +
                                                                    +
                                                                    +
                                                                    +

                                                                    Asynchronously downloads an image from the specified URL and sets it once the request is finished.

                                                                    + +

                                                                    If the image is cached locally, the image is set immediately. Otherwise the specified placeholder image will be +set immediately, and then the remote image will be set once the image request is finished.

                                                                    + +
                                                                    +
                                                                    +

                                                                    Declaration

                                                                    +
                                                                    +

                                                                    Swift

                                                                    + 
                                                                    public func setImage(for state: ControlState,
+                     urlRequest: URLRequestConvertible,
+                     cacheKey: String? = nil,
+                     placeholderImage: UIImage? = nil,
+                     serializer: ImageResponseSerializer? = nil,
+                     filter: ImageFilter? = nil,
+                     progress: ImageDownloader.ProgressHandler? = nil,
+                     progressQueue: DispatchQueue = DispatchQueue.main,
+                     completion: ((AFIDataResponse<UIImage>) -> Void)? = nil)
                                                                    + +
                                                                    +
                                                                    +
                                                                    +

                                                                    Parameters

                                                                    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                    + + state + + +
                                                                    +

                                                                    The control state of the button to set the image on.

                                                                    +
                                                                    +
                                                                    + + urlRequest + + +
                                                                    +

                                                                    The URL request.

                                                                    +
                                                                    +
                                                                    + + cacheKey + + +
                                                                    +

                                                                    An optional key used to identify the image in the cache. Defaults to nil.

                                                                    +
                                                                    +
                                                                    + + placeholderImage + + +
                                                                    +

                                                                    The image to be set initially until the image request finished. If nil, the + image will not change its image until the image request finishes. Defaults + to nil.

                                                                    +
                                                                    +
                                                                    + + serializer + + +
                                                                    +

                                                                    Image response serializer used to convert the image data to UIImage. Defaults + to nil which will fall back to the instance imageResponseSerializer set on + the ImageDownloader.

                                                                    +
                                                                    +
                                                                    + + filter + + +
                                                                    +

                                                                    The image filter applied to the image after the image request is finished. + Defaults to nil.

                                                                    +
                                                                    +
                                                                    + + progress + + +
                                                                    +

                                                                    The closure to be executed periodically during the lifecycle of the request. + Defaults to nil.

                                                                    +
                                                                    +
                                                                    + + progressQueue + + +
                                                                    +

                                                                    The dispatch queue to call the progress closure on. Defaults to the main queue.

                                                                    +
                                                                    +
                                                                    + + completion + + +
                                                                    +

                                                                    A closure to be executed when the image request finishes. The closure takes a + single response value containing either the image or the error that occurred. If + the image was returned from the image cache, the response will be nil. Defaults + to nil.

                                                                    +
                                                                    +
                                                                    +
                                                                    +
                                                                    +
                                                                    +
                                                                    • +
                                                                  • + +
                                                                    +
                                                                    +
                                                                    +
                                                                    +
                                                                    +

                                                                    Cancels the active download request for the image, if one exists.

                                                                    + +
                                                                    +
                                                                    +

                                                                    Declaration

                                                                    +
                                                                    +

                                                                    Swift

                                                                    + 
                                                                    public func cancelImageRequest(for state: ControlState)
                                                                    + +
                                                                    +
                                                                    +
                                                                    +
                                                                    +
                                                                    • +
                                                                  +
                                                                  +
                                                                  +
                                                                  + + +
                                                                  + +

                                                                  Background Image Downloads

                                                                  +

                                                                  +
                                                                  +
                                                                  +
                                                                    +
                                                                  • + +
                                                                    +
                                                                    +
                                                                    +
                                                                    +
                                                                    +

                                                                    Asynchronously downloads an image from the specified URL and sets it once the request is finished.

                                                                    + +

                                                                    If the image is cached locally, the image is set immediately. Otherwise the specified placeholder image will be +set immediately, and then the remote image will be set once the image request is finished.

                                                                    + +
                                                                    +
                                                                    +

                                                                    Declaration

                                                                    +
                                                                    +

                                                                    Swift

                                                                    + 
                                                                    public func setBackgroundImage(for state: ControlState,
+                               url: URL,
+                               cacheKey: String? = nil,
+                               placeholderImage: UIImage? = nil,
+                               serializer: ImageResponseSerializer? = nil,
+                               filter: ImageFilter? = nil,
+                               progress: ImageDownloader.ProgressHandler? = nil,
+                               progressQueue: DispatchQueue = DispatchQueue.main,
+                               completion: ((AFIDataResponse<UIImage>) -> Void)? = nil)
                                                                    + +
                                                                    +
                                                                    +
                                                                    +

                                                                    Parameters

                                                                    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                    + + state + + +
                                                                    +

                                                                    The control state of the button to set the image on.

                                                                    +
                                                                    +
                                                                    + + url + + +
                                                                    +

                                                                    The URL used for the image request.

                                                                    +
                                                                    +
                                                                    + + cacheKey + + +
                                                                    +

                                                                    An optional key used to identify the image in the cache. Defaults to nil.

                                                                    +
                                                                    +
                                                                    + + placeholderImage + + +
                                                                    +

                                                                    The image to be set initially until the image request finished. If nil, the + background image will not change its image until the image request finishes. + Defaults to nil.

                                                                    +
                                                                    +
                                                                    + + serializer + + +
                                                                    +

                                                                    Image response serializer used to convert the image data to UIImage. Defaults + to nil which will fall back to the instance imageResponseSerializer set on + the ImageDownloader.

                                                                    +
                                                                    +
                                                                    + + filter + + +
                                                                    +

                                                                    The image filter applied to the image after the image request is finished. + Defaults to nil.

                                                                    +
                                                                    +
                                                                    + + progress + + +
                                                                    +

                                                                    The closure to be executed periodically during the lifecycle of the request. + Defaults to nil.

                                                                    +
                                                                    +
                                                                    + + progressQueue + + +
                                                                    +

                                                                    The dispatch queue to call the progress closure on. Defaults to the main queue.

                                                                    +
                                                                    +
                                                                    + + completion + + +
                                                                    +

                                                                    A closure to be executed when the image request finishes. The closure takes a + single response value containing either the image or the error that occurred. If + the image was returned from the image cache, the response will be nil. Defaults + to nil.

                                                                    +
                                                                    +
                                                                    +
                                                                    +
                                                                    +
                                                                    +
                                                                    • +
                                                                  • + +
                                                                    +
                                                                    +
                                                                    +
                                                                    +
                                                                    +

                                                                    Asynchronously downloads an image from the specified URL request and sets it once the request is finished.

                                                                    + +

                                                                    If the image is cached locally, the image is set immediately. Otherwise the specified placeholder image will be +set immediately, and then the remote image will be set once the image request is finished.

                                                                    + +
                                                                    +
                                                                    +

                                                                    Declaration

                                                                    +
                                                                    +

                                                                    Swift

                                                                    + 
                                                                    public func setBackgroundImage(for state: ControlState,
+                               urlRequest: URLRequestConvertible,
+                               cacheKey: String? = nil,
+                               placeholderImage: UIImage? = nil,
+                               serializer: ImageResponseSerializer? = nil,
+                               filter: ImageFilter? = nil,
+                               progress: ImageDownloader.ProgressHandler? = nil,
+                               progressQueue: DispatchQueue = DispatchQueue.main,
+                               completion: ((AFIDataResponse<UIImage>) -> Void)? = nil)
                                                                    + +
                                                                    +
                                                                    +
                                                                    +

                                                                    Parameters

                                                                    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                    + + state + + +
                                                                    +

                                                                    The control state of the button to set the image on.

                                                                    +
                                                                    +
                                                                    + + urlRequest + + +
                                                                    +

                                                                    The URL request.

                                                                    +
                                                                    +
                                                                    + + cacheKey + + +
                                                                    +

                                                                    An optional key used to identify the image in the cache. Defaults to nil.

                                                                    +
                                                                    +
                                                                    + + placeholderImage + + +
                                                                    +

                                                                    The image to be set initially until the image request finished. If nil, the + background image will not change its image until the image request finishes. + Defaults to nil.

                                                                    +
                                                                    +
                                                                    + + serializer + + +
                                                                    +

                                                                    Image response serializer used to convert the image data to UIImage. Defaults + to nil which will fall back to the instance imageResponseSerializer set on + the ImageDownloader.

                                                                    +
                                                                    +
                                                                    + + filter + + +
                                                                    +

                                                                    The image filter applied to the image after the image request is finished. + Defaults to nil.

                                                                    +
                                                                    +
                                                                    + + progress + + +
                                                                    +

                                                                    The closure to be executed periodically during the lifecycle of the request. + Defaults to nil.

                                                                    +
                                                                    +
                                                                    + + progressQueue + + +
                                                                    +

                                                                    The dispatch queue to call the progress closure on. Defaults to the main queue.

                                                                    +
                                                                    +
                                                                    + + completion + + +
                                                                    +

                                                                    A closure to be executed when the image request finishes. The closure takes a + single response value containing either the image or the error that occurred. If + the image was returned from the image cache, the response will be nil. Defaults + to nil.

                                                                    +
                                                                    +
                                                                    +
                                                                    +
                                                                    +
                                                                    +
                                                                    • +
                                                                  • + +
                                                                    +
                                                                    +
                                                                    +
                                                                    +
                                                                    +

                                                                    Cancels the active download request for the background image, if one exists.

                                                                    + +
                                                                    +
                                                                    +

                                                                    Declaration

                                                                    +
                                                                    +

                                                                    Swift

                                                                    + 
                                                                    public func cancelBackgroundImageRequest(for state: ControlState)
                                                                    + +
                                                                    +
                                                                    +
                                                                    +
                                                                    +
                                                                    • +
                                                                  +
                                                                  +
                                                                  +
                                                                  + + +
                                                                  + +

                                                                  Available where ExtendedType: UIImage

                                                                  +

                                                                  +
                                                                  +
                                                                  +
                                                                    +
                                                                  • + +
                                                                    +
                                                                    +
                                                                    +
                                                                    +
                                                                    +

                                                                    Initializes and returns the image object with the specified data in a thread-safe manner.

                                                                    + +

                                                                    It has been reported that there are thread-safety issues when initializing large amounts of images +simultaneously. In the event of these issues occurring, this method can be used in place of +the init?(data:) method.

                                                                    + +
                                                                    +
                                                                    +

                                                                    Declaration

                                                                    +
                                                                    +

                                                                    Swift

                                                                    + 
                                                                    public static func threadSafeImage(with data: Data) -> UIImage?
                                                                    + +
                                                                    +
                                                                    +
                                                                    +

                                                                    Parameters

                                                                    + + + + + + + +
                                                                    + + data + + +
                                                                    +

                                                                    The data object containing the image data.

                                                                    +
                                                                    +
                                                                    +
                                                                    +
                                                                    +

                                                                    Return Value

                                                                    +

                                                                    An initialized UIImage object, or nil if the method failed.

                                                                    +
                                                                    +
                                                                    +
                                                                    +
                                                                    • +
                                                                  • + +
                                                                    +
                                                                    +
                                                                    +
                                                                    +
                                                                    +

                                                                    Initializes and returns the image object with the specified data and scale in a thread-safe manner.

                                                                    + +

                                                                    It has been reported that there are thread-safety issues when initializing large amounts of images +simultaneously. In the event of these issues occurring, this method can be used in place of +the init?(data:scale:) method.

                                                                    + +
                                                                    +
                                                                    +

                                                                    Declaration

                                                                    +
                                                                    +

                                                                    Swift

                                                                    + 
                                                                    public static func threadSafeImage(with data: Data, scale: CGFloat) -> UIImage?
                                                                    + +
                                                                    +
                                                                    +
                                                                    +

                                                                    Parameters

                                                                    + + + + + + + + + + + +
                                                                    + + data + + +
                                                                    +

                                                                    The data object containing the image data.

                                                                    +
                                                                    +
                                                                    + + scale + + +
                                                                    +

                                                                    The scale factor to assume when interpreting the image data. Applying a scale factor of 1.0 + results in an image whose size matches the pixel-based dimensions of the image. Applying a + different scale factor changes the size of the image as reported by the size property.

                                                                    +
                                                                    +
                                                                    +
                                                                    +
                                                                    +

                                                                    Return Value

                                                                    +

                                                                    An initialized UIImage object, or nil if the method failed.

                                                                    +
                                                                    +
                                                                    +
                                                                    +
                                                                    • +
                                                                  • +
                                                                    + + + + isInflated + +
                                                                    +
                                                                    +
                                                                    +
                                                                    +
                                                                    +
                                                                    +

                                                                    Returns whether the image is inflated.

                                                                    + +
                                                                    +
                                                                    +

                                                                    Declaration

                                                                    +
                                                                    +

                                                                    Swift

                                                                    + 
                                                                    public var isInflated: Bool { get nonmutating set }
                                                                    + +
                                                                    +
                                                                    +
                                                                    +
                                                                    +
                                                                    • +
                                                                  • +
                                                                    + + + + inflate() + +
                                                                    +
                                                                    +
                                                                    +
                                                                    +
                                                                    +
                                                                    +

                                                                    Inflates the underlying compressed image data to be backed by an uncompressed bitmap representation.

                                                                    + +

                                                                    Inflating compressed image formats (such as PNG or JPEG) can significantly improve drawing performance as it +allows a bitmap representation to be constructed in the background rather than on the main thread.

                                                                    + +
                                                                    +
                                                                    +

                                                                    Declaration

                                                                    +
                                                                    +

                                                                    Swift

                                                                    + 
                                                                    public func inflate()
                                                                    + +
                                                                    +
                                                                    +
                                                                    +
                                                                    +
                                                                    • +
                                                                  • + +
                                                                    +
                                                                    +
                                                                    +
                                                                    +
                                                                    +

                                                                    Returns whether the image contains an alpha component.

                                                                    + +
                                                                    +
                                                                    +

                                                                    Declaration

                                                                    +
                                                                    +

                                                                    Swift

                                                                    + 
                                                                    public var containsAlphaComponent: Bool { get }
                                                                    + +
                                                                    +
                                                                    +
                                                                    +
                                                                    +
                                                                    • +
                                                                  • +
                                                                    + + + + isOpaque + +
                                                                    +
                                                                    +
                                                                    +
                                                                    +
                                                                    +
                                                                    +

                                                                    Returns whether the image is opaque.

                                                                    + +
                                                                    +
                                                                    +

                                                                    Declaration

                                                                    +
                                                                    +

                                                                    Swift

                                                                    + 
                                                                    public var isOpaque: Bool { get }
                                                                    + +
                                                                    +
                                                                    +
                                                                    +
                                                                    +
                                                                    • +
                                                                  • + +
                                                                    +
                                                                    +
                                                                    +
                                                                    +
                                                                    +

                                                                    Returns a new version of the image scaled to the specified size.

                                                                    + +
                                                                    +
                                                                    +

                                                                    Declaration

                                                                    +
                                                                    +

                                                                    Swift

                                                                    + 
                                                                    public func imageScaled(to size: CGSize, scale: CGFloat? = nil) -> UIImage
                                                                    + +
                                                                    +
                                                                    +
                                                                    +

                                                                    Parameters

                                                                    + + + + + + + + + + + +
                                                                    + + size + + +
                                                                    +

                                                                    The size to use when scaling the new image.

                                                                    +
                                                                    +
                                                                    + + scale + + +
                                                                    +

                                                                    The scale to set for the new image. Defaults to nil which will maintain the current image scale.

                                                                    +
                                                                    +
                                                                    +
                                                                    +
                                                                    +

                                                                    Return Value

                                                                    +

                                                                    The new image object.

                                                                    +
                                                                    +
                                                                    +
                                                                    +
                                                                    • +
                                                                  • + +
                                                                    +
                                                                    +
                                                                    +
                                                                    +
                                                                    +

                                                                    Returns a new version of the image scaled from the center while maintaining the aspect ratio to fit within +a specified size.

                                                                    + +

                                                                    The resulting image contains an alpha component used to pad the width or height with the necessary transparent +pixels to fit the specified size. In high performance critical situations, this may not be the optimal approach. +To maintain an opaque image, you could compute the scaledSize manually, then use the af.imageScaledToSize +method in conjunction with a .Center content mode to achieve the same visual result.

                                                                    + +
                                                                    +
                                                                    +

                                                                    Declaration

                                                                    +
                                                                    +

                                                                    Swift

                                                                    + 
                                                                    public func imageAspectScaled(toFit size: CGSize, scale: CGFloat? = nil) -> UIImage
                                                                    + +
                                                                    +
                                                                    +
                                                                    +

                                                                    Parameters

                                                                    + + + + + + + + + + + +
                                                                    + + size + + +
                                                                    +

                                                                    The size to use when scaling the new image.

                                                                    +
                                                                    +
                                                                    + + scale + + +
                                                                    +

                                                                    The scale to set for the new image. Defaults to nil which will maintain the current image scale.

                                                                    +
                                                                    +
                                                                    +
                                                                    +
                                                                    +

                                                                    Return Value

                                                                    +

                                                                    A new image object.

                                                                    +
                                                                    +
                                                                    +
                                                                    +
                                                                    • +
                                                                  • + +
                                                                    +
                                                                    +
                                                                    +
                                                                    +
                                                                    +

                                                                    Returns a new version of the image scaled from the center while maintaining the aspect ratio to fill a +specified size. Any pixels that fall outside the specified size are clipped.

                                                                    + +
                                                                    +
                                                                    +

                                                                    Declaration

                                                                    +
                                                                    +

                                                                    Swift

                                                                    + 
                                                                    public func imageAspectScaled(toFill size: CGSize, scale: CGFloat? = nil) -> UIImage
                                                                    + +
                                                                    +
                                                                    +
                                                                    +

                                                                    Parameters

                                                                    + + + + + + + + + + + +
                                                                    + + size + + +
                                                                    +

                                                                    The size to use when scaling the new image.

                                                                    +
                                                                    +
                                                                    + + scale + + +
                                                                    +

                                                                    The scale to set for the new image. Defaults to nil which will maintain the current image scale.

                                                                    +
                                                                    +
                                                                    +
                                                                    +
                                                                    +

                                                                    Return Value

                                                                    +

                                                                    A new image object.

                                                                    +
                                                                    +
                                                                    +
                                                                    +
                                                                    • +
                                                                  • + +
                                                                    +
                                                                    +
                                                                    +
                                                                    +
                                                                    +

                                                                    Returns a new version of the image with the corners rounded to the specified radius.

                                                                    + +
                                                                    +
                                                                    +

                                                                    Declaration

                                                                    +
                                                                    +

                                                                    Swift

                                                                    + 
                                                                    public func imageRounded(withCornerRadius radius: CGFloat, divideRadiusByImageScale: Bool = false) -> UIImage
                                                                    + +
                                                                    +
                                                                    +
                                                                    +

                                                                    Parameters

                                                                    + + + + + + + + + + + +
                                                                    + + radius + + +
                                                                    +

                                                                    The radius to use when rounding the new image.

                                                                    +
                                                                    +
                                                                    + + divideRadiusByImageScale + + +
                                                                    +

                                                                    Whether to divide the radius by the image scale. Set to true when the image has + the same resolution for all screen scales such as @1x, @2x and @3x (i.e. single + image from web server). Set to false for images loaded from an asset catalog + with varying resolutions for each screen scale. false by default.

                                                                    +
                                                                    +
                                                                    +
                                                                    +
                                                                    +

                                                                    Return Value

                                                                    +

                                                                    A new image object.

                                                                    +
                                                                    +
                                                                    +
                                                                    +
                                                                    • +
                                                                  • + +
                                                                    +
                                                                    +
                                                                    +
                                                                    +
                                                                    +

                                                                    Returns a new version of the image rounded into a circle.

                                                                    + +
                                                                    +
                                                                    +

                                                                    Declaration

                                                                    +
                                                                    +

                                                                    Swift

                                                                    + 
                                                                    public func imageRoundedIntoCircle() -> UIImage
                                                                    + +
                                                                    +
                                                                    +
                                                                    +

                                                                    Return Value

                                                                    +

                                                                    A new image object.

                                                                    +
                                                                    +
                                                                    +
                                                                    +
                                                                    • +
                                                                  • + +
                                                                    +
                                                                    +
                                                                    +
                                                                    +
                                                                    +

                                                                    Returns a new version of the image using a CoreImage filter with the specified name and parameters.

                                                                    + +
                                                                    +
                                                                    +

                                                                    Declaration

                                                                    +
                                                                    +

                                                                    Swift

                                                                    + 
                                                                    public func imageFiltered(withCoreImageFilter name: String, parameters: [String : Any]? = nil) -> UIImage?
                                                                    + +
                                                                    +
                                                                    +
                                                                    +

                                                                    Parameters

                                                                    + + + + + + + + + + + +
                                                                    + + name + + +
                                                                    +

                                                                    The name of the CoreImage filter to use on the new image.

                                                                    +
                                                                    +
                                                                    + + parameters + + +
                                                                    +

                                                                    The parameters to apply to the CoreImage filter.

                                                                    +
                                                                    +
                                                                    +
                                                                    +
                                                                    +

                                                                    Return Value

                                                                    +

                                                                    A new image object, or nil if the filter failed for any reason.

                                                                    +
                                                                    +
                                                                    +
                                                                    +
                                                                    • +
                                                                  +
                                                                  +
                                                                  +
                                                                  + + +
                                                                  + +

                                                                  Properties

                                                                  +

                                                                  +
                                                                  +
                                                                  +
                                                                    +
                                                                  • +
                                                                    + + + + imageDownloader + +
                                                                    +
                                                                    +
                                                                    +
                                                                    +
                                                                    +
                                                                    +

                                                                    The instance image downloader used to download all images. If this property is nil, the UIImageView will +fallback on the sharedImageDownloader for all downloads. The most common use case for needing to use a custom +instance image downloader is when images are behind different basic auth credentials.

                                                                    + +
                                                                    +
                                                                    +

                                                                    Declaration

                                                                    +
                                                                    +

                                                                    Swift

                                                                    + 
                                                                    public var imageDownloader: ImageDownloader? { get nonmutating set }
                                                                    + +
                                                                    +
                                                                    +
                                                                    +
                                                                    +
                                                                    • +
                                                                  • +
                                                                    + + + + sharedImageDownloader + +
                                                                    +
                                                                    +
                                                                    +
                                                                    +
                                                                    +
                                                                    +

                                                                    The shared image downloader used to download all images. By default, this is the default ImageDownloader +instance backed with an AutoPurgingImageCache which automatically evicts images from the cache when the memory +capacity is reached or memory warning notifications occur. The shared image downloader is only used if the +imageDownloader is nil.

                                                                    + +
                                                                    +
                                                                    +

                                                                    Declaration

                                                                    +
                                                                    +

                                                                    Swift

                                                                    + 
                                                                    public static var sharedImageDownloader: ImageDownloader { get set }
                                                                    + +
                                                                    +
                                                                    +
                                                                    +
                                                                    +
                                                                    • +
                                                                  +
                                                                  +
                                                                  +
                                                                  + + +
                                                                  + +

                                                                  Image Download

                                                                  +

                                                                  +
                                                                  +
                                                                  +
                                                                    +
                                                                  • + +
                                                                    +
                                                                    +
                                                                    +
                                                                    +
                                                                    +

                                                                    Asynchronously downloads an image from the specified URL, applies the specified image filter to the downloaded +image and sets it once finished while executing the image transition.

                                                                    + +

                                                                    If the image is cached locally, the image is set immediately. Otherwise the specified placeholder image will be +set immediately, and then the remote image will be set once the image request is finished.

                                                                    + +

                                                                    The completion closure is called after the image download and filtering are complete, but before the start of +the image transition. Please note it is no longer the responsibility of the completion closure to set the +image. It will be set automatically. If you require a second notification after the image transition completes, +use a .Custom image transition with a completion closure. The .Custom completion closure is called when +the image transition is finished.

                                                                    + +
                                                                    +
                                                                    +

                                                                    Declaration

                                                                    +
                                                                    +

                                                                    Swift

                                                                    + 
                                                                    public func setImage(withURL url: URL,
+                     cacheKey: String? = nil,
+                     placeholderImage: UIImage? = nil,
+                     serializer: ImageResponseSerializer? = nil,
+                     filter: ImageFilter? = nil,
+                     progress: ImageDownloader.ProgressHandler? = nil,
+                     progressQueue: DispatchQueue = DispatchQueue.main,
+                     imageTransition: UIImageView.ImageTransition = .noTransition,
+                     runImageTransitionIfCached: Bool = false,
+                     completion: ((AFIDataResponse<UIImage>) -> Void)? = nil)
                                                                    + +
                                                                    +
                                                                    +
                                                                    +

                                                                    Parameters

                                                                    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                    + + url + + +
                                                                    +

                                                                    The URL used for the image request.

                                                                    +
                                                                    +
                                                                    + + cacheKey + + +
                                                                    +

                                                                    An optional key used to identify the image in the cache. Defaults + to nil.

                                                                    +
                                                                    +
                                                                    + + placeholderImage + + +
                                                                    +

                                                                    The image to be set initially until the image request finished. If + nil, the image view will not change its image until the image + request finishes. Defaults to nil.

                                                                    +
                                                                    +
                                                                    + + serializer + + +
                                                                    +

                                                                    Image response serializer used to convert the image data to UIImage. + Defaults to nil which will fall back to the + instance imageResponseSerializer set on the ImageDownloader.

                                                                    +
                                                                    +
                                                                    + + filter + + +
                                                                    +

                                                                    The image filter applied to the image after the image request is + finished. Defaults to nil.

                                                                    +
                                                                    +
                                                                    + + progress + + +
                                                                    +

                                                                    The closure to be executed periodically during the lifecycle of the + request. Defaults to nil.

                                                                    +
                                                                    +
                                                                    + + progressQueue + + +
                                                                    +

                                                                    The dispatch queue to call the progress closure on. Defaults to the + main queue.

                                                                    +
                                                                    +
                                                                    + + imageTransition + + +
                                                                    +

                                                                    The image transition animation applied to the image when set. + Defaults to .None.

                                                                    +
                                                                    +
                                                                    + + runImageTransitionIfCached + + +
                                                                    +

                                                                    Whether to run the image transition if the image is cached. Defaults + to false.

                                                                    +
                                                                    +
                                                                    + + completion + + +
                                                                    +

                                                                    A closure to be executed when the image request finishes. The closure + has no return value and takes three arguments: the original request, + the response from the server and the result containing either the + image or the error that occurred. If the image was returned from the + image cache, the response will be nil. Defaults to nil.

                                                                    +
                                                                    +
                                                                    +
                                                                    +
                                                                    +
                                                                    +
                                                                    • +
                                                                  • + +
                                                                    +
                                                                    +
                                                                    +
                                                                    +
                                                                    +

                                                                    Asynchronously downloads an image from the specified URL Request, applies the specified image filter to the downloaded +image and sets it once finished while executing the image transition.

                                                                    + +

                                                                    If the image is cached locally, the image is set immediately. Otherwise the specified placeholder image will be +set immediately, and then the remote image will be set once the image request is finished.

                                                                    + +

                                                                    The completion closure is called after the image download and filtering are complete, but before the start of +the image transition. Please note it is no longer the responsibility of the completion closure to set the +image. It will be set automatically. If you require a second notification after the image transition completes, +use a .Custom image transition with a completion closure. The .Custom completion closure is called when +the image transition is finished.

                                                                    + +
                                                                    +
                                                                    +

                                                                    Declaration

                                                                    +
                                                                    +

                                                                    Swift

                                                                    + 
                                                                    public func setImage(withURLRequest urlRequest: URLRequestConvertible,
+                     cacheKey: String? = nil,
+                     placeholderImage: UIImage? = nil,
+                     serializer: ImageResponseSerializer? = nil,
+                     filter: ImageFilter? = nil,
+                     progress: ImageDownloader.ProgressHandler? = nil,
+                     progressQueue: DispatchQueue = DispatchQueue.main,
+                     imageTransition: UIImageView.ImageTransition = .noTransition,
+                     runImageTransitionIfCached: Bool = false,
+                     completion: ((AFIDataResponse<UIImage>) -> Void)? = nil)
                                                                    + +
                                                                    +
                                                                    +
                                                                    +

                                                                    Parameters

                                                                    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                    + + urlRequest + + +
                                                                    +

                                                                    The URL request.

                                                                    +
                                                                    +
                                                                    + + cacheKey + + +
                                                                    +

                                                                    An optional key used to identify the image in the cache. Defaults + to nil.

                                                                    +
                                                                    +
                                                                    + + placeholderImage + + +
                                                                    +

                                                                    The image to be set initially until the image request finished. If + nil, the image view will not change its image until the image + request finishes. Defaults to nil.

                                                                    +
                                                                    +
                                                                    + + serializer + + +
                                                                    +

                                                                    Image response serializer used to convert the image data to UIImage. + Defaults to nil which will fall back to the + instance imageResponseSerializer set on the ImageDownloader.

                                                                    +
                                                                    +
                                                                    + + filter + + +
                                                                    +

                                                                    The image filter applied to the image after the image request is + finished. Defaults to nil.

                                                                    +
                                                                    +
                                                                    + + progress + + +
                                                                    +

                                                                    The closure to be executed periodically during the lifecycle of the + request. Defaults to nil.

                                                                    +
                                                                    +
                                                                    + + progressQueue + + +
                                                                    +

                                                                    The dispatch queue to call the progress closure on. Defaults to the + main queue.

                                                                    +
                                                                    +
                                                                    + + imageTransition + + +
                                                                    +

                                                                    The image transition animation applied to the image when set. + Defaults to .None.

                                                                    +
                                                                    +
                                                                    + + runImageTransitionIfCached + + +
                                                                    +

                                                                    Whether to run the image transition if the image is cached. Defaults + to false.

                                                                    +
                                                                    +
                                                                    + + completion + + +
                                                                    +

                                                                    A closure to be executed when the image request finishes. The closure + has no return value and takes three arguments: the original request, + the response from the server and the result containing either the + image or the error that occurred. If the image was returned from the + image cache, the response will be nil. Defaults to nil.

                                                                    +
                                                                    +
                                                                    +
                                                                    +
                                                                    +
                                                                    +
                                                                    • +
                                                                  +
                                                                  +
                                                                  +
                                                                  + + +
                                                                  + +

                                                                  Image Download Cancellation

                                                                  +

                                                                  +
                                                                  +
                                                                  +
                                                                    +
                                                                  • +
                                                                    + + + + cancelImageRequest() + +
                                                                    +
                                                                    +
                                                                    +
                                                                    +
                                                                    +
                                                                    +

                                                                    Cancels the active download request, if one exists.

                                                                    + +
                                                                    +
                                                                    +

                                                                    Declaration

                                                                    +
                                                                    +

                                                                    Swift

                                                                    + 
                                                                    public func cancelImageRequest()
                                                                    + +
                                                                    +
                                                                    +
                                                                    +
                                                                    +
                                                                    • +
                                                                  +
                                                                  +
                                                                  +
                                                                  + + +
                                                                  + +

                                                                  Image Transition

                                                                  +

                                                                  +
                                                                  +
                                                                  +
                                                                    +
                                                                  • +
                                                                    + + + + run(_:with:) + +
                                                                    +
                                                                    +
                                                                    +
                                                                    +
                                                                    +
                                                                    +

                                                                    Runs the image transition on the image view with the specified image.

                                                                    + +
                                                                    +
                                                                    +

                                                                    Declaration

                                                                    +
                                                                    +

                                                                    Swift

                                                                    + 
                                                                    public func run(_ imageTransition: UIImageView.ImageTransition, with image: Image)
                                                                    + +
                                                                    +
                                                                    +
                                                                    +

                                                                    Parameters

                                                                    + + + + + + + + + + + +
                                                                    + + imageTransition + + +
                                                                    +

                                                                    The image transition to ran on the image view.

                                                                    +
                                                                    +
                                                                    + + image + + +
                                                                    +

                                                                    The image to use for the image transition.

                                                                    +
                                                                    +
                                                                    +
                                                                    +
                                                                    +
                                                                    +
                                                                    • +
                                                                  +
                                                                  +
                                                                  +
                                                                  + +
                                                                  +
                                                                  +
                                                                  +

                                                                  © 2020 Alamofire Software Foundation. All rights reserved. (Last updated: 2020-02-23)

                                                                  +

                                                                  Generated by jazzy ♪♫ v0.13.1, a Realm project.

                                                                  +
                                                                  + + + diff --git a/docs/docsets/AlamofireImage.docset/Contents/Resources/Documents/Extensions/DataRequest.html b/docs/docsets/AlamofireImage.docset/Contents/Resources/Documents/Extensions/DataRequest.html index ed9dd935..46e7f623 100644 --- a/docs/docsets/AlamofireImage.docset/Contents/Resources/Documents/Extensions/DataRequest.html +++ b/docs/docsets/AlamofireImage.docset/Contents/Resources/Documents/Extensions/DataRequest.html @@ -23,7 +23,7 @@ AlamofireImage Docs - (85% documented) + (77% documented)

                                                                  @@ -87,6 +87,9 @@

                                                                • Extensions
                                                                    +
                                                                  • + AlamofireExtension +
                                                                  • DataRequest
                                                                    • @@ -202,7 +205,7 @@
                                                                    -
                                                                    +

                                                                    DataRequest

                                                                    @@ -239,8 +242,8 @@

                                                                    DataRequest

                                                                    -

                                                                    © 2019 Alamofire Software Foundation. All rights reserved. (Last updated: 2019-10-27)

                                                                    -

                                                                    Generated by jazzy ♪♫ v0.11.2, a Realm project.

                                                                    +

                                                                    © 2020 Alamofire Software Foundation. All rights reserved. (Last updated: 2020-02-23)

                                                                    +

                                                                    Generated by jazzy ♪♫ v0.13.1, a Realm project.

                                                                    diff --git a/docs/docsets/AlamofireImage.docset/Contents/Resources/Documents/Extensions/UIButton.html b/docs/docsets/AlamofireImage.docset/Contents/Resources/Documents/Extensions/UIButton.html index 769a0f0c..9c195d9f 100644 --- a/docs/docsets/AlamofireImage.docset/Contents/Resources/Documents/Extensions/UIButton.html +++ b/docs/docsets/AlamofireImage.docset/Contents/Resources/Documents/Extensions/UIButton.html @@ -23,7 +23,7 @@ AlamofireImage Docs - (85% documented) + (77% documented)

                                                                    @@ -87,6 +87,9 @@

                                                                  • Extensions
                                                                      +
                                                                    • + AlamofireExtension +
                                                                    • DataRequest
                                                                      • @@ -202,11 +205,11 @@
                                                                      -
                                                                      +

                                                                      UIButton

                                                                      - 
                                                                      extension UIButton
                                                                      + 
                                                                      extension UIButton: AlamofireExtended
                                                                      @@ -218,11 +221,13 @@

                                                                      UIButton

                                                                      - - - -

                                                                      Properties

                                                                      -                                                                       + + +
                                                                      + +

                                                                      Deprecated

                                                                      +

                                                                      +
                                                                      • @@ -238,9 +243,7 @@

                                                                        Properties

                                                                        -

                                                                        The instance image downloader used to download all images. If this property is nil, the UIButton will -fallback on the af_sharedImageDownloader for all downloads. The most common use case for needing to use a -custom instance image downloader is when images are behind different basic auth credentials.

                                                                        +

                                                                        Undocumented

                                                                        @@ -267,10 +270,7 @@

                                                                        Declaration

                                                                        -

                                                                        The shared image downloader used to download all images. By default, this is the default ImageDownloader -instance backed with an AutoPurgingImageCache which automatically evicts images from the cache when the memory -capacity is reached or memory warning notifications occur. The shared image downloader is only used if the -af_imageDownloader is nil.

                                                                        +

                                                                        Undocumented

                                                                        @@ -284,23 +284,12 @@

                                                                        Declaration

                                                                        • -
                                                                      -
                                                                      -
                                                                      -
                                                                      - - - -

                                                                      Image Downloads

                                                                      -                                                                       -
                                                                      -
                                                                      • @@ -308,134 +297,34 @@

                                                                        Image Downloads

                                                                        -

                                                                        Asynchronously downloads an image from the specified URL and sets it once the request is finished.

                                                                        - -

                                                                        If the image is cached locally, the image is set immediately. Otherwise the specified placeholder image will be -set immediately, and then the remote image will be set once the image request is finished.

                                                                        +

                                                                        Undocumented

                                                                        Declaration

                                                                        Swift

                                                                        - 
                                                                        public func af_setImage(
-    for state: ControlState,
-    url: URL,
-    placeholderImage: UIImage? = nil,
-    filter: ImageFilter? = nil,
-    progress: ImageDownloader.ProgressHandler? = nil,
-    progressQueue: DispatchQueue = DispatchQueue.main,
-    completion: ((AFIDataResponse<UIImage>) -> Void)? = nil)
                                                                        + 
                                                                        public func af_setImage(for state: ControlState,
+                        url: URL,
+                        cacheKey: String? = nil,
+                        placeholderImage: UIImage? = nil,
+                        serializer: ImageResponseSerializer? = nil,
+                        filter: ImageFilter? = nil,
+                        progress: ImageDownloader.ProgressHandler? = nil,
+                        progressQueue: DispatchQueue = DispatchQueue.main,
+                        completion: ((AFIDataResponse<UIImage>) -> Void)? = nil)
                                                                        -
                                                                        -

                                                                        Parameters

                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                        - - state - - -
                                                                        -

                                                                        The control state of the button to set the image on.

                                                                        -
                                                                        -
                                                                        - - url - - -
                                                                        -

                                                                        The URL used for your image request.

                                                                        -
                                                                        -
                                                                        - - placeholderImage - - -
                                                                        -

                                                                        The image to be set initially until the image request finished. If nil, the - image will not change its image until the image request finishes. Defaults - to nil.

                                                                        -
                                                                        -
                                                                        - - filter - - -
                                                                        -

                                                                        The image filter applied to the image after the image request is finished. - Defaults to nil.

                                                                        -
                                                                        -
                                                                        - - progress - - -
                                                                        -

                                                                        The closure to be executed periodically during the lifecycle of the request. - Defaults to nil.

                                                                        -
                                                                        -
                                                                        - - progressQueue - - -
                                                                        -

                                                                        The dispatch queue to call the progress closure on. Defaults to the main queue.

                                                                        -
                                                                        -
                                                                        - - completion - - -
                                                                        -

                                                                        A closure to be executed when the image request finishes. The closure takes a - single response value containing either the image or the error that occurred. If - the image was returned from the image cache, the response will be nil. Defaults - to nil.

                                                                        -
                                                                        -
                                                                        -
                                                                      • @@ -443,125 +332,25 @@

                                                                        Parameters

                                                                        -

                                                                        Asynchronously downloads an image from the specified URL request and sets it once the request is finished.

                                                                        - -

                                                                        If the image is cached locally, the image is set immediately. Otherwise the specified placeholder image will be -set immediately, and then the remote image will be set once the image request is finished.

                                                                        +

                                                                        Undocumented

                                                                        Declaration

                                                                        Swift

                                                                        - 
                                                                        public func af_setImage(
-    for state: ControlState,
-    urlRequest: URLRequestConvertible,
-    placeholderImage: UIImage? = nil,
-    filter: ImageFilter? = nil,
-    progress: ImageDownloader.ProgressHandler? = nil,
-    progressQueue: DispatchQueue = DispatchQueue.main,
-    completion: ((AFIDataResponse<UIImage>) -> Void)? = nil)
                                                                        + 
                                                                        public func af_setImage(for state: ControlState,
+                        urlRequest: URLRequestConvertible,
+                        cacheKey: String? = nil,
+                        placeholderImage: UIImage? = nil,
+                        serializer: ImageResponseSerializer? = nil,
+                        filter: ImageFilter? = nil,
+                        progress: ImageDownloader.ProgressHandler? = nil,
+                        progressQueue: DispatchQueue = DispatchQueue.main,
+                        completion: ((AFIDataResponse<UIImage>) -> Void)? = nil)
                                                                        -
                                                                        -

                                                                        Parameters

                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                        - - state - - -
                                                                        -

                                                                        The control state of the button to set the image on.

                                                                        -
                                                                        -
                                                                        - - urlRequest - - -
                                                                        -

                                                                        The URL request.

                                                                        -
                                                                        -
                                                                        - - placeholderImage - - -
                                                                        -

                                                                        The image to be set initially until the image request finished. If nil, the - image will not change its image until the image request finishes. Defaults - to nil.

                                                                        -
                                                                        -
                                                                        - - filter - - -
                                                                        -

                                                                        The image filter applied to the image after the image request is finished. - Defaults to nil.

                                                                        -
                                                                        -
                                                                        - - progress - - -
                                                                        -

                                                                        The closure to be executed periodically during the lifecycle of the request. - Defaults to nil.

                                                                        -
                                                                        -
                                                                        - - progressQueue - - -
                                                                        -

                                                                        The dispatch queue to call the progress closure on. Defaults to the main queue.

                                                                        -
                                                                        -
                                                                        - - completion - - -
                                                                        -

                                                                        A closure to be executed when the image request finishes. The closure takes a - single response value containing either the image or the error that occurred. If - the image was returned from the image cache, the response will be nil. Defaults - to nil.

                                                                        -
                                                                        -
                                                                        -
                                                                        • @@ -592,23 +381,12 @@

                                                                        Declaration

                                                                      -
                                                                    - -
                                                                    -
                                                                    - - - -

                                                                    Background Image Downloads

                                                                    -                                                                     -
                                                                    -
                                                                    • @@ -616,134 +394,34 @@

                                                                      Background Image Downloads

                                                                      -

                                                                      Asynchronously downloads an image from the specified URL and sets it once the request is finished.

                                                                      - -

                                                                      If the image is cached locally, the image is set immediately. Otherwise the specified placeholder image will be -set immediately, and then the remote image will be set once the image request is finished.

                                                                      +

                                                                      Undocumented

                                                                      Declaration

                                                                      Swift

                                                                      - 
                                                                      public func af_setBackgroundImage(
-    for state: ControlState,
-    url: URL,
-    placeholderImage: UIImage? = nil,
-    filter: ImageFilter? = nil,
-    progress: ImageDownloader.ProgressHandler? = nil,
-    progressQueue: DispatchQueue = DispatchQueue.main,
-    completion: ((AFIDataResponse<UIImage>) -> Void)? = nil)
                                                                      + 
                                                                      public func af_setBackgroundImage(for state: ControlState,
+                                  url: URL,
+                                  cacheKey: String? = nil,
+                                  placeholderImage: UIImage? = nil,
+                                  serializer: ImageResponseSerializer? = nil,
+                                  filter: ImageFilter? = nil,
+                                  progress: ImageDownloader.ProgressHandler? = nil,
+                                  progressQueue: DispatchQueue = DispatchQueue.main,
+                                  completion: ((AFIDataResponse<UIImage>) -> Void)? = nil)
                                                                      -
                                                                      -

                                                                      Parameters

                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                      - - state - - -
                                                                      -

                                                                      The control state of the button to set the image on.

                                                                      -
                                                                      -
                                                                      - - url - - -
                                                                      -

                                                                      The URL used for the image request.

                                                                      -
                                                                      -
                                                                      - - placeholderImage - - -
                                                                      -

                                                                      The image to be set initially until the image request finished. If nil, the - background image will not change its image until the image request finishes. - Defaults to nil.

                                                                      -
                                                                      -
                                                                      - - filter - - -
                                                                      -

                                                                      The image filter applied to the image after the image request is finished. - Defaults to nil.

                                                                      -
                                                                      -
                                                                      - - progress - - -
                                                                      -

                                                                      The closure to be executed periodically during the lifecycle of the request. - Defaults to nil.

                                                                      -
                                                                      -
                                                                      - - progressQueue - - -
                                                                      -

                                                                      The dispatch queue to call the progress closure on. Defaults to the main queue.

                                                                      -
                                                                      -
                                                                      - - completion - - -
                                                                      -

                                                                      A closure to be executed when the image request finishes. The closure takes a - single response value containing either the image or the error that occurred. If - the image was returned from the image cache, the response will be nil. Defaults - to nil.

                                                                      -
                                                                      -
                                                                      -
                                                                    • @@ -751,125 +429,25 @@

                                                                      Parameters

                                                                      -

                                                                      Asynchronously downloads an image from the specified URL request and sets it once the request is finished.

                                                                      - -

                                                                      If the image is cached locally, the image is set immediately. Otherwise the specified placeholder image will be -set immediately, and then the remote image will be set once the image request is finished.

                                                                      +

                                                                      Undocumented

                                                                      Declaration

                                                                      Swift

                                                                      - 
                                                                      public func af_setBackgroundImage(
-    for state: ControlState,
-    urlRequest: URLRequestConvertible,
-    placeholderImage: UIImage? = nil,
-    filter: ImageFilter? = nil,
-    progress: ImageDownloader.ProgressHandler? = nil,
-    progressQueue: DispatchQueue = DispatchQueue.main,
-    completion: ((AFIDataResponse<UIImage>) -> Void)? = nil)
                                                                      + 
                                                                      public func af_setBackgroundImage(for state: ControlState,
+                                  urlRequest: URLRequestConvertible,
+                                  cacheKey: String? = nil,
+                                  placeholderImage: UIImage? = nil,
+                                  serializer: ImageResponseSerializer? = nil,
+                                  filter: ImageFilter? = nil,
+                                  progress: ImageDownloader.ProgressHandler? = nil,
+                                  progressQueue: DispatchQueue = DispatchQueue.main,
+                                  completion: ((AFIDataResponse<UIImage>) -> Void)? = nil)
                                                                      -
                                                                      -

                                                                      Parameters

                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                      - - state - - -
                                                                      -

                                                                      The control state of the button to set the image on.

                                                                      -
                                                                      -
                                                                      - - urlRequest - - -
                                                                      -

                                                                      The URL request.

                                                                      -
                                                                      -
                                                                      - - placeholderImage - - -
                                                                      -

                                                                      The image to be set initially until the image request finished. If nil, the - background image will not change its image until the image request finishes. - Defaults to nil.

                                                                      -
                                                                      -
                                                                      - - filter - - -
                                                                      -

                                                                      The image filter applied to the image after the image request is finished. - Defaults to nil.

                                                                      -
                                                                      -
                                                                      - - progress - - -
                                                                      -

                                                                      The closure to be executed periodically during the lifecycle of the request. - Defaults to nil.

                                                                      -
                                                                      -
                                                                      - - progressQueue - - -
                                                                      -

                                                                      The dispatch queue to call the progress closure on. Defaults to the main queue.

                                                                      -
                                                                      -
                                                                      - - completion - - -
                                                                      -

                                                                      A closure to be executed when the image request finishes. The closure takes a - single response value containing either the image or the error that occurred. If - the image was returned from the image cache, the response will be nil. Defaults - to nil.

                                                                      -
                                                                      -
                                                                      -
                                                                      • @@ -908,8 +486,8 @@

                                                                      Declaration

                                                                    -

                                                                    © 2019 Alamofire Software Foundation. All rights reserved. (Last updated: 2019-10-27)

                                                                    -

                                                                    Generated by jazzy ♪♫ v0.11.2, a Realm project.

                                                                    +

                                                                    © 2020 Alamofire Software Foundation. All rights reserved. (Last updated: 2020-02-23)

                                                                    +

                                                                    Generated by jazzy ♪♫ v0.13.1, a Realm project.

                                                                    diff --git a/docs/docsets/AlamofireImage.docset/Contents/Resources/Documents/Extensions/UIImage.html b/docs/docsets/AlamofireImage.docset/Contents/Resources/Documents/Extensions/UIImage.html index 01ba0904..f9709431 100644 --- a/docs/docsets/AlamofireImage.docset/Contents/Resources/Documents/Extensions/UIImage.html +++ b/docs/docsets/AlamofireImage.docset/Contents/Resources/Documents/Extensions/UIImage.html @@ -23,7 +23,7 @@ AlamofireImage Docs - (85% documented) + (77% documented)

                                                                    @@ -87,6 +87,9 @@

                                                                  • Extensions
                                                                      +
                                                                    • + AlamofireExtension +
                                                                    • DataRequest
                                                                      • @@ -202,11 +205,11 @@
                                                                      -
                                                                      +

                                                                      UIImage

                                                                      - 
                                                                      extension UIImage
                                                                      + 
                                                                      extension UIImage: AlamofireExtended
                                                                      @@ -217,6 +220,15 @@

                                                                      UIImage

                                                                      +
                                                                      + + +
                                                                      + +

                                                                      Initialization

                                                                      +

                                                                      +
                                                                      +
                                                                      • @@ -231,11 +243,7 @@

                                                                        UIImage

                                                                        -

                                                                        Initializes and returns the image object with the specified data in a thread-safe manner.

                                                                        - -

                                                                        It has been reported that there are thread-safety issues when initializing large amounts of images -simultaneously. In the event of these issues occurring, this method can be used in place of -the init?(data:) method.

                                                                        +

                                                                        Undocumented

                                                                        @@ -246,29 +254,6 @@

                                                                        Declaration

                                                                        -
                                                                        -

                                                                        Parameters

                                                                        - - - - - - - -
                                                                        - - data - - -
                                                                        -

                                                                        The data object containing the image data.

                                                                        -
                                                                        -
                                                                        -
                                                                        -
                                                                        -

                                                                        Return Value

                                                                        -

                                                                        An initialized UIImage object, or nil if the method failed.

                                                                        -
                                                                      @@ -285,11 +270,7 @@

                                                                      Return Value

                                                                      -

                                                                      Initializes and returns the image object with the specified data and scale in a thread-safe manner.

                                                                      - -

                                                                      It has been reported that there are thread-safety issues when initializing large amounts of images -simultaneously. In the event of these issues occurring, this method can be used in place of -the init?(data:scale:) method.

                                                                      +

                                                                      Undocumented

                                                                      @@ -300,49 +281,21 @@

                                                                      Declaration

                                                                      -
                                                                      -

                                                                      Parameters

                                                                      - - - - - - - - - - - -
                                                                      - - data - - -
                                                                      -

                                                                      The data object containing the image data.

                                                                      -
                                                                      -
                                                                      - - scale - - -
                                                                      -

                                                                      The scale factor to assume when interpreting the image data. Applying a scale factor of 1.0 - results in an image whose size matches the pixel-based dimensions of the image. Applying a - different scale factor changes the size of the image as reported by the size property.

                                                                      -
                                                                      -
                                                                      -
                                                                      -
                                                                      -

                                                                      Return Value

                                                                      -

                                                                      An initialized UIImage object, or nil if the method failed.

                                                                      -
                                                                    +
                                                                    + + +
                                                                    + +

                                                                    Inflation

                                                                    +

                                                                    +
                                                                    +
                                                                    • @@ -357,14 +310,14 @@

                                                                      Return Value

                                                                      -

                                                                      Returns whether the image is inflated.

                                                                      +

                                                                      Undocumented

                                                                      Declaration

                                                                      Swift

                                                                      - 
                                                                      public var af_inflated: Bool { get set }
                                                                      + 
                                                                      public var af_inflated: Bool { get }
                                                                      @@ -384,10 +337,7 @@

                                                                      Declaration

                                                                      -

                                                                      Inflates the underlying compressed image data to be backed by an uncompressed bitmap representation.

                                                                      - -

                                                                      Inflating compressed image formats (such as PNG or JPEG) can significantly improve drawing performance as it -allows a bitmap representation to be constructed in the background rather than on the main thread.

                                                                      +

                                                                      Undocumented

                                                                      @@ -404,6 +354,15 @@

                                                                      Declaration

                                                                    +
                                                                    + + +
                                                                    + +

                                                                    Alpha

                                                                    +

                                                                    +
                                                                    +
                                                                    • @@ -418,7 +377,7 @@

                                                                      Declaration

                                                                      -

                                                                      Returns whether the image contains an alpha component.

                                                                      +

                                                                      Undocumented

                                                                      @@ -445,7 +404,7 @@

                                                                      Declaration

                                                                      -

                                                                      Returns whether the image is opaque.

                                                                      +

                                                                      Undocumented

                                                                      @@ -462,13 +421,22 @@

                                                                      Declaration

                                                                    +
                                                                    + + +
                                                                    + +

                                                                    Scaling

                                                                    +

                                                                    +
                                                                    +
                                                                    • @@ -476,49 +444,26 @@

                                                                      Declaration

                                                                      -

                                                                      Returns a new version of the image scaled to the specified size.

                                                                      +

                                                                      Undocumented

                                                                      Declaration

                                                                      Swift

                                                                      - 
                                                                      public func af_imageScaled(to size: CGSize) -> UIImage
                                                                      + 
                                                                      public func af_imageScaled(to size: CGSize, scale: CGFloat? = nil) -> UIImage
                                                                      -
                                                                      -

                                                                      Parameters

                                                                      - - - - - - - -
                                                                      - - size - - -
                                                                      -

                                                                      The size to use when scaling the new image.

                                                                      -
                                                                      -
                                                                      -
                                                                      -
                                                                      -

                                                                      Return Value

                                                                      -

                                                                      A new image object.

                                                                      -
                                                                    • @@ -526,55 +471,26 @@

                                                                      Return Value

                                                                      -

                                                                      Returns a new version of the image scaled from the center while maintaining the aspect ratio to fit within -a specified size.

                                                                      - -

                                                                      The resulting image contains an alpha component used to pad the width or height with the necessary transparent -pixels to fit the specified size. In high performance critical situations, this may not be the optimal approach. -To maintain an opaque image, you could compute the scaledSize manually, then use the af_imageScaledToSize -method in conjunction with a .Center content mode to achieve the same visual result.

                                                                      +

                                                                      Undocumented

                                                                      Declaration

                                                                      Swift

                                                                      - 
                                                                      public func af_imageAspectScaled(toFit size: CGSize) -> UIImage
                                                                      + 
                                                                      public func af_imageAspectScaled(toFit size: CGSize, scale: CGFloat? = nil) -> UIImage
                                                                      -
                                                                      -

                                                                      Parameters

                                                                      - - - - - - - -
                                                                      - - size - - -
                                                                      -

                                                                      The size to use when scaling the new image.

                                                                      -
                                                                      -
                                                                      -
                                                                      -
                                                                      -

                                                                      Return Value

                                                                      -

                                                                      A new image object.

                                                                      -
                                                                    • @@ -582,47 +498,32 @@

                                                                      Return Value

                                                                      -

                                                                      Returns a new version of the image scaled from the center while maintaining the aspect ratio to fill a -specified size. Any pixels that fall outside the specified size are clipped.

                                                                      +

                                                                      Undocumented

                                                                      Declaration

                                                                      Swift

                                                                      - 
                                                                      public func af_imageAspectScaled(toFill size: CGSize) -> UIImage
                                                                      + 
                                                                      public func af_imageAspectScaled(toFill size: CGSize, scale: CGFloat? = nil) -> UIImage
                                                                      -
                                                                      -

                                                                      Parameters

                                                                      - - - - - - - -
                                                                      - - size - - -
                                                                      -

                                                                      The size to use when scaling the new image.

                                                                      -
                                                                      -
                                                                      -
                                                                      -
                                                                      -

                                                                      Return Value

                                                                      -

                                                                      A new image object.

                                                                      -
                                                                    +
                                                                    + + +
                                                                    + +

                                                                    Rounded Corners

                                                                    +

                                                                    +
                                                                    +
                                                                    • @@ -637,7 +538,7 @@

                                                                      Return Value

                                                                      -

                                                                      Returns a new version of the image with the corners rounded to the specified radius.

                                                                      +

                                                                      Undocumented

                                                                      @@ -648,45 +549,6 @@

                                                                      Declaration

                                                                      -
                                                                      -

                                                                      Parameters

                                                                      - - - - - - - - - - - -
                                                                      - - radius - - -
                                                                      -

                                                                      The radius to use when rounding the new image.

                                                                      -
                                                                      -
                                                                      - - divideRadiusByImageScale - - -
                                                                      -

                                                                      Whether to divide the radius by the image scale. Set to true when the - image has the same resolution for all screen scales such as @1x, @2x and - @3x (i.e. single image from web server). Set to false for images loaded - from an asset catalog with varying resolutions for each screen scale. - false by default.

                                                                      -
                                                                      -
                                                                      -
                                                                      -
                                                                      -

                                                                      Return Value

                                                                      -

                                                                      A new image object.

                                                                      -
                                                                    • @@ -703,7 +565,7 @@

                                                                    Return Value

                                                                    -

                                                                    Returns a new version of the image rounded into a circle.

                                                                    +

                                                                    Undocumented

                                                                    @@ -714,16 +576,21 @@

                                                                    Declaration

                                                                    -
                                                                    -

                                                                    Return Value

                                                                    -

                                                                    A new image object.

                                                                    -
                                                                  +
                                                                  + + +
                                                                  + +

                                                                  Core Image Filters

                                                                  +

                                                                  +
                                                                  +
                                                                  • @@ -738,7 +605,7 @@

                                                                    Return Value

                                                                    -

                                                                    Returns a new version of the image using a CoreImage filter with the specified name and parameters.

                                                                    +

                                                                    Undocumented

                                                                    @@ -749,41 +616,6 @@

                                                                    Declaration

                                                                    -
                                                                    -

                                                                    Parameters

                                                                    - - - - - - - - - - - -
                                                                    - - name - - -
                                                                    -

                                                                    The name of the CoreImage filter to use on the new image.

                                                                    -
                                                                    -
                                                                    - - parameters - - -
                                                                    -

                                                                    The parameters to apply to the CoreImage filter.

                                                                    -
                                                                    -
                                                                    -
                                                                    -
                                                                    -

                                                                    Return Value

                                                                    -

                                                                    A new image object, or nil if the filter failed for any reason.

                                                                    -
                                                                  • @@ -795,8 +627,8 @@

                                                                  Return Value

                                                                  -

                                                                  © 2019 Alamofire Software Foundation. All rights reserved. (Last updated: 2019-10-27)

                                                                  -

                                                                  Generated by jazzy ♪♫ v0.11.2, a Realm project.

                                                                  +

                                                                  © 2020 Alamofire Software Foundation. All rights reserved. (Last updated: 2020-02-23)

                                                                  +

                                                                  Generated by jazzy ♪♫ v0.13.1, a Realm project.

                                                                  diff --git a/docs/docsets/AlamofireImage.docset/Contents/Resources/Documents/Extensions/UIImageView.html b/docs/docsets/AlamofireImage.docset/Contents/Resources/Documents/Extensions/UIImageView.html index ebd01849..b10b61b1 100644 --- a/docs/docsets/AlamofireImage.docset/Contents/Resources/Documents/Extensions/UIImageView.html +++ b/docs/docsets/AlamofireImage.docset/Contents/Resources/Documents/Extensions/UIImageView.html @@ -23,7 +23,7 @@ AlamofireImage Docs - (85% documented) + (77% documented)

                                                                  @@ -87,6 +87,9 @@

                                                                • Extensions
                                                                    +
                                                                  • + AlamofireExtension +
                                                                  • DataRequest
                                                                    • @@ -202,11 +205,12 @@
                                                                    -
                                                                    +

                                                                    UIImageView

                                                                    extension UIImageView
                                                                    +
                                                                    extension UIImageView: AlamofireExtended
                                                                    @@ -217,13 +221,6 @@

                                                                    UIImageView

                                                                    -
                                                                    - - - -

                                                                    ImageTransition

                                                                    -                                                                     -
                                                                    • @@ -257,11 +254,13 @@

                                                                      Declaration

                                                                      - - - -

                                                                      Associated Properties

                                                                      -                                                                       + + +
                                                                      + +

                                                                      Deprecated

                                                                      +

                                                                      +
                                                                      • @@ -277,9 +276,7 @@

                                                                        Associated Properties

                                                                        -

                                                                        The instance image downloader used to download all images. If this property is nil, the UIImageView will -fallback on the af_sharedImageDownloader for all downloads. The most common use case for needing to use a -custom instance image downloader is when images are behind different basic auth credentials.

                                                                        +

                                                                        Undocumented

                                                                        @@ -306,10 +303,7 @@

                                                                        Declaration

                                                                        -

                                                                        The shared image downloader used to download all images. By default, this is the default ImageDownloader -instance backed with an AutoPurgingImageCache which automatically evicts images from the cache when the memory -capacity is reached or memory warning notifications occur. The shared image downloader is only used if the -af_imageDownloader is nil.

                                                                        +

                                                                        Undocumented

                                                                        @@ -323,23 +317,12 @@

                                                                        Declaration

                                                                        • -
                                                                      -
                                                                      -
                                                                      -
                                                                      - - - -

                                                                      Image Download

                                                                      -                                                                       -
                                                                      -
                                                                      • @@ -347,158 +330,35 @@

                                                                        Image Download

                                                                        -

                                                                        Asynchronously downloads an image from the specified URL, applies the specified image filter to the downloaded -image and sets it once finished while executing the image transition.

                                                                        - -

                                                                        If the image is cached locally, the image is set immediately. Otherwise the specified placeholder image will be -set immediately, and then the remote image will be set once the image request is finished.

                                                                        - -

                                                                        The completion closure is called after the image download and filtering are complete, but before the start of -the image transition. Please note it is no longer the responsibility of the completion closure to set the -image. It will be set automatically. If you require a second notification after the image transition completes, -use a .Custom image transition with a completion closure. The .Custom completion closure is called when -the image transition is finished.

                                                                        +

                                                                        Undocumented

                                                                        Declaration

                                                                        Swift

                                                                        - 
                                                                        public func af_setImage(
-    withURL url: URL,
-    placeholderImage: UIImage? = nil,
-    filter: ImageFilter? = nil,
-    progress: ImageDownloader.ProgressHandler? = nil,
-    progressQueue: DispatchQueue = DispatchQueue.main,
-    imageTransition: ImageTransition = .noTransition,
-    runImageTransitionIfCached: Bool = false,
-    completion: ((AFIDataResponse<UIImage>) -> Void)? = nil)
                                                                        + 
                                                                        public func af_setImage(withURL url: URL,
+                        cacheKey: String? = nil,
+                        placeholderImage: UIImage? = nil,
+                        serializer: ImageResponseSerializer? = nil,
+                        filter: ImageFilter? = nil,
+                        progress: ImageDownloader.ProgressHandler? = nil,
+                        progressQueue: DispatchQueue = DispatchQueue.main,
+                        imageTransition: ImageTransition = .noTransition,
+                        runImageTransitionIfCached: Bool = false,
+                        completion: ((AFIDataResponse<UIImage>) -> Void)? = nil)
                                                                        -
                                                                        -

                                                                        Parameters

                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                        - - url - - -
                                                                        -

                                                                        The URL used for the image request.

                                                                        -
                                                                        -
                                                                        - - placeholderImage - - -
                                                                        -

                                                                        The image to be set initially until the image request finished. If - nil, the image view will not change its image until the image - request finishes. Defaults to nil.

                                                                        -
                                                                        -
                                                                        - - filter - - -
                                                                        -

                                                                        The image filter applied to the image after the image request is - finished. Defaults to nil.

                                                                        -
                                                                        -
                                                                        - - progress - - -
                                                                        -

                                                                        The closure to be executed periodically during the lifecycle of the - request. Defaults to nil.

                                                                        -
                                                                        -
                                                                        - - progressQueue - - -
                                                                        -

                                                                        The dispatch queue to call the progress closure on. Defaults to the - main queue.

                                                                        -
                                                                        -
                                                                        - - imageTransition - - -
                                                                        -

                                                                        The image transition animation applied to the image when set. - Defaults to .None.

                                                                        -
                                                                        -
                                                                        - - runImageTransitionIfCached - - -
                                                                        -

                                                                        Whether to run the image transition if the image is cached. Defaults - to false.

                                                                        -
                                                                        -
                                                                        - - completion - - -
                                                                        -

                                                                        A closure to be executed when the image request finishes. The closure - has no return value and takes three arguments: the original request, - the response from the server and the result containing either the - image or the error that occurred. If the image was returned from the - image cache, the response will be nil. Defaults to nil.

                                                                        -
                                                                        -
                                                                        -
                                                                      • @@ -506,163 +366,29 @@

                                                                        Parameters

                                                                        -

                                                                        Asynchronously downloads an image from the specified URL Request, applies the specified image filter to the downloaded -image and sets it once finished while executing the image transition.

                                                                        - -

                                                                        If the image is cached locally, the image is set immediately. Otherwise the specified placeholder image will be -set immediately, and then the remote image will be set once the image request is finished.

                                                                        - -

                                                                        The completion closure is called after the image download and filtering are complete, but before the start of -the image transition. Please note it is no longer the responsibility of the completion closure to set the -image. It will be set automatically. If you require a second notification after the image transition completes, -use a .Custom image transition with a completion closure. The .Custom completion closure is called when -the image transition is finished.

                                                                        +

                                                                        Undocumented

                                                                        Declaration

                                                                        Swift

                                                                        - 
                                                                        public func af_setImage(
-    withURLRequest urlRequest: URLRequestConvertible,
-    placeholderImage: UIImage? = nil,
-    filter: ImageFilter? = nil,
-    progress: ImageDownloader.ProgressHandler? = nil,
-    progressQueue: DispatchQueue = DispatchQueue.main,
-    imageTransition: ImageTransition = .noTransition,
-    runImageTransitionIfCached: Bool = false,
-    completion: ((AFIDataResponse<UIImage>) -> Void)? = nil)
                                                                        + 
                                                                        public func af_setImage(withURLRequest urlRequest: URLRequestConvertible,
+                        cacheKey: String? = nil,
+                        placeholderImage: UIImage? = nil,
+                        serializer: ImageResponseSerializer? = nil,
+                        filter: ImageFilter? = nil,
+                        progress: ImageDownloader.ProgressHandler? = nil,
+                        progressQueue: DispatchQueue = DispatchQueue.main,
+                        imageTransition: ImageTransition = .noTransition,
+                        runImageTransitionIfCached: Bool = false,
+                        completion: ((AFIDataResponse<UIImage>) -> Void)? = nil)
                                                                        -
                                                                        -

                                                                        Parameters

                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                        - - urlRequest - - -
                                                                        -

                                                                        The URL request.

                                                                        -
                                                                        -
                                                                        - - placeholderImage - - -
                                                                        -

                                                                        The image to be set initially until the image request finished. If - nil, the image view will not change its image until the image - request finishes. Defaults to nil.

                                                                        -
                                                                        -
                                                                        - - filter - - -
                                                                        -

                                                                        The image filter applied to the image after the image request is - finished. Defaults to nil.

                                                                        -
                                                                        -
                                                                        - - progress - - -
                                                                        -

                                                                        The closure to be executed periodically during the lifecycle of the - request. Defaults to nil.

                                                                        -
                                                                        -
                                                                        - - progressQueue - - -
                                                                        -

                                                                        The dispatch queue to call the progress closure on. Defaults to the - main queue.

                                                                        -
                                                                        -
                                                                        - - imageTransition - - -
                                                                        -

                                                                        The image transition animation applied to the image when set. - Defaults to .None.

                                                                        -
                                                                        -
                                                                        - - runImageTransitionIfCached - - -
                                                                        -

                                                                        Whether to run the image transition if the image is cached. Defaults - to false.

                                                                        -
                                                                        -
                                                                        - - completion - - -
                                                                        -

                                                                        A closure to be executed when the image request finishes. The closure - has no return value and takes three arguments: the original request, - the response from the server and the result containing either the - image or the error that occurred. If the image was returned from the - image cache, the response will be nil. Defaults to nil.

                                                                        -
                                                                        -
                                                                        -
                                                                        • -
                                                                      -
                                                                      -
                                                                      -
                                                                      - - - -

                                                                      Image Download Cancellation

                                                                      -                                                                       -
                                                                      -
                                                                      • @@ -676,7 +402,7 @@

                                                                        Image Download Cancellation

                                                                        -

                                                                        Cancels the active download request, if one exists.

                                                                        +

                                                                        Undocumented

                                                                        @@ -690,17 +416,6 @@

                                                                        Declaration

                                                                        • -
                                                                      -
                                                                      -
                                                                      -
                                                                      - - - -

                                                                      Image Transition

                                                                      -                                                                       -
                                                                      -
                                                                      • @@ -714,7 +429,7 @@

                                                                        Image Transition

                                                                        -

                                                                        Runs the image transition on the image view with the specified image.

                                                                        +

                                                                        Undocumented

                                                                        @@ -725,37 +440,6 @@

                                                                        Declaration

                                                                        -
                                                                        -

                                                                        Parameters

                                                                        - - - - - - - - - - - -
                                                                        - - imageTransition - - -
                                                                        -

                                                                        The image transition to ran on the image view.

                                                                        -
                                                                        -
                                                                        - - image - - -
                                                                        -

                                                                        The image to use for the image transition.

                                                                        -
                                                                        -
                                                                        -
                                                                    @@ -767,8 +451,8 @@

                                                                    Parameters

                                                                    -

                                                                    © 2019 Alamofire Software Foundation. All rights reserved. (Last updated: 2019-10-27)

                                                                    -

                                                                    Generated by jazzy ♪♫ v0.11.2, a Realm project.

                                                                    +

                                                                    © 2020 Alamofire Software Foundation. All rights reserved. (Last updated: 2020-02-23)

                                                                    +

                                                                    Generated by jazzy ♪♫ v0.13.1, a Realm project.

                                                                    diff --git a/docs/docsets/AlamofireImage.docset/Contents/Resources/Documents/Extensions/UIImageView/ImageTransition.html b/docs/docsets/AlamofireImage.docset/Contents/Resources/Documents/Extensions/UIImageView/ImageTransition.html index 34c149b6..4b917fc9 100644 --- a/docs/docsets/AlamofireImage.docset/Contents/Resources/Documents/Extensions/UIImageView/ImageTransition.html +++ b/docs/docsets/AlamofireImage.docset/Contents/Resources/Documents/Extensions/UIImageView/ImageTransition.html @@ -23,7 +23,7 @@ AlamofireImage Docs - (85% documented) + (77% documented)

                                                                    @@ -87,6 +87,9 @@

                                                                  • Extensions
                                                                      +
                                                                    • + AlamofireExtension +
                                                                    • DataRequest
                                                                      • @@ -202,7 +205,7 @@
                                                                      -
                                                                      +

                                                                      ImageTransition

                                                                      @@ -536,7 +539,7 @@

                                                                      Declaration

                                                                      Declaration

                                                                      Swift

                                                                      - 
                                                                      public var animations: ((UIImageView, Image) -> Void) { get }
                                                                      + 
                                                                      public var animations: (UIImageView, Image) -> Void { get }
                                                                      @@ -578,8 +581,8 @@

                                                                      Declaration

                                                                      -

                                                                      © 2019 Alamofire Software Foundation. All rights reserved. (Last updated: 2019-10-27)

                                                                      -

                                                                      Generated by jazzy ♪♫ v0.11.2, a Realm project.

                                                                      +

                                                                      © 2020 Alamofire Software Foundation. All rights reserved. (Last updated: 2020-02-23)

                                                                      +

                                                                      Generated by jazzy ♪♫ v0.13.1, a Realm project.

                                                                      diff --git a/docs/docsets/AlamofireImage.docset/Contents/Resources/Documents/Protocols.html b/docs/docsets/AlamofireImage.docset/Contents/Resources/Documents/Protocols.html index d2c9ec4b..af72684c 100644 --- a/docs/docsets/AlamofireImage.docset/Contents/Resources/Documents/Protocols.html +++ b/docs/docsets/AlamofireImage.docset/Contents/Resources/Documents/Protocols.html @@ -23,7 +23,7 @@ AlamofireImage Docs - (85% documented) + (77% documented)

                                                                      @@ -87,6 +87,9 @@

                                                                    • Extensions
                                                                        +
                                                                      • + AlamofireExtension +
                                                                      • DataRequest
                                                                        • @@ -202,7 +205,7 @@
                                                                        -
                                                                        +

                                                                        Protocols

                                                                        The following protocols are available globally.

                                                                        @@ -215,9 +218,11 @@

                                                                        Protocols

                                                                        - -

                                                                        ImageCache

                                                                        -                                                                         +
                                                                        + +

                                                                        ImageCache

                                                                        +

                                                                        +
                                                                        -

                                                                        © 2019 Alamofire Software Foundation. All rights reserved. (Last updated: 2019-10-27)

                                                                        -

                                                                        Generated by jazzy ♪♫ v0.11.2, a Realm project.

                                                                        +

                                                                        © 2020 Alamofire Software Foundation. All rights reserved. (Last updated: 2020-02-23)

                                                                        +

                                                                        Generated by jazzy ♪♫ v0.13.1, a Realm project.

                                                                        diff --git a/docs/docsets/AlamofireImage.docset/Contents/Resources/Documents/Protocols/CompositeImageFilter.html b/docs/docsets/AlamofireImage.docset/Contents/Resources/Documents/Protocols/CompositeImageFilter.html index 0357abf0..1671bc9d 100644 --- a/docs/docsets/AlamofireImage.docset/Contents/Resources/Documents/Protocols/CompositeImageFilter.html +++ b/docs/docsets/AlamofireImage.docset/Contents/Resources/Documents/Protocols/CompositeImageFilter.html @@ -23,7 +23,7 @@ AlamofireImage Docs - (85% documented) + (77% documented)

                                                                        @@ -87,6 +87,9 @@

                                                                      • Extensions
                                                                          +
                                                                        • + AlamofireExtension +
                                                                        • DataRequest
                                                                          • @@ -202,7 +205,7 @@
                                                                          -
                                                                          +

                                                                          CompositeImageFilter

                                                                          @@ -252,9 +255,11 @@

                                                                          Declaration

                                                                          - -

                                                                          CompositeImageFilter

                                                                          -                                                                           +
                                                                          + +

                                                                          CompositeImageFilter

                                                                          +

                                                                          +
                                                                          • @@ -325,8 +330,8 @@

                                                                            Declaration

                                                                          -

                                                                          © 2019 Alamofire Software Foundation. All rights reserved. (Last updated: 2019-10-27)

                                                                          -

                                                                          Generated by jazzy ♪♫ v0.11.2, a Realm project.

                                                                          +

                                                                          © 2020 Alamofire Software Foundation. All rights reserved. (Last updated: 2020-02-23)

                                                                          +

                                                                          Generated by jazzy ♪♫ v0.13.1, a Realm project.

                                                                          diff --git a/docs/docsets/AlamofireImage.docset/Contents/Resources/Documents/Protocols/CoreImageFilter.html b/docs/docsets/AlamofireImage.docset/Contents/Resources/Documents/Protocols/CoreImageFilter.html index abc3b936..0b8dc0a3 100644 --- a/docs/docsets/AlamofireImage.docset/Contents/Resources/Documents/Protocols/CoreImageFilter.html +++ b/docs/docsets/AlamofireImage.docset/Contents/Resources/Documents/Protocols/CoreImageFilter.html @@ -23,7 +23,7 @@ AlamofireImage Docs - (85% documented) + (77% documented)

                                                                          @@ -87,6 +87,9 @@

                                                                        • Extensions
                                                                            +
                                                                          • + AlamofireExtension +
                                                                          • DataRequest
                                                                            • @@ -202,7 +205,7 @@
                                                                            -
                                                                            +

                                                                            CoreImageFilter

                                                                            @@ -282,8 +285,8 @@

                                                                            Declaration

                                                                            -

                                                                            © 2019 Alamofire Software Foundation. All rights reserved. (Last updated: 2019-10-27)

                                                                            -

                                                                            Generated by jazzy ♪♫ v0.11.2, a Realm project.

                                                                            +

                                                                            © 2020 Alamofire Software Foundation. All rights reserved. (Last updated: 2020-02-23)

                                                                            +

                                                                            Generated by jazzy ♪♫ v0.13.1, a Realm project.

                                                                            diff --git a/docs/docsets/AlamofireImage.docset/Contents/Resources/Documents/Protocols/ImageCache.html b/docs/docsets/AlamofireImage.docset/Contents/Resources/Documents/Protocols/ImageCache.html index 658762ae..684fb672 100644 --- a/docs/docsets/AlamofireImage.docset/Contents/Resources/Documents/Protocols/ImageCache.html +++ b/docs/docsets/AlamofireImage.docset/Contents/Resources/Documents/Protocols/ImageCache.html @@ -23,7 +23,7 @@ AlamofireImage Docs - (85% documented) + (77% documented)

                                                                            @@ -87,6 +87,9 @@

                                                                          • Extensions
                                                                              +
                                                                            • + AlamofireExtension +
                                                                            • DataRequest
                                                                              • @@ -202,7 +205,7 @@
                                                                              -
                                                                              +

                                                                              ImageCache

                                                                              @@ -336,8 +339,8 @@

                                                                              Declaration

                                                                              -

                                                                              © 2019 Alamofire Software Foundation. All rights reserved. (Last updated: 2019-10-27)

                                                                              -

                                                                              Generated by jazzy ♪♫ v0.11.2, a Realm project.

                                                                              +

                                                                              © 2020 Alamofire Software Foundation. All rights reserved. (Last updated: 2020-02-23)

                                                                              +

                                                                              Generated by jazzy ♪♫ v0.13.1, a Realm project.

                                                                              diff --git a/docs/docsets/AlamofireImage.docset/Contents/Resources/Documents/Protocols/ImageFilter.html b/docs/docsets/AlamofireImage.docset/Contents/Resources/Documents/Protocols/ImageFilter.html index 5577cf96..397ee220 100644 --- a/docs/docsets/AlamofireImage.docset/Contents/Resources/Documents/Protocols/ImageFilter.html +++ b/docs/docsets/AlamofireImage.docset/Contents/Resources/Documents/Protocols/ImageFilter.html @@ -23,7 +23,7 @@ AlamofireImage Docs - (85% documented) + (77% documented)

                                                                              @@ -87,6 +87,9 @@

                                                                            • Extensions
                                                                                +
                                                                              • + AlamofireExtension +
                                                                              • DataRequest
                                                                                • @@ -202,7 +205,7 @@
                                                                                -
                                                                                +

                                                                                ImageFilter

                                                                                @@ -225,6 +228,33 @@

                                                                                ImageFilter

                                                                                filter + +
                                                                                +
                                                                                +
                                                                                +
                                                                                +
                                                                                +
                                                                                +

                                                                                A closure used to create an alternative representation of the given image.

                                                                                + +
                                                                                +
                                                                                +

                                                                                Declaration

                                                                                +
                                                                                +

                                                                                Swift

                                                                                + 
                                                                                var filter: (Image) -> Image { get }
                                                                                + +
                                                                                +
                                                                                +
                                                                                +
                                                                                + +
                                                                              • +
                                                                                + + + + identifier Default implementation @@ -235,8 +265,149 @@

                                                                                ImageFilter

                                                                                -

                                                                                A closure used to create an alternative representation of the given image.

                                                                                +

                                                                                The string used to uniquely identify the filter operation.

                                                                                + +
                                                                                +

                                                                                Default Implementation

                                                                                +
                                                                                +

                                                                                The unique identifier for any ImageFilter type.

                                                                                + +
                                                                                +
                                                                                +

                                                                                Declaration

                                                                                +
                                                                                +

                                                                                Swift

                                                                                + 
                                                                                var identifier: String { get }
                                                                                + +
                                                                                +
                                                                                +
                                                                                +
                                                                                +
                                                                                • +
                                                                              + +
                                                                              +
                                                                              + + +
                                                                              + +

                                                                              Available where Self: Sizable

                                                                              +

                                                                              +
                                                                              +
                                                                              +
                                                                                +
                                                                              • +
                                                                                + + + + identifier + + + Default implementation + +
                                                                                +
                                                                                +
                                                                                +
                                                                                +
                                                                                +
                                                                                + +
                                                                                +

                                                                                Default Implementation

                                                                                +
                                                                                +

                                                                                The unique idenitifier for an ImageFilter conforming to the Sizable protocol.

                                                                                +
                                                                                +
                                                                                +

                                                                                Declaration

                                                                                +
                                                                                +

                                                                                Swift

                                                                                + 
                                                                                public var identifier: String { get }
                                                                                + +
                                                                                +
                                                                                +
                                                                                +
                                                                                +
                                                                                • +
                                                                              +
                                                                              +
                                                                              +
                                                                              + + +
                                                                              + +

                                                                              Available where Self: Roundable

                                                                              +

                                                                              +
                                                                              +
                                                                              +
                                                                                +
                                                                              • +
                                                                                + + + + identifier + + + Default implementation + +
                                                                                +
                                                                                +
                                                                                +
                                                                                +
                                                                                +
                                                                                + +
                                                                                +

                                                                                Default Implementation

                                                                                +
                                                                                +

                                                                                The unique idenitifier for an ImageFilter conforming to the Roundable protocol.

                                                                                + +
                                                                                +
                                                                                +

                                                                                Declaration

                                                                                +
                                                                                +

                                                                                Swift

                                                                                + 
                                                                                public var identifier: String { get }
                                                                                + +
                                                                                +
                                                                                +
                                                                                +
                                                                                +
                                                                                • +
                                                                              +
                                                                              +
                                                                              +
                                                                              + + +
                                                                              + +

                                                                              Available where Self: CoreImageFilter

                                                                              +

                                                                              +
                                                                              +
                                                                              +
                                                                                +
                                                                              • +
                                                                                + + + + filter + + + Default implementation + +
                                                                                +
                                                                                +
                                                                                +
                                                                                +
                                                                                +
                                                                                +

                                                                                Default Implementation

                                                                                @@ -257,9 +428,9 @@

                                                                                Declaration

                                                                              • - + - identifier + identifier Default implementation @@ -270,8 +441,7 @@

                                                                                Declaration

                                                                                -

                                                                                The string used to uniquely identify the filter operation.

                                                                                - +

                                                                                Default Implementation

                                                                                @@ -297,8 +467,8 @@

                                                                                Declaration

                                                                                -

                                                                                © 2019 Alamofire Software Foundation. All rights reserved. (Last updated: 2019-10-27)

                                                                                -

                                                                                Generated by jazzy ♪♫ v0.11.2, a Realm project.

                                                                                +

                                                                                © 2020 Alamofire Software Foundation. All rights reserved. (Last updated: 2020-02-23)

                                                                                +

                                                                                Generated by jazzy ♪♫ v0.13.1, a Realm project.

                                                                                diff --git a/docs/docsets/AlamofireImage.docset/Contents/Resources/Documents/Protocols/ImageRequestCache.html b/docs/docsets/AlamofireImage.docset/Contents/Resources/Documents/Protocols/ImageRequestCache.html index afc17be9..d2d07848 100644 --- a/docs/docsets/AlamofireImage.docset/Contents/Resources/Documents/Protocols/ImageRequestCache.html +++ b/docs/docsets/AlamofireImage.docset/Contents/Resources/Documents/Protocols/ImageRequestCache.html @@ -23,7 +23,7 @@ AlamofireImage Docs - (85% documented) + (77% documented)

                                                                                @@ -87,6 +87,9 @@

                                                                              • Extensions
                                                                                • -

                                                                                © 2019 Alamofire Software Foundation. All rights reserved. (Last updated: 2019-10-27)

                                                                                -

                                                                                Generated by jazzy ♪♫ v0.11.2, a Realm project.

                                                                                +

                                                                                © 2020 Alamofire Software Foundation. All rights reserved. (Last updated: 2020-02-23)

                                                                                +

                                                                                Generated by jazzy ♪♫ v0.13.1, a Realm project.

                                                                                diff --git a/docs/docsets/AlamofireImage.docset/Contents/Resources/Documents/Protocols/Roundable.html b/docs/docsets/AlamofireImage.docset/Contents/Resources/Documents/Protocols/Roundable.html index 10d49efa..55321cee 100644 --- a/docs/docsets/AlamofireImage.docset/Contents/Resources/Documents/Protocols/Roundable.html +++ b/docs/docsets/AlamofireImage.docset/Contents/Resources/Documents/Protocols/Roundable.html @@ -23,7 +23,7 @@ AlamofireImage Docs - (85% documented) + (77% documented)

                                                                                @@ -87,6 +87,9 @@

                                                                              • Extensions
                                                                              -

                                                                              © 2019 Alamofire Software Foundation. All rights reserved. (Last updated: 2019-10-27)

                                                                              -

                                                                              Generated by jazzy ♪♫ v0.11.2, a Realm project.

                                                                              +

                                                                              © 2020 Alamofire Software Foundation. All rights reserved. (Last updated: 2020-02-23)

                                                                              +

                                                                              Generated by jazzy ♪♫ v0.13.1, a Realm project.

                                                                              diff --git a/docs/docsets/AlamofireImage.docset/Contents/Resources/Documents/Protocols/Sizable.html b/docs/docsets/AlamofireImage.docset/Contents/Resources/Documents/Protocols/Sizable.html index b8c7b482..f90f379a 100644 --- a/docs/docsets/AlamofireImage.docset/Contents/Resources/Documents/Protocols/Sizable.html +++ b/docs/docsets/AlamofireImage.docset/Contents/Resources/Documents/Protocols/Sizable.html @@ -23,7 +23,7 @@ AlamofireImage Docs - (85% documented) + (77% documented)

                                                                              @@ -87,6 +87,9 @@

                                                                            • Extensions
                                                                                +
                                                                              • + AlamofireExtension +
                                                                              • DataRequest
                                                                                • @@ -202,7 +205,7 @@
                                                                                -
                                                                                +

                                                                                Sizable

                                                                                @@ -254,8 +257,8 @@

                                                                                Declaration

                                                                                -

                                                                                © 2019 Alamofire Software Foundation. All rights reserved. (Last updated: 2019-10-27)

                                                                                -

                                                                                Generated by jazzy ♪♫ v0.11.2, a Realm project.

                                                                                +

                                                                                © 2020 Alamofire Software Foundation. All rights reserved. (Last updated: 2020-02-23)

                                                                                +

                                                                                Generated by jazzy ♪♫ v0.13.1, a Realm project.

                                                                                diff --git a/docs/docsets/AlamofireImage.docset/Contents/Resources/Documents/Structs.html b/docs/docsets/AlamofireImage.docset/Contents/Resources/Documents/Structs.html index b9a42c4b..d27c5840 100644 --- a/docs/docsets/AlamofireImage.docset/Contents/Resources/Documents/Structs.html +++ b/docs/docsets/AlamofireImage.docset/Contents/Resources/Documents/Structs.html @@ -23,7 +23,7 @@ AlamofireImage Docs - (85% documented) + (77% documented)

                                                                                @@ -87,6 +87,9 @@

                                                                              • Extensions - -
                                                                                -
                                                                                • @@ -391,10 +396,6 @@

                                                                                  Declaration

                                                                                  • -
                                                                                -
                                                                                -
                                                                                -
                                                                                • @@ -423,10 +424,6 @@

                                                                                  Declaration

                                                                                  • -
                                                                                -
                                                                                -
                                                                                -
                                                                                • @@ -455,10 +452,6 @@

                                                                                  Declaration

                                                                                  • -
                                                                                -
                                                                                -
                                                                                - -
                                                                                -
                                                                                -
                                                                                • @@ -592,10 +583,6 @@

                                                                                  Declaration

                                                                                  • -
                                                                                -
                                                                                -
                                                                                -
                                                                                diff --git a/docs/docsets/AlamofireImage.docset/Contents/Resources/Documents/Structs/AspectScaledToFillSizeCircleFilter.html b/docs/docsets/AlamofireImage.docset/Contents/Resources/Documents/Structs/AspectScaledToFillSizeCircleFilter.html index 8e2c8b01..6bfccc08 100644 --- a/docs/docsets/AlamofireImage.docset/Contents/Resources/Documents/Structs/AspectScaledToFillSizeCircleFilter.html +++ b/docs/docsets/AlamofireImage.docset/Contents/Resources/Documents/Structs/AspectScaledToFillSizeCircleFilter.html @@ -23,7 +23,7 @@ AlamofireImage Docs - (85% documented) + (77% documented)

                                                                                @@ -87,6 +87,9 @@

                                                                              • Extensions
                                                                                  +
                                                                                • + AlamofireExtension +
                                                                                • DataRequest
                                                                                  • @@ -202,7 +205,7 @@
                                                                                  -
                                                                                  +

                                                                                  AspectScaledToFillSizeCircleFilter

                                                                                  @@ -305,8 +308,8 @@

                                                                                  Declaration

                                                                                  -

                                                                                  © 2019 Alamofire Software Foundation. All rights reserved. (Last updated: 2019-10-27)

                                                                                  -

                                                                                  Generated by jazzy ♪♫ v0.11.2, a Realm project.

                                                                                  +

                                                                                  © 2020 Alamofire Software Foundation. All rights reserved. (Last updated: 2020-02-23)

                                                                                  +

                                                                                  Generated by jazzy ♪♫ v0.13.1, a Realm project.

                                                                                  diff --git a/docs/docsets/AlamofireImage.docset/Contents/Resources/Documents/Structs/AspectScaledToFillSizeFilter.html b/docs/docsets/AlamofireImage.docset/Contents/Resources/Documents/Structs/AspectScaledToFillSizeFilter.html index 1d71a0df..13f0084d 100644 --- a/docs/docsets/AlamofireImage.docset/Contents/Resources/Documents/Structs/AspectScaledToFillSizeFilter.html +++ b/docs/docsets/AlamofireImage.docset/Contents/Resources/Documents/Structs/AspectScaledToFillSizeFilter.html @@ -23,7 +23,7 @@ AlamofireImage Docs - (85% documented) + (77% documented)

                                                                                  @@ -87,6 +87,9 @@

                                                                                • Extensions
                                                                                    +
                                                                                  • + AlamofireExtension +
                                                                                  • DataRequest
                                                                                    • @@ -202,7 +205,7 @@
                                                                                    -
                                                                                    +

                                                                                    AspectScaledToFillSizeFilter

                                                                                    @@ -332,8 +335,8 @@

                                                                                    Declaration

                                                                                    -

                                                                                    © 2019 Alamofire Software Foundation. All rights reserved. (Last updated: 2019-10-27)

                                                                                    -

                                                                                    Generated by jazzy ♪♫ v0.11.2, a Realm project.

                                                                                    +

                                                                                    © 2020 Alamofire Software Foundation. All rights reserved. (Last updated: 2020-02-23)

                                                                                    +

                                                                                    Generated by jazzy ♪♫ v0.13.1, a Realm project.

                                                                                    diff --git a/docs/docsets/AlamofireImage.docset/Contents/Resources/Documents/Structs/AspectScaledToFillSizeWithRoundedCornersFilter.html b/docs/docsets/AlamofireImage.docset/Contents/Resources/Documents/Structs/AspectScaledToFillSizeWithRoundedCornersFilter.html index 241d09f8..e3998de9 100644 --- a/docs/docsets/AlamofireImage.docset/Contents/Resources/Documents/Structs/AspectScaledToFillSizeWithRoundedCornersFilter.html +++ b/docs/docsets/AlamofireImage.docset/Contents/Resources/Documents/Structs/AspectScaledToFillSizeWithRoundedCornersFilter.html @@ -23,7 +23,7 @@ AlamofireImage Docs - (85% documented) + (77% documented)

                                                                                    @@ -87,6 +87,9 @@

                                                                                  • Extensions
                                                                                      +
                                                                                    • + AlamofireExtension +
                                                                                    • DataRequest
                                                                                      • @@ -202,7 +205,7 @@
                                                                                      -
                                                                                      +

                                                                                      AspectScaledToFillSizeWithRoundedCornersFilter

                                                                                      @@ -333,8 +336,8 @@

                                                                                      Declaration

                                                                                      -

                                                                                      © 2019 Alamofire Software Foundation. All rights reserved. (Last updated: 2019-10-27)

                                                                                      -

                                                                                      Generated by jazzy ♪♫ v0.11.2, a Realm project.

                                                                                      +

                                                                                      © 2020 Alamofire Software Foundation. All rights reserved. (Last updated: 2020-02-23)

                                                                                      +

                                                                                      Generated by jazzy ♪♫ v0.13.1, a Realm project.

                                                                                      diff --git a/docs/docsets/AlamofireImage.docset/Contents/Resources/Documents/Structs/AspectScaledToFitSizeFilter.html b/docs/docsets/AlamofireImage.docset/Contents/Resources/Documents/Structs/AspectScaledToFitSizeFilter.html index dfbc8c90..c1c1f54e 100644 --- a/docs/docsets/AlamofireImage.docset/Contents/Resources/Documents/Structs/AspectScaledToFitSizeFilter.html +++ b/docs/docsets/AlamofireImage.docset/Contents/Resources/Documents/Structs/AspectScaledToFitSizeFilter.html @@ -23,7 +23,7 @@ AlamofireImage Docs - (85% documented) + (77% documented)

                                                                                      @@ -87,6 +87,9 @@

                                                                                    • Extensions
                                                                                        +
                                                                                      • + AlamofireExtension +
                                                                                      • DataRequest
                                                                                        • @@ -202,7 +205,7 @@
                                                                                        -
                                                                                        +

                                                                                        AspectScaledToFitSizeFilter

                                                                                        @@ -331,8 +334,8 @@

                                                                                        Declaration

                                                                                        -

                                                                                        © 2019 Alamofire Software Foundation. All rights reserved. (Last updated: 2019-10-27)

                                                                                        -

                                                                                        Generated by jazzy ♪♫ v0.11.2, a Realm project.

                                                                                        +

                                                                                        © 2020 Alamofire Software Foundation. All rights reserved. (Last updated: 2020-02-23)

                                                                                        +

                                                                                        Generated by jazzy ♪♫ v0.13.1, a Realm project.

                                                                                        diff --git a/docs/docsets/AlamofireImage.docset/Contents/Resources/Documents/Structs/BlurFilter.html b/docs/docsets/AlamofireImage.docset/Contents/Resources/Documents/Structs/BlurFilter.html index b72dd026..97bd2090 100644 --- a/docs/docsets/AlamofireImage.docset/Contents/Resources/Documents/Structs/BlurFilter.html +++ b/docs/docsets/AlamofireImage.docset/Contents/Resources/Documents/Structs/BlurFilter.html @@ -23,7 +23,7 @@ AlamofireImage Docs - (85% documented) + (77% documented)

                                                                                        @@ -87,6 +87,9 @@

                                                                                      • Extensions
                                                                                          +
                                                                                        • + AlamofireExtension +
                                                                                        • DataRequest
                                                                                          • @@ -202,7 +205,7 @@
                                                                                          -
                                                                                          +

                                                                                          BlurFilter

                                                                                          @@ -332,8 +335,8 @@

                                                                                          Return Value

                                                                                          -

                                                                                          © 2019 Alamofire Software Foundation. All rights reserved. (Last updated: 2019-10-27)

                                                                                          -

                                                                                          Generated by jazzy ♪♫ v0.11.2, a Realm project.

                                                                                          +

                                                                                          © 2020 Alamofire Software Foundation. All rights reserved. (Last updated: 2020-02-23)

                                                                                          +

                                                                                          Generated by jazzy ♪♫ v0.13.1, a Realm project.

                                                                                          diff --git a/docs/docsets/AlamofireImage.docset/Contents/Resources/Documents/Structs/CircleFilter.html b/docs/docsets/AlamofireImage.docset/Contents/Resources/Documents/Structs/CircleFilter.html index 5ed12103..02bd5b9d 100644 --- a/docs/docsets/AlamofireImage.docset/Contents/Resources/Documents/Structs/CircleFilter.html +++ b/docs/docsets/AlamofireImage.docset/Contents/Resources/Documents/Structs/CircleFilter.html @@ -23,7 +23,7 @@ AlamofireImage Docs - (85% documented) + (77% documented)

                                                                                          @@ -87,6 +87,9 @@

                                                                                        • Extensions
                                                                                            +
                                                                                          • + AlamofireExtension +
                                                                                          • DataRequest
                                                                                            • @@ -202,7 +205,7 @@
                                                                                            -
                                                                                            +

                                                                                            CircleFilter

                                                                                            @@ -285,8 +288,8 @@

                                                                                            Declaration

                                                                                            -

                                                                                            © 2019 Alamofire Software Foundation. All rights reserved. (Last updated: 2019-10-27)

                                                                                            -

                                                                                            Generated by jazzy ♪♫ v0.11.2, a Realm project.

                                                                                            +

                                                                                            © 2020 Alamofire Software Foundation. All rights reserved. (Last updated: 2020-02-23)

                                                                                            +

                                                                                            Generated by jazzy ♪♫ v0.13.1, a Realm project.

                                                                                            diff --git a/docs/docsets/AlamofireImage.docset/Contents/Resources/Documents/Structs/DynamicCompositeImageFilter.html b/docs/docsets/AlamofireImage.docset/Contents/Resources/Documents/Structs/DynamicCompositeImageFilter.html index 696e69cf..80b3a6ff 100644 --- a/docs/docsets/AlamofireImage.docset/Contents/Resources/Documents/Structs/DynamicCompositeImageFilter.html +++ b/docs/docsets/AlamofireImage.docset/Contents/Resources/Documents/Structs/DynamicCompositeImageFilter.html @@ -23,7 +23,7 @@ AlamofireImage Docs - (85% documented) + (77% documented)

                                                                                            @@ -87,6 +87,9 @@

                                                                                          • Extensions
                                                                                              +
                                                                                            • + AlamofireExtension +
                                                                                            • DataRequest
                                                                                              • @@ -202,7 +205,7 @@
                                                                                              -
                                                                                              +

                                                                                              DynamicCompositeImageFilter

                                                                                              @@ -354,8 +357,8 @@

                                                                                              Return Value

                                                                                              -

                                                                                              © 2019 Alamofire Software Foundation. All rights reserved. (Last updated: 2019-10-27)

                                                                                              -

                                                                                              Generated by jazzy ♪♫ v0.11.2, a Realm project.

                                                                                              +

                                                                                              © 2020 Alamofire Software Foundation. All rights reserved. (Last updated: 2020-02-23)

                                                                                              +

                                                                                              Generated by jazzy ♪♫ v0.13.1, a Realm project.

                                                                                              diff --git a/docs/docsets/AlamofireImage.docset/Contents/Resources/Documents/Structs/DynamicImageFilter.html b/docs/docsets/AlamofireImage.docset/Contents/Resources/Documents/Structs/DynamicImageFilter.html index 32c4bc0e..6c6d2504 100644 --- a/docs/docsets/AlamofireImage.docset/Contents/Resources/Documents/Structs/DynamicImageFilter.html +++ b/docs/docsets/AlamofireImage.docset/Contents/Resources/Documents/Structs/DynamicImageFilter.html @@ -23,7 +23,7 @@ AlamofireImage Docs - (85% documented) + (77% documented)

                                                                                              @@ -87,6 +87,9 @@

                                                                                            • Extensions
                                                                                                +
                                                                                              • + AlamofireExtension +
                                                                                              • DataRequest
                                                                                                • @@ -202,7 +205,7 @@
                                                                                                -
                                                                                                +

                                                                                                DynamicImageFilter

                                                                                                @@ -343,8 +346,8 @@

                                                                                                Return Value

                                                                                                -

                                                                                                © 2019 Alamofire Software Foundation. All rights reserved. (Last updated: 2019-10-27)

                                                                                                -

                                                                                                Generated by jazzy ♪♫ v0.11.2, a Realm project.

                                                                                                +

                                                                                                © 2020 Alamofire Software Foundation. All rights reserved. (Last updated: 2020-02-23)

                                                                                                +

                                                                                                Generated by jazzy ♪♫ v0.13.1, a Realm project.

                                                                                                diff --git a/docs/docsets/AlamofireImage.docset/Contents/Resources/Documents/Structs/RoundedCornersFilter.html b/docs/docsets/AlamofireImage.docset/Contents/Resources/Documents/Structs/RoundedCornersFilter.html index c74e03ca..6811f147 100644 --- a/docs/docsets/AlamofireImage.docset/Contents/Resources/Documents/Structs/RoundedCornersFilter.html +++ b/docs/docsets/AlamofireImage.docset/Contents/Resources/Documents/Structs/RoundedCornersFilter.html @@ -23,7 +23,7 @@ AlamofireImage Docs - (85% documented) + (77% documented)

                                                                                                @@ -87,6 +87,9 @@

                                                                                              • Extensions
                                                                                                  +
                                                                                                • + AlamofireExtension +
                                                                                                • DataRequest
                                                                                                  • @@ -202,7 +205,7 @@
                                                                                                  -
                                                                                                  +

                                                                                                  RoundedCornersFilter

                                                                                                  @@ -401,8 +404,8 @@

                                                                                                  Declaration

                                                                                                  -

                                                                                                  © 2019 Alamofire Software Foundation. All rights reserved. (Last updated: 2019-10-27)

                                                                                                  -

                                                                                                  Generated by jazzy ♪♫ v0.11.2, a Realm project.

                                                                                                  +

                                                                                                  © 2020 Alamofire Software Foundation. All rights reserved. (Last updated: 2020-02-23)

                                                                                                  +

                                                                                                  Generated by jazzy ♪♫ v0.13.1, a Realm project.

                                                                                                  diff --git a/docs/docsets/AlamofireImage.docset/Contents/Resources/Documents/Structs/ScaledToSizeCircleFilter.html b/docs/docsets/AlamofireImage.docset/Contents/Resources/Documents/Structs/ScaledToSizeCircleFilter.html index 23acf8da..a66133f6 100644 --- a/docs/docsets/AlamofireImage.docset/Contents/Resources/Documents/Structs/ScaledToSizeCircleFilter.html +++ b/docs/docsets/AlamofireImage.docset/Contents/Resources/Documents/Structs/ScaledToSizeCircleFilter.html @@ -23,7 +23,7 @@ AlamofireImage Docs - (85% documented) + (77% documented)

                                                                                                  @@ -87,6 +87,9 @@

                                                                                                • Extensions
                                                                                                    +
                                                                                                  • + AlamofireExtension +
                                                                                                  • DataRequest
                                                                                                    • @@ -202,7 +205,7 @@
                                                                                                    -
                                                                                                    +

                                                                                                    ScaledToSizeCircleFilter

                                                                                                    @@ -304,8 +307,8 @@

                                                                                                    Declaration

                                                                                                    -

                                                                                                    © 2019 Alamofire Software Foundation. All rights reserved. (Last updated: 2019-10-27)

                                                                                                    -

                                                                                                    Generated by jazzy ♪♫ v0.11.2, a Realm project.

                                                                                                    +

                                                                                                    © 2020 Alamofire Software Foundation. All rights reserved. (Last updated: 2020-02-23)

                                                                                                    +

                                                                                                    Generated by jazzy ♪♫ v0.13.1, a Realm project.

                                                                                                    diff --git a/docs/docsets/AlamofireImage.docset/Contents/Resources/Documents/Structs/ScaledToSizeFilter.html b/docs/docsets/AlamofireImage.docset/Contents/Resources/Documents/Structs/ScaledToSizeFilter.html index 95532280..17c39dbb 100644 --- a/docs/docsets/AlamofireImage.docset/Contents/Resources/Documents/Structs/ScaledToSizeFilter.html +++ b/docs/docsets/AlamofireImage.docset/Contents/Resources/Documents/Structs/ScaledToSizeFilter.html @@ -23,7 +23,7 @@ AlamofireImage Docs - (85% documented) + (77% documented)

                                                                                                    @@ -87,6 +87,9 @@

                                                                                                  • Extensions
                                                                                                    @@ -382,7 +370,7 @@

                                                                                                    Inflation

                                                                                                    let data = try! Data(contentsOf: url) let image = UIImage(data: data, scale: UIScreen.main.scale)! -image.af_inflate() +image.af.inflate()
                                                                                                    @@ -393,27 +381,27 @@

                                                                                                    Scaling

                                                                                                    let size = CGSize(width: 100.0, height: 100.0) // Scale image to size disregarding aspect ratio -let scaledImage = image.af_imageScaled(to: size) +let scaledImage = image.af.imageScaled(to: size) // Scale image to fit within specified size while maintaining aspect ratio -let aspectScaledToFitImage = image.af_imageAspectScaled(toFit: size) +let aspectScaledToFitImage = image.af.imageAspectScaled(toFit: size) // Scale image to fill specified size while maintaining aspect ratio -let aspectScaledToFillImage = image.af_imageAspectScaled(toFill: size) +let aspectScaledToFillImage = image.af.imageAspectScaled(toFill: size)

                                                                                                    Rounded Corners

                                                                                                    let image = UIImage(named: "unicorn")!
 let radius: CGFloat = 20.0
 
-let roundedImage = image.af_imageRounded(withCornerRadius: radius)
-let circularImage = image.af_imageRoundedIntoCircle()
+let roundedImage = image.af.imageRounded(withCornerRadius: radius)
+let circularImage = image.af.imageRoundedIntoCircle()

                                                                                                    Core Image Filters

                                                                                                    let image = UIImage(named: "unicorn")!
 
-let sepiaImage = image.af_imageFiltered(withCoreImageFilter: "CISepiaTone")
+let sepiaImage = image.af.imageFiltered(withCoreImageFilter: "CISepiaTone")
 
-let blurredImage = image.af_imageFiltered(
+let blurredImage = image.af.imageFiltered(
     withCoreImageFilter: "CIGaussianBlur",
     parameters: ["inputRadius": 25]
 )
@@ -502,7 +490,7 @@ 
                                                                                                    URL Requests
                                                                                                    
 
                                                                                                    let imageCache = AutoPurgingImageCache()
 
 let urlRequest = URLRequest(url: URL(string: "https://httpbin.org/image/png")!)
-let avatarImage = UIImage(named: "avatar")!.af_imageRoundedIntoCircle()
+let avatarImage = UIImage(named: "avatar")!.af.imageRoundedIntoCircle()
 
 // Add
 imageCache.add(avatarImage, for: urlRequest, withIdentifier: "circle")
@@ -551,7 +539,7 @@ 
                                                                                                    Downloading an Image
                                                                                                    
     print(response.response)
     debugPrint(response.result)
 
-    if let image = response.result.value {
+    if case .success(let image) = response.result {
         print(image)
     }
 }
@@ -570,7 +558,7 @@ 
                                                                                                    Applying an ImageFilter
                                                                                                    
     print(response.response)
     debugPrint(response.result)
 
-    if let image = response.result.value {
+    if case .success(let image) = response.result {
         print(image)
     }
 }
@@ -610,14 +598,14 @@ 
                                                                                                    Setting Ideal Capacity Li
 
                                                                                                    Determining the ideal the in-memory and on-disk capacity limits of the URLCache and AutoPurgingImageCache requires a bit of forethought. You must carefully consider your application’s needs, and tailor the limits accordingly. By default, the combination of caches offers the following storage capacities:
                                                                                                    
 
 
                                                                                                      
-
                                                                                                    • 150 MB of on-disk storage
                                                                                                      • 
-
                                                                                                    • 20 MB of in-memory original image data storage
                                                                                                      • 
-
                                                                                                    • 100 MB of in-memory storage of filtered image content
                                                                                                      • 
+
                                                                                                    • 150 MB of on-disk storage (original image only)
                                                                                                      • 
+
                                                                                                    • 20 MB of in-memory original image data storage (original image only)
                                                                                                      • 
+
                                                                                                    • 100 MB of in-memory storage of filtered image content (filtered image if using filters, otherwise original image)
                                                                                                      • 
 
                                                                                                    • 60 MB preferred memory capacity after purge of filtered image content
                                                                                                      • 
 
                                                                                                    
 
 
                                                                                                    
-
                                                                                                    If you do not use image filters, it is advised to set the memory capacity of the URLCache to zero to avoid storing the same content in-memory twice.
                                                                                                    
+
                                                                                                    If you do not use image filters, it is advised to set the memory capacity of the URLCache to zero. Otherwise, you will be storing the original image data in both the URLCache’s in-memory store as well as the AlamofireImage in-memory store.
                                                                                                    
 
                                                                                                    
 
                                                                                                    Duplicate Downloads
                                                                                                    
 
@@ -643,7 +631,7 @@ 
                                                                                                    Setting Image with URL
                                                                                                    
 
                                                                                                    let imageView = UIImageView(frame: frame)
 let url = URL(string: "https://httpbin.org/image/png")!
 
-imageView.af_setImage(withURL: url)
+imageView.af.setImage(withURL: url)
 
                                                                                                    
 
 
                                                                                                    
@@ -656,7 +644,7 @@ 
                                                                                                    Placeholder Images
                                                                                                    
 let url = URL(string: "https://httpbin.org/image/png")!
 let placeholderImage = UIImage(named: "placeholder")!
 
-imageView.af_setImage(withURL: url, placeholderImage: placeholderImage)
+imageView.af.setImage(withURL: url, placeholderImage: placeholderImage)
 
                                                                                                    
 
 
                                                                                                    
@@ -675,7 +663,7 @@ 
                                                                                                    Image Filters
                                                                                                    
     radius: 20.0
 )
 
-imageView.af_setImage(
+imageView.af.setImage(
     withURL: url,
     placeholderImage: placeholderImage,
     filter: filter
@@ -698,7 +686,7 @@ 
                                                                                                    Image Transitions
                                                                                                    
     radius: 20.0
 )
 
-imageView.af_setImage(
+imageView.af.setImage(
     withURL: url,
     placeholderImage: placeholderImage,
     filter: filter,
@@ -747,7 +735,7 @@ 
                                                                                                    Donations
                                                                                                    
 
                                                                                                    paypal
                                                                                                    
 
                                                                                                    License
                                                                                                    
 
-
                                                                                                    AlamofireImage is released under the MIT license. See LICENSE for details.
                                                                                                    
+
                                                                                                    AlamofireImage is released under the MIT license. See LICENSE for details.
                                                                                                    
 
           
         
@@ -756,8 +744,8 @@ 
                                                                                                    License
                                                                                                    
       
     
     
                                                                                                    
-      
                                                                                                    © 2019 Alamofire Software Foundation. All rights reserved. (Last updated: 2019-10-27)
                                                                                                    
-      
                                                                                                    Generated by jazzy ♪♫ v0.11.2, a Realm project.
                                                                                                    
+      
                                                                                                    © 2020 Alamofire Software Foundation. All rights reserved. (Last updated: 2020-02-23)
                                                                                                    
+      
                                                                                                    Generated by jazzy ♪♫ v0.13.1, a Realm project.
                                                                                                    
     
                                                                                                    
   
 
diff --git a/docs/search.json b/docs/search.json
index 8376de0e..cbaaa574 100644
--- a/docs/search.json
+++ b/docs/search.json
@@ -1 +1 @@
-{"Typealiases.html#/s:14AlamofireImage0B0a":{"name":"Image","abstract":"
                                                                                                    Undocumented
                                                                                                    "},"Typealiases.html#/Image":{"name":"Image"},"Typealiases.html#/s:14AlamofireImage15AFIDataResponsea":{"name":"AFIDataResponse","abstract":"
                                                                                                    Alias for DataResponse<T, AFIError>.
                                                                                                    "},"Typealiases.html#/s:14AlamofireImage9AFIResulta":{"name":"AFIResult","abstract":"
                                                                                                    Alias for Result<T, AFIError>.
                                                                                                    "},"Typealiases.html#/s:14AlamofireImage12ControlStatea":{"name":"ControlState","abstract":"
                                                                                                    Undocumented
                                                                                                    "},"Typealiases.html#/s:14AlamofireImage16AnimationOptionsa":{"name":"AnimationOptions","abstract":"
                                                                                                    Undocumented
                                                                                                    "},"Structs/AspectScaledToFillSizeCircleFilter.html#/s:14AlamofireImage34AspectScaledToFillSizeCircleFilterV4sizeACSo6CGSizeV_tcfc":{"name":"init(size:)","abstract":"
                                                                                                    Initializes the AspectScaledToFillSizeCircleFilter instance with the given size.
                                                                                                    ","parent_name":"AspectScaledToFillSizeCircleFilter"},"Structs/AspectScaledToFillSizeCircleFilter.html#/s:14AlamofireImage34AspectScaledToFillSizeCircleFilterV7filtersSayAA0bI0_pGvp":{"name":"filters","abstract":"
                                                                                                    The image filters to apply to the image in sequential order.
                                                                                                    ","parent_name":"AspectScaledToFillSizeCircleFilter"},"Structs/ScaledToSizeCircleFilter.html#/s:14AlamofireImage24ScaledToSizeCircleFilterV4sizeACSo6CGSizeV_tcfc":{"name":"init(size:)","abstract":"
                                                                                                    Initializes the ScaledToSizeCircleFilter instance with the given size.
                                                                                                    ","parent_name":"ScaledToSizeCircleFilter"},"Structs/ScaledToSizeCircleFilter.html#/s:14AlamofireImage24ScaledToSizeCircleFilterV7filtersSayAA0bG0_pGvp":{"name":"filters","abstract":"
                                                                                                    The image filters to apply to the image in sequential order.
                                                                                                    ","parent_name":"ScaledToSizeCircleFilter"},"Structs/AspectScaledToFillSizeWithRoundedCornersFilter.html#/s:14AlamofireImage46AspectScaledToFillSizeWithRoundedCornersFilterV4size6radius014divideRadiusByB5ScaleACSo6CGSizeV_12CoreGraphics7CGFloatVSbtcfc":{"name":"init(size:radius:divideRadiusByImageScale:)","abstract":"
                                                                                                    Initializes the AspectScaledToFillSizeWithRoundedCornersFilter instance with the given size and radius.
                                                                                                    ","parent_name":"AspectScaledToFillSizeWithRoundedCornersFilter"},"Structs/AspectScaledToFillSizeWithRoundedCornersFilter.html#/s:14AlamofireImage46AspectScaledToFillSizeWithRoundedCornersFilterV7filtersSayAA0bK0_pGvp":{"name":"filters","abstract":"
                                                                                                    The image filters to apply to the image in sequential order.
                                                                                                    ","parent_name":"AspectScaledToFillSizeWithRoundedCornersFilter"},"Structs/ScaledToSizeWithRoundedCornersFilter.html#/s:14AlamofireImage36ScaledToSizeWithRoundedCornersFilterV4size6radius014divideRadiusByB5ScaleACSo6CGSizeV_12CoreGraphics7CGFloatVSbtcfc":{"name":"init(size:radius:divideRadiusByImageScale:)","abstract":"
                                                                                                    Initializes the ScaledToSizeWithRoundedCornersFilter instance with the given size and radius.
                                                                                                    ","parent_name":"ScaledToSizeWithRoundedCornersFilter"},"Structs/ScaledToSizeWithRoundedCornersFilter.html#/s:14AlamofireImage36ScaledToSizeWithRoundedCornersFilterV7filtersSayAA0bI0_pGvp":{"name":"filters","abstract":"
                                                                                                    The image filters to apply to the image in sequential order.
                                                                                                    ","parent_name":"ScaledToSizeWithRoundedCornersFilter"},"Structs/BlurFilter.html#/s:14AlamofireImage10BlurFilterV10filterNameSSvp":{"name":"filterName","abstract":"
                                                                                                    The filter name.
                                                                                                    ","parent_name":"BlurFilter"},"Structs/BlurFilter.html#/s:14AlamofireImage10BlurFilterV10parametersSDySSypGvp":{"name":"parameters","abstract":"
                                                                                                    The image filter parameters passed to CoreImage.
                                                                                                    ","parent_name":"BlurFilter"},"Structs/BlurFilter.html#/s:14AlamofireImage10BlurFilterV10blurRadiusACSu_tcfc":{"name":"init(blurRadius:)","abstract":"
                                                                                                    Initializes the BlurFilter instance with the given blur radius.
                                                                                                    ","parent_name":"BlurFilter"},"Structs/CircleFilter.html#/s:14AlamofireImage12CircleFilterVACycfc":{"name":"init()","abstract":"
                                                                                                    Initializes the CircleFilter instance.
                                                                                                    ","parent_name":"CircleFilter"},"Structs/CircleFilter.html#/s:14AlamofireImage12CircleFilterV6filterySo7UIImageCAFcvp":{"name":"filter","abstract":"
                                                                                                    The filter closure used to create the modified representation of the given image.
                                                                                                    ","parent_name":"CircleFilter"},"Structs/RoundedCornersFilter.html#/s:14AlamofireImage20RoundedCornersFilterV6radius12CoreGraphics7CGFloatVvp":{"name":"radius","abstract":"
                                                                                                    The radius of the filter.
                                                                                                    ","parent_name":"RoundedCornersFilter"},"Structs/RoundedCornersFilter.html#/s:14AlamofireImage20RoundedCornersFilterV014divideRadiusByB5ScaleSbvp":{"name":"divideRadiusByImageScale","abstract":"
                                                                                                    Whether to divide the radius by the image scale.
                                                                                                    ","parent_name":"RoundedCornersFilter"},"Structs/RoundedCornersFilter.html#/s:14AlamofireImage20RoundedCornersFilterV6radius014divideRadiusByB5ScaleAC12CoreGraphics7CGFloatV_Sbtcfc":{"name":"init(radius:divideRadiusByImageScale:)","abstract":"
                                                                                                    Initializes the RoundedCornersFilter instance with the given radius.
                                                                                                    ","parent_name":"RoundedCornersFilter"},"Structs/RoundedCornersFilter.html#/s:14AlamofireImage20RoundedCornersFilterV6filterySo7UIImageCAFcvp":{"name":"filter","abstract":"
                                                                                                    The filter closure used to create the modified representation of the given image.
                                                                                                    ","parent_name":"RoundedCornersFilter"},"Structs/RoundedCornersFilter.html#/s:14AlamofireImage20RoundedCornersFilterV10identifierSSvp":{"name":"identifier","abstract":"
                                                                                                    The unique idenitifier for an ImageFilter conforming to the Roundable protocol.
                                                                                                    ","parent_name":"RoundedCornersFilter"},"Structs/AspectScaledToFillSizeFilter.html#/s:14AlamofireImage28AspectScaledToFillSizeFilterV4sizeSo6CGSizeVvp":{"name":"size","abstract":"
                                                                                                    The size of the filter.
                                                                                                    ","parent_name":"AspectScaledToFillSizeFilter"},"Structs/AspectScaledToFillSizeFilter.html#/s:14AlamofireImage28AspectScaledToFillSizeFilterV4sizeACSo6CGSizeV_tcfc":{"name":"init(size:)","abstract":"
                                                                                                    Initializes the AspectScaledToFillSizeFilter instance with the given size.
                                                                                                    ","parent_name":"AspectScaledToFillSizeFilter"},"Structs/AspectScaledToFillSizeFilter.html#/s:14AlamofireImage28AspectScaledToFillSizeFilterV6filterySo7UIImageCAFcvp":{"name":"filter","abstract":"
                                                                                                    The filter closure used to create the modified representation of the given image.
                                                                                                    ","parent_name":"AspectScaledToFillSizeFilter"},"Structs/AspectScaledToFitSizeFilter.html#/s:14AlamofireImage27AspectScaledToFitSizeFilterV4sizeSo6CGSizeVvp":{"name":"size","abstract":"
                                                                                                    The size of the filter.
                                                                                                    ","parent_name":"AspectScaledToFitSizeFilter"},"Structs/AspectScaledToFitSizeFilter.html#/s:14AlamofireImage27AspectScaledToFitSizeFilterV4sizeACSo6CGSizeV_tcfc":{"name":"init(size:)","abstract":"
                                                                                                    Initializes the AspectScaledToFitSizeFilter instance with the given size.
                                                                                                    ","parent_name":"AspectScaledToFitSizeFilter"},"Structs/AspectScaledToFitSizeFilter.html#/s:14AlamofireImage27AspectScaledToFitSizeFilterV6filterySo7UIImageCAFcvp":{"name":"filter","abstract":"
                                                                                                    The filter closure used to create the modified representation of the given image.
                                                                                                    ","parent_name":"AspectScaledToFitSizeFilter"},"Structs/ScaledToSizeFilter.html#/s:14AlamofireImage18ScaledToSizeFilterV4sizeSo6CGSizeVvp":{"name":"size","abstract":"
                                                                                                    The size of the filter.
                                                                                                    ","parent_name":"ScaledToSizeFilter"},"Structs/ScaledToSizeFilter.html#/s:14AlamofireImage18ScaledToSizeFilterV4sizeACSo6CGSizeV_tcfc":{"name":"init(size:)","abstract":"
                                                                                                    Initializes the ScaledToSizeFilter instance with the given size.
                                                                                                    ","parent_name":"ScaledToSizeFilter"},"Structs/ScaledToSizeFilter.html#/s:14AlamofireImage18ScaledToSizeFilterV6filterySo7UIImageCAFcvp":{"name":"filter","abstract":"
                                                                                                    The filter closure used to create the modified representation of the given image.
                                                                                                    ","parent_name":"ScaledToSizeFilter"},"Structs/DynamicCompositeImageFilter.html#/s:14AlamofireImage016DynamicCompositeB6FilterV7filtersSayAA0bE0_pGvp":{"name":"filters","abstract":"
                                                                                                    The image filters to apply to the image in sequential order.
                                                                                                    ","parent_name":"DynamicCompositeImageFilter"},"Structs/DynamicCompositeImageFilter.html#/s:14AlamofireImage016DynamicCompositeB6FilterVyACSayAA0bE0_pGcfc":{"name":"init(_:)","abstract":"
                                                                                                    Initializes the DynamicCompositeImageFilter instance with the given filters.
                                                                                                    ","parent_name":"DynamicCompositeImageFilter"},"Structs/DynamicCompositeImageFilter.html#/s:14AlamofireImage016DynamicCompositeB6FilterVyAcA0bE0_pd_tcfc":{"name":"init(_:)","abstract":"
                                                                                                    Initializes the DynamicCompositeImageFilter instance with the given filters.
                                                                                                    ","parent_name":"DynamicCompositeImageFilter"},"Structs/DynamicImageFilter.html#/s:14AlamofireImage07DynamicB6FilterV10identifierSSvp":{"name":"identifier","abstract":"
                                                                                                    The string used to uniquely identify the image filter operation.
                                                                                                    ","parent_name":"DynamicImageFilter"},"Structs/DynamicImageFilter.html#/s:14AlamofireImage07DynamicB6FilterV6filterySo7UIImageCAFcvp":{"name":"filter","abstract":"
                                                                                                    A closure used to create an alternative representation of the given image.
                                                                                                    ","parent_name":"DynamicImageFilter"},"Structs/DynamicImageFilter.html#/s:14AlamofireImage07DynamicB6FilterV_6filterACSS_So7UIImageCAFctcfc":{"name":"init(_:filter:)","abstract":"
                                                                                                    Initializes the DynamicImageFilter instance with the specified identifier and filter closure.
                                                                                                    ","parent_name":"DynamicImageFilter"},"Structs/DynamicImageFilter.html":{"name":"DynamicImageFilter","abstract":"
                                                                                                    The DynamicImageFilter class simplifies custom image filter creation by using a trailing closure initializer.
                                                                                                    "},"Structs/DynamicCompositeImageFilter.html":{"name":"DynamicCompositeImageFilter","abstract":"
                                                                                                    The DynamicCompositeImageFilter class is a composite image filter based on a specified array of filters.
                                                                                                    "},"Structs/ScaledToSizeFilter.html":{"name":"ScaledToSizeFilter","abstract":"
                                                                                                    Scales an image to a specified size.
                                                                                                    "},"Structs/AspectScaledToFitSizeFilter.html":{"name":"AspectScaledToFitSizeFilter","abstract":"
                                                                                                    Scales an image from the center while maintaining the aspect ratio to fit within a specified size.
                                                                                                    "},"Structs/AspectScaledToFillSizeFilter.html":{"name":"AspectScaledToFillSizeFilter","abstract":"
                                                                                                    Scales an image from the center while maintaining the aspect ratio to fill a specified size. Any pixels that fall"},"Structs/RoundedCornersFilter.html":{"name":"RoundedCornersFilter","abstract":"
                                                                                                    Rounds the corners of an image to the specified radius.
                                                                                                    "},"Structs/CircleFilter.html":{"name":"CircleFilter","abstract":"
                                                                                                    Rounds the corners of an image into a circle.
                                                                                                    "},"Structs/BlurFilter.html":{"name":"BlurFilter","abstract":"
                                                                                                    Blurs an image using a CIGaussianBlur filter with the specified blur radius.
                                                                                                    "},"Structs/ScaledToSizeWithRoundedCornersFilter.html":{"name":"ScaledToSizeWithRoundedCornersFilter","abstract":"
                                                                                                    Scales an image to a specified size, then rounds the corners to the specified radius.
                                                                                                    "},"Structs/AspectScaledToFillSizeWithRoundedCornersFilter.html":{"name":"AspectScaledToFillSizeWithRoundedCornersFilter","abstract":"
                                                                                                    Scales an image from the center while maintaining the aspect ratio to fit within a specified size, then rounds the"},"Structs/ScaledToSizeCircleFilter.html":{"name":"ScaledToSizeCircleFilter","abstract":"
                                                                                                    Scales an image to a specified size, then rounds the corners into a circle.
                                                                                                    "},"Structs/AspectScaledToFillSizeCircleFilter.html":{"name":"AspectScaledToFillSizeCircleFilter","abstract":"
                                                                                                    Scales an image from the center while maintaining the aspect ratio to fit within a specified size, then rounds the"},"Protocols/CoreImageFilter.html#/s:14AlamofireImage04CoreB6FilterP10filterNameSSvp":{"name":"filterName","abstract":"
                                                                                                    The filter name of the CoreImage filter.
                                                                                                    ","parent_name":"CoreImageFilter"},"Protocols/CoreImageFilter.html#/s:14AlamofireImage04CoreB6FilterP10parametersSDySSypGvp":{"name":"parameters","abstract":"
                                                                                                    The image filter parameters passed to CoreImage.
                                                                                                    ","parent_name":"CoreImageFilter"},"Protocols/CompositeImageFilter.html#/s:14AlamofireImage09CompositeB6FilterP7filtersSayAA0bD0_pGvp":{"name":"filters","abstract":"
                                                                                                    The image filters to apply to the image in sequential order.
                                                                                                    ","parent_name":"CompositeImageFilter"},"Protocols/CompositeImageFilter.html#/s:14AlamofireImage09CompositeB6FilterPAAE10identifierSSvp":{"name":"identifier","abstract":"
                                                                                                    The unique idenitifier for any CompositeImageFilter type.
                                                                                                    ","parent_name":"CompositeImageFilter"},"Protocols/CompositeImageFilter.html#/s:14AlamofireImage09CompositeB6FilterPAAE6filterySo7UIImageCAFcvp":{"name":"filter","abstract":"
                                                                                                    The filter closure for any CompositeImageFilter type.
                                                                                                    ","parent_name":"CompositeImageFilter"},"Protocols/Roundable.html#/s:14AlamofireImage9RoundableP6radius12CoreGraphics7CGFloatVvp":{"name":"radius","abstract":"
                                                                                                    The radius of the type.
                                                                                                    ","parent_name":"Roundable"},"Protocols/Sizable.html#/s:14AlamofireImage7SizableP4sizeSo6CGSizeVvp":{"name":"size","abstract":"
                                                                                                    The size of the type.
                                                                                                    ","parent_name":"Sizable"},"Protocols/ImageFilter.html#/s:14AlamofireImage0B6FilterP6filterySo7UIImageCAFcvp":{"name":"filter","abstract":"
                                                                                                    A closure used to create an alternative representation of the given image.
                                                                                                    ","parent_name":"ImageFilter"},"Protocols/ImageFilter.html#/s:14AlamofireImage0B6FilterP10identifierSSvp":{"name":"identifier","abstract":"
                                                                                                    The string used to uniquely identify the filter operation.
                                                                                                    ","parent_name":"ImageFilter"},"Protocols/ImageRequestCache.html#/s:14AlamofireImage0B12RequestCacheP3add_3for14withIdentifierySo7UIImageC_10Foundation10URLRequestVSSSgtF":{"name":"add(_:for:withIdentifier:)","abstract":"
                                                                                                    Adds the image to the cache using an identifier created from the request and identifier.
                                                                                                    ","parent_name":"ImageRequestCache"},"Protocols/ImageRequestCache.html#/s:14AlamofireImage0B12RequestCacheP06removeB03for14withIdentifierSb10Foundation10URLRequestV_SSSgtF":{"name":"removeImage(for:withIdentifier:)","abstract":"
                                                                                                    Removes the image from the cache using an identifier created from the request and identifier.
                                                                                                    ","parent_name":"ImageRequestCache"},"Protocols/ImageRequestCache.html#/s:14AlamofireImage0B12RequestCacheP5image3for14withIdentifierSo7UIImageCSg10Foundation10URLRequestV_SSSgtF":{"name":"image(for:withIdentifier:)","abstract":"
                                                                                                    Returns the image from the cache associated with an identifier created from the request and identifier.
                                                                                                    ","parent_name":"ImageRequestCache"},"Protocols/ImageCache.html#/s:14AlamofireImage0B5CacheP3add_14withIdentifierySo7UIImageC_SStF":{"name":"add(_:withIdentifier:)","abstract":"
                                                                                                    Adds the image to the cache with the given identifier.
                                                                                                    ","parent_name":"ImageCache"},"Protocols/ImageCache.html#/s:14AlamofireImage0B5CacheP06removeB014withIdentifierSbSS_tF":{"name":"removeImage(withIdentifier:)","abstract":"
                                                                                                    Removes the image from the cache matching the given identifier.
                                                                                                    ","parent_name":"ImageCache"},"Protocols/ImageCache.html#/s:14AlamofireImage0B5CacheP15removeAllImagesSbyF":{"name":"removeAllImages()","abstract":"
                                                                                                    Removes all images stored in the cache.
                                                                                                    ","parent_name":"ImageCache"},"Protocols/ImageCache.html#/s:14AlamofireImage0B5CacheP5image14withIdentifierSo7UIImageCSgSS_tF":{"name":"image(withIdentifier:)","abstract":"
                                                                                                    Returns the image in the cache associated with the given identifier.
                                                                                                    ","parent_name":"ImageCache"},"Protocols/ImageCache.html":{"name":"ImageCache","abstract":"
                                                                                                    The ImageCache protocol defines a set of APIs for adding, removing and fetching images from a cache.
                                                                                                    "},"Protocols/ImageRequestCache.html":{"name":"ImageRequestCache","abstract":"
                                                                                                    The ImageRequestCache protocol extends the ImageCache protocol by adding methods for adding, removing and"},"Protocols/ImageFilter.html":{"name":"ImageFilter","abstract":"
                                                                                                    The ImageFilter protocol defines properties for filtering an image as well as identification of the filter.
                                                                                                    "},"Protocols/Sizable.html":{"name":"Sizable","abstract":"
                                                                                                    The Sizable protocol defines a size property intended for use with ImageFilter types.
                                                                                                    "},"Protocols/Roundable.html":{"name":"Roundable","abstract":"
                                                                                                    The Roundable protocol defines a radius property intended for use with ImageFilter types.
                                                                                                    "},"Protocols/CompositeImageFilter.html":{"name":"CompositeImageFilter","abstract":"
                                                                                                    The CompositeImageFilter protocol defines an additional filters property to support multiple composite filters.
                                                                                                    "},"Protocols/CoreImageFilter.html":{"name":"CoreImageFilter","abstract":"
                                                                                                    The CoreImageFilter protocol defines parameters, filterName properties used by CoreImage.
                                                                                                    "},"Extensions/UIImageView/ImageTransition.html#/s:So11UIImageViewC14AlamofireImageE0D10TransitionO02noE0yA2EmF":{"name":"noTransition","abstract":"
                                                                                                    Undocumented
                                                                                                    ","parent_name":"ImageTransition"},"Extensions/UIImageView/ImageTransition.html#/s:So11UIImageViewC14AlamofireImageE0D10TransitionO13crossDissolveyAESdcAEmF":{"name":"crossDissolve(_:)","abstract":"
                                                                                                    Undocumented
                                                                                                    ","parent_name":"ImageTransition"},"Extensions/UIImageView/ImageTransition.html#/s:So11UIImageViewC14AlamofireImageE0D10TransitionO8curlDownyAESdcAEmF":{"name":"curlDown(_:)","abstract":"
                                                                                                    Undocumented
                                                                                                    ","parent_name":"ImageTransition"},"Extensions/UIImageView/ImageTransition.html#/s:So11UIImageViewC14AlamofireImageE0D10TransitionO6curlUpyAESdcAEmF":{"name":"curlUp(_:)","abstract":"
                                                                                                    Undocumented
                                                                                                    ","parent_name":"ImageTransition"},"Extensions/UIImageView/ImageTransition.html#/s:So11UIImageViewC14AlamofireImageE0D10TransitionO14flipFromBottomyAESdcAEmF":{"name":"flipFromBottom(_:)","abstract":"
                                                                                                    Undocumented
                                                                                                    ","parent_name":"ImageTransition"},"Extensions/UIImageView/ImageTransition.html#/s:So11UIImageViewC14AlamofireImageE0D10TransitionO12flipFromLeftyAESdcAEmF":{"name":"flipFromLeft(_:)","abstract":"
                                                                                                    Undocumented
                                                                                                    ","parent_name":"ImageTransition"},"Extensions/UIImageView/ImageTransition.html#/s:So11UIImageViewC14AlamofireImageE0D10TransitionO13flipFromRightyAESdcAEmF":{"name":"flipFromRight(_:)","abstract":"
                                                                                                    Undocumented
                                                                                                    ","parent_name":"ImageTransition"},"Extensions/UIImageView/ImageTransition.html#/s:So11UIImageViewC14AlamofireImageE0D10TransitionO11flipFromTopyAESdcAEmF":{"name":"flipFromTop(_:)","abstract":"
                                                                                                    Undocumented
                                                                                                    ","parent_name":"ImageTransition"},"Extensions/UIImageView/ImageTransition.html#/s:So11UIImageViewC14AlamofireImageE0D10TransitionO6customyAESd_So22UIViewAnimationOptionsVyAB_So0A0CtcySbcSgtcAEmF":{"name":"custom(duration:animationOptions:animations:completion:)","abstract":"
                                                                                                    Undocumented
                                                                                                    ","parent_name":"ImageTransition"},"Extensions/UIImageView/ImageTransition.html#/s:So11UIImageViewC14AlamofireImageE0D10TransitionO8durationSdvp":{"name":"duration","abstract":"
                                                                                                    The duration of the image transition in seconds.
                                                                                                    ","parent_name":"ImageTransition"},"Extensions/UIImageView/ImageTransition.html#/s:So11UIImageViewC14AlamofireImageE0D10TransitionO16animationOptionsSo015UIViewAnimationG0Vvp":{"name":"animationOptions","abstract":"
                                                                                                    The animation options of the image transition.
                                                                                                    ","parent_name":"ImageTransition"},"Extensions/UIImageView/ImageTransition.html#/s:So11UIImageViewC14AlamofireImageE0D10TransitionO10animationsyyAB_So0A0Ctcvp":{"name":"animations","abstract":"
                                                                                                    The animation options of the image transition.
                                                                                                    ","parent_name":"ImageTransition"},"Extensions/UIImageView/ImageTransition.html#/s:So11UIImageViewC14AlamofireImageE0D10TransitionO10completionySbcSgvp":{"name":"completion","abstract":"
                                                                                                    The completion closure associated with the image transition.
                                                                                                    ","parent_name":"ImageTransition"},"Extensions/UIImageView/ImageTransition.html":{"name":"ImageTransition","abstract":"
                                                                                                    Used to wrap all UIView animation transition options alongside a duration.
                                                                                                    ","parent_name":"UIImageView"},"Extensions/UIImageView.html#/s:So11UIImageViewC14AlamofireImageE18af_imageDownloaderAC0dG0CSgvp":{"name":"af_imageDownloader","abstract":"
                                                                                                    The instance image downloader used to download all images. If this property is nil, the UIImageView will","parent_name":"UIImageView"},"Extensions/UIImageView.html#/s:So11UIImageViewC14AlamofireImageE09af_sharedD10DownloaderAC0dG0CvpZ":{"name":"af_sharedImageDownloader","abstract":"
                                                                                                    The shared image downloader used to download all images. By default, this is the default ImageDownloader","parent_name":"UIImageView"},"Extensions/UIImageView.html#/s:So11UIImageViewC14AlamofireImageE06af_setD07withURL011placeholderD06filter8progress0K5Queue15imageTransition03rundN8IfCached10completiony10Foundation0H0V_So0A0CSgAC0D6Filter_pSgySo10NSProgressCcSgSo17OS_dispatch_queueCAbCE0dN0OSby0C012DataResponseVyAqC8AFIErrorOGcSgtF":{"name":"af_setImage(withURL:placeholderImage:filter:progress:progressQueue:imageTransition:runImageTransitionIfCached:completion:)","abstract":"
                                                                                                    Asynchronously downloads an image from the specified URL, applies the specified image filter to the downloaded","parent_name":"UIImageView"},"Extensions/UIImageView.html#/s:So11UIImageViewC14AlamofireImageE06af_setD014withURLRequest011placeholderD06filter8progress0K5Queue15imageTransition03rundN8IfCached10completiony0C00H11Convertible_p_So0A0CSgAC0D6Filter_pSgySo10NSProgressCcSgSo17OS_dispatch_queueCAbCE0dN0OSbyAM12DataResponseVyApC8AFIErrorOGcSgtF":{"name":"af_setImage(withURLRequest:placeholderImage:filter:progress:progressQueue:imageTransition:runImageTransitionIfCached:completion:)","abstract":"
                                                                                                    Asynchronously downloads an image from the specified URL Request, applies the specified image filter to the downloaded","parent_name":"UIImageView"},"Extensions/UIImageView.html#/s:So11UIImageViewC14AlamofireImageE09af_cancelD7RequestyyF":{"name":"af_cancelImageRequest()","abstract":"
                                                                                                    Cancels the active download request, if one exists.
                                                                                                    ","parent_name":"UIImageView"},"Extensions/UIImageView.html#/s:So11UIImageViewC14AlamofireImageE3run_4withyAbCE0D10TransitionO_So0A0CtF":{"name":"run(_:with:)","abstract":"
                                                                                                    Runs the image transition on the image view with the specified image.
                                                                                                    ","parent_name":"UIImageView"},"Extensions/UIImage.html#/s:So7UIImageC14AlamofireImageE013af_threadSafeC04withABSg10Foundation4DataV_tFZ":{"name":"af_threadSafeImage(with:)","abstract":"
                                                                                                    Initializes and returns the image object with the specified data in a thread-safe manner.
                                                                                                    ","parent_name":"UIImage"},"Extensions/UIImage.html#/s:So7UIImageC14AlamofireImageE013af_threadSafeC04with5scaleABSg10Foundation4DataV_12CoreGraphics7CGFloatVtFZ":{"name":"af_threadSafeImage(with:scale:)","abstract":"
                                                                                                    Initializes and returns the image object with the specified data and scale in a thread-safe manner.
                                                                                                    ","parent_name":"UIImage"},"Extensions/UIImage.html#/s:So7UIImageC14AlamofireImageE11af_inflatedSbvp":{"name":"af_inflated","abstract":"
                                                                                                    Returns whether the image is inflated.
                                                                                                    ","parent_name":"UIImage"},"Extensions/UIImage.html#/s:So7UIImageC14AlamofireImageE10af_inflateyyF":{"name":"af_inflate()","abstract":"
                                                                                                    Inflates the underlying compressed image data to be backed by an uncompressed bitmap representation.
                                                                                                    ","parent_name":"UIImage"},"Extensions/UIImage.html#/s:So7UIImageC14AlamofireImageE25af_containsAlphaComponentSbvp":{"name":"af_containsAlphaComponent","abstract":"
                                                                                                    Returns whether the image contains an alpha component.
                                                                                                    ","parent_name":"UIImage"},"Extensions/UIImage.html#/s:So7UIImageC14AlamofireImageE11af_isOpaqueSbvp":{"name":"af_isOpaque","abstract":"
                                                                                                    Returns whether the image is opaque.
                                                                                                    ","parent_name":"UIImage"},"Extensions/UIImage.html#/s:So7UIImageC14AlamofireImageE14af_imageScaled2toABSo6CGSizeV_tF":{"name":"af_imageScaled(to:)","abstract":"
                                                                                                    Returns a new version of the image scaled to the specified size.
                                                                                                    ","parent_name":"UIImage"},"Extensions/UIImage.html#/s:So7UIImageC14AlamofireImageE20af_imageAspectScaled5toFitABSo6CGSizeV_tF":{"name":"af_imageAspectScaled(toFit:)","abstract":"
                                                                                                    Returns a new version of the image scaled from the center while maintaining the aspect ratio to fit within","parent_name":"UIImage"},"Extensions/UIImage.html#/s:So7UIImageC14AlamofireImageE20af_imageAspectScaled6toFillABSo6CGSizeV_tF":{"name":"af_imageAspectScaled(toFill:)","abstract":"
                                                                                                    Returns a new version of the image scaled from the center while maintaining the aspect ratio to fill a","parent_name":"UIImage"},"Extensions/UIImage.html#/s:So7UIImageC14AlamofireImageE15af_imageRounded16withCornerRadius06dividei2ByC5ScaleAB12CoreGraphics7CGFloatV_SbtF":{"name":"af_imageRounded(withCornerRadius:divideRadiusByImageScale:)","abstract":"
                                                                                                    Returns a new version of the image with the corners rounded to the specified radius.
                                                                                                    ","parent_name":"UIImage"},"Extensions/UIImage.html#/s:So7UIImageC14AlamofireImageE25af_imageRoundedIntoCircleAByF":{"name":"af_imageRoundedIntoCircle()","abstract":"
                                                                                                    Returns a new version of the image rounded into a circle.
                                                                                                    ","parent_name":"UIImage"},"Extensions/UIImage.html#/s:So7UIImageC14AlamofireImageE16af_imageFiltered08withCoreC6Filter10parametersABSgSS_SDySSypGSgtF":{"name":"af_imageFiltered(withCoreImageFilter:parameters:)","abstract":"
                                                                                                    Returns a new version of the image using a CoreImage filter with the specified name and parameters.
                                                                                                    ","parent_name":"UIImage"},"Extensions/UIButton.html#/s:So8UIButtonC14AlamofireImageE18af_imageDownloaderAC0cF0CSgvp":{"name":"af_imageDownloader","abstract":"
                                                                                                    The instance image downloader used to download all images. If this property is nil, the UIButton will","parent_name":"UIButton"},"Extensions/UIButton.html#/s:So8UIButtonC14AlamofireImageE09af_sharedC10DownloaderAC0cF0CvpZ":{"name":"af_sharedImageDownloader","abstract":"
                                                                                                    The shared image downloader used to download all images. By default, this is the default ImageDownloader","parent_name":"UIButton"},"Extensions/UIButton.html#/s:So8UIButtonC14AlamofireImageE06af_setC03for3url011placeholderC06filter8progress0J5Queue10completionySo14UIControlStateV_10Foundation3URLVSo7UIImageCSgAC0C6Filter_pSgySo10NSProgressCcSgSo17OS_dispatch_queueCy0B012DataResponseVyArC8AFIErrorOGcSgtF":{"name":"af_setImage(for:url:placeholderImage:filter:progress:progressQueue:completion:)","abstract":"
                                                                                                    Asynchronously downloads an image from the specified URL and sets it once the request is finished.
                                                                                                    ","parent_name":"UIButton"},"Extensions/UIButton.html#/s:So8UIButtonC14AlamofireImageE06af_setC03for10urlRequest011placeholderC06filter8progress0K5Queue10completionySo14UIControlStateV_0B021URLRequestConvertible_pSo7UIImageCSgAC0C6Filter_pSgySo10NSProgressCcSgSo17OS_dispatch_queueCyAN12DataResponseVyAqC8AFIErrorOGcSgtF":{"name":"af_setImage(for:urlRequest:placeholderImage:filter:progress:progressQueue:completion:)","abstract":"
                                                                                                    Asynchronously downloads an image from the specified URL request and sets it once the request is finished.
                                                                                                    ","parent_name":"UIButton"},"Extensions/UIButton.html#/s:So8UIButtonC14AlamofireImageE09af_cancelC7Request3forySo14UIControlStateV_tF":{"name":"af_cancelImageRequest(for:)","abstract":"
                                                                                                    Cancels the active download request for the image, if one exists.
                                                                                                    ","parent_name":"UIButton"},"Extensions/UIButton.html#/s:So8UIButtonC14AlamofireImageE016af_setBackgroundC03for3url011placeholderC06filter8progress0K5Queue10completionySo14UIControlStateV_10Foundation3URLVSo7UIImageCSgAC0C6Filter_pSgySo10NSProgressCcSgSo17OS_dispatch_queueCy0B012DataResponseVyArC8AFIErrorOGcSgtF":{"name":"af_setBackgroundImage(for:url:placeholderImage:filter:progress:progressQueue:completion:)","abstract":"
                                                                                                    Asynchronously downloads an image from the specified URL and sets it once the request is finished.
                                                                                                    ","parent_name":"UIButton"},"Extensions/UIButton.html#/s:So8UIButtonC14AlamofireImageE016af_setBackgroundC03for10urlRequest011placeholderC06filter8progress0L5Queue10completionySo14UIControlStateV_0B021URLRequestConvertible_pSo7UIImageCSgAC0C6Filter_pSgySo10NSProgressCcSgSo17OS_dispatch_queueCyAN12DataResponseVyAqC8AFIErrorOGcSgtF":{"name":"af_setBackgroundImage(for:urlRequest:placeholderImage:filter:progress:progressQueue:completion:)","abstract":"
                                                                                                    Asynchronously downloads an image from the specified URL request and sets it once the request is finished.
                                                                                                    ","parent_name":"UIButton"},"Extensions/UIButton.html#/s:So8UIButtonC14AlamofireImageE019af_cancelBackgroundC7Request3forySo14UIControlStateV_tF":{"name":"af_cancelBackgroundImageRequest(for:)","abstract":"
                                                                                                    Cancels the active download request for the background image, if one exists.
                                                                                                    ","parent_name":"UIButton"},"Extensions/DataRequest.html#/responseImage(queue:completionHandler:)":{"name":"responseImage(queue:completionHandler:)","abstract":"
                                                                                                    Adds a response handler to be called once the request has finished.
                                                                                                    ","parent_name":"DataRequest"},"Extensions/DataRequest.html#/s:9Alamofire11DataRequestC0A5ImageE10imageScale12CoreGraphics7CGFloatVvpZ":{"name":"imageScale","abstract":"
                                                                                                    Undocumented
                                                                                                    ","parent_name":"DataRequest"},"Extensions/DataRequest.html#/s:9Alamofire11DataRequestC0A5ImageE08responseD010imageScale015inflateResponseD05queue17completionHandlerACXD12CoreGraphics7CGFloatV_SbSo012OS_dispatch_J0CyAA0bI0VySo7UIImageCAA7AFErrorOGctF":{"name":"responseImage(imageScale:inflateResponseImage:queue:completionHandler:)","abstract":"
                                                                                                    Adds a response handler to be called once the request has finished.
                                                                                                    ","parent_name":"DataRequest"},"Extensions/DataRequest.html":{"name":"DataRequest"},"Extensions/UIButton.html":{"name":"UIButton"},"Extensions/UIImage.html":{"name":"UIImage"},"Extensions/UIImageView.html":{"name":"UIImageView"},"Enums/AFIError.html#/s:14AlamofireImage8AFIErrorO16requestCancelledyA2CmF":{"name":"requestCancelled","abstract":"
                                                                                                    Undocumented
                                                                                                    ","parent_name":"AFIError"},"Enums/AFIError.html#/s:14AlamofireImage8AFIErrorO24imageSerializationFailedyA2CmF":{"name":"imageSerializationFailed","abstract":"
                                                                                                    Undocumented
                                                                                                    ","parent_name":"AFIError"},"Enums/AFIError.html#/s:14AlamofireImage8AFIErrorO14alamofireErroryAC0A07AFErrorOcACmF":{"name":"alamofireError(_:)","abstract":"
                                                                                                    Undocumented
                                                                                                    ","parent_name":"AFIError"},"Enums/AFIError.html#/s:14AlamofireImage8AFIErrorO23isRequestCancelledErrorSbvp":{"name":"isRequestCancelledError","abstract":"
                                                                                                    Returns true if the AFIError is a request cancellation error, false otherwise.
                                                                                                    ","parent_name":"AFIError"},"Enums/AFIError.html#/s:14AlamofireImage8AFIErrorO02isB24SerializationFailedErrorSbvp":{"name":"isImageSerializationFailedError","abstract":"
                                                                                                    Returns true if the AFIError is an image serialization error, false otherwise.
                                                                                                    ","parent_name":"AFIError"},"Enums/AFIError.html#/s:14AlamofireImage8AFIErrorO02isA5ErrorSbvp":{"name":"isAlamofireError","abstract":"
                                                                                                    Undocumented
                                                                                                    ","parent_name":"AFIError"},"Enums/AFIError.html#/s:10Foundation14LocalizedErrorP16errorDescriptionSSSgvp":{"name":"errorDescription","parent_name":"AFIError"},"Enums/AFIError.html":{"name":"AFIError","abstract":"
                                                                                                    AFIError is the error type returned by AlamofireImage.
                                                                                                    "},"Classes/ImageResponseSerializer.html#/s:14AlamofireImage0B18ResponseSerializerC17deviceScreenScale12CoreGraphics7CGFloatVvpZ":{"name":"deviceScreenScale","abstract":"
                                                                                                    Undocumented
                                                                                                    ","parent_name":"ImageResponseSerializer"},"Classes/ImageResponseSerializer.html#/s:14AlamofireImage0B18ResponseSerializerC10imageScale12CoreGraphics7CGFloatVvp":{"name":"imageScale","abstract":"
                                                                                                    Undocumented
                                                                                                    ","parent_name":"ImageResponseSerializer"},"Classes/ImageResponseSerializer.html#/s:14AlamofireImage0B18ResponseSerializerC07inflatecB0Sbvp":{"name":"inflateResponseImage","abstract":"
                                                                                                    Undocumented
                                                                                                    ","parent_name":"ImageResponseSerializer"},"Classes/ImageResponseSerializer.html#/s:9Alamofire18ResponseSerializerP05emptyB5CodesShySiGvp":{"name":"emptyResponseCodes","parent_name":"ImageResponseSerializer"},"Classes/ImageResponseSerializer.html#/s:9Alamofire18ResponseSerializerP19emptyRequestMethodsShyAA10HTTPMethodVGvp":{"name":"emptyRequestMethods","parent_name":"ImageResponseSerializer"},"Classes/ImageResponseSerializer.html#/s:14AlamofireImage0B18ResponseSerializerC10imageScale07inflatecB005emptyC5Codes0H14RequestMethodsAC12CoreGraphics7CGFloatV_SbShySiGShy0A010HTTPMethodVGtcfc":{"name":"init(imageScale:inflateResponseImage:emptyResponseCodes:emptyRequestMethods:)","abstract":"
                                                                                                    Undocumented
                                                                                                    ","parent_name":"ImageResponseSerializer"},"Classes/ImageResponseSerializer.html#/s:9Alamofire30DataResponseSerializerProtocolP9serialize7request8response4data5error16SerializedObjectQz10Foundation10URLRequestVSg_So17NSHTTPURLResponseCSgAK0B0VSgs5Error_pSgtKF":{"name":"serialize(request:response:data:error:)","parent_name":"ImageResponseSerializer"},"Classes/ImageResponseSerializer.html#/s:14AlamofireImage0B18ResponseSerializerC09serializeB04fromSo7UIImageC10Foundation4DataV_tKF":{"name":"serializeImage(from:)","abstract":"
                                                                                                    Undocumented
                                                                                                    ","parent_name":"ImageResponseSerializer"},"Classes/ImageResponseSerializer.html#/s:14AlamofireImage0B18ResponseSerializerC013addAcceptableB12ContentTypesyyShySSGFZ":{"name":"addAcceptableImageContentTypes(_:)","abstract":"
                                                                                                    Adds the content types specified to the list of acceptable images content types for validation.
                                                                                                    ","parent_name":"ImageResponseSerializer"},"Classes/ImageResponseSerializer.html#/s:14AlamofireImage0B18ResponseSerializerC19validateContentType3for8responsey10Foundation10URLRequestVSg_So17NSHTTPURLResponseCSgtKF":{"name":"validateContentType(for:response:)","abstract":"
                                                                                                    Undocumented
                                                                                                    ","parent_name":"ImageResponseSerializer"},"Classes/ImageDownloader/DownloadPrioritization.html#/s:14AlamofireImage0B10DownloaderC22DownloadPrioritizationO4fifoyA2EmF":{"name":"fifo","abstract":"
                                                                                                    Undocumented
                                                                                                    ","parent_name":"DownloadPrioritization"},"Classes/ImageDownloader/DownloadPrioritization.html#/s:14AlamofireImage0B10DownloaderC22DownloadPrioritizationO4lifoyA2EmF":{"name":"lifo","abstract":"
                                                                                                    Undocumented
                                                                                                    ","parent_name":"DownloadPrioritization"},"Classes/ImageDownloader.html#/s:14AlamofireImage0B10DownloaderC17CompletionHandlera":{"name":"CompletionHandler","abstract":"
                                                                                                    The completion handler closure used when an image download completes.
                                                                                                    ","parent_name":"ImageDownloader"},"Classes/ImageDownloader.html#/s:14AlamofireImage0B10DownloaderC15ProgressHandlera":{"name":"ProgressHandler","abstract":"
                                                                                                    The progress handler closure called periodically during an image download.
                                                                                                    ","parent_name":"ImageDownloader"},"Classes/ImageDownloader/DownloadPrioritization.html":{"name":"DownloadPrioritization","abstract":"
                                                                                                    Defines the order prioritization of incoming download requests being inserted into the queue.
                                                                                                    ","parent_name":"ImageDownloader"},"Classes/ImageDownloader.html#/s:14AlamofireImage0B10DownloaderC10imageCacheAA0b7RequestE0_pSgvp":{"name":"imageCache","abstract":"
                                                                                                    The image cache used to store all downloaded images in.
                                                                                                    ","parent_name":"ImageDownloader"},"Classes/ImageDownloader.html#/s:14AlamofireImage0B10DownloaderC10credentialSo15NSURLCredentialCSgvp":{"name":"credential","abstract":"
                                                                                                    The credential used for authenticating each download request.
                                                                                                    ","parent_name":"ImageDownloader"},"Classes/ImageDownloader.html#/s:14AlamofireImage0B10DownloaderC23imageResponseSerializerAA0beF0Cvp":{"name":"imageResponseSerializer","abstract":"
                                                                                                    Response serializer used to convert the image data to UIImage.
                                                                                                    ","parent_name":"ImageDownloader"},"Classes/ImageDownloader.html#/s:14AlamofireImage0B10DownloaderC7session0A07SessionCvp":{"name":"session","abstract":"
                                                                                                    The underlying Alamofire Session instance used to handle all download requests.
                                                                                                    ","parent_name":"ImageDownloader"},"Classes/ImageDownloader.html#/s:14AlamofireImage0B10DownloaderC7defaultACvpZ":{"name":"default","abstract":"
                                                                                                    The default instance of ImageDownloader initialized with default values.
                                                                                                    ","parent_name":"ImageDownloader"},"Classes/ImageDownloader.html#/s:14AlamofireImage0B10DownloaderC30defaultURLSessionConfigurationSo012NSURLSessionF0CyFZ":{"name":"defaultURLSessionConfiguration()","abstract":"
                                                                                                    Creates a default URLSessionConfiguration with common usage parameter values.
                                                                                                    ","parent_name":"ImageDownloader"},"Classes/ImageDownloader.html#/s:14AlamofireImage0B10DownloaderC15defaultURLCacheSo10NSURLCacheCyFZ":{"name":"defaultURLCache()","abstract":"
                                                                                                    Creates a default URLCache with common usage parameter values.
                                                                                                    ","parent_name":"ImageDownloader"},"Classes/ImageDownloader.html#/s:14AlamofireImage0B10DownloaderC13configuration22downloadPrioritization22maximumActiveDownloads10imageCacheACSo25NSURLSessionConfigurationC_AC08DownloadF0OSiAA0b7RequestK0_pSgtcfc":{"name":"init(configuration:downloadPrioritization:maximumActiveDownloads:imageCache:)","abstract":"
                                                                                                    Initializes the ImageDownloader instance with the given configuration, download prioritization, maximum active","parent_name":"ImageDownloader"},"Classes/ImageDownloader.html#/s:14AlamofireImage0B10DownloaderC7session22downloadPrioritization22maximumActiveDownloads10imageCacheAC0A07SessionC_AC08DownloadF0OSiAA0b7RequestK0_pSgtcfc":{"name":"init(session:downloadPrioritization:maximumActiveDownloads:imageCache:)","abstract":"
                                                                                                    Initializes the ImageDownloader instance with the given session manager, download prioritization, maximum","parent_name":"ImageDownloader"},"Classes/ImageDownloader.html#/s:14AlamofireImage0B10DownloaderC17addAuthentication4user8password11persistenceySS_SSSo26NSURLCredentialPersistenceVtF":{"name":"addAuthentication(user:password:persistence:)","abstract":"
                                                                                                    Associates an HTTP Basic Auth credential with all future download requests.
                                                                                                    ","parent_name":"ImageDownloader"},"Classes/ImageDownloader.html#/s:14AlamofireImage0B10DownloaderC17addAuthentication15usingCredentialySo15NSURLCredentialC_tF":{"name":"addAuthentication(usingCredential:)","abstract":"
                                                                                                    Associates the specified credential with all future download requests.
                                                                                                    ","parent_name":"ImageDownloader"},"Classes/ImageDownloader.html#/s:14AlamofireImage0B10DownloaderC8download_9receiptID6filter8progress0H5Queue10completionAA14RequestReceiptCSg0A021URLRequestConvertible_p_SSAA0B6Filter_pSgySo10NSProgressCcSgSo17OS_dispatch_queueCyAM12DataResponseVySo7UIImageCAA8AFIErrorOGcSgtF":{"name":"download(_:receiptID:filter:progress:progressQueue:completion:)","abstract":"
                                                                                                    Creates a download request using the internal Alamofire SessionManager instance for the specified URL request.
                                                                                                    ","parent_name":"ImageDownloader"},"Classes/ImageDownloader.html#/s:14AlamofireImage0B10DownloaderC8download_6filter8progress0F5Queue10completionSayAA14RequestReceiptCGSay0A021URLRequestConvertible_pG_AA0B6Filter_pSgySo10NSProgressCcSgSo17OS_dispatch_queueCyAL12DataResponseVySo7UIImageCAA8AFIErrorOGcSgtF":{"name":"download(_:filter:progress:progressQueue:completion:)","abstract":"
                                                                                                    Creates a download request using the internal Alamofire SessionManager instance for each specified URL request.
                                                                                                    ","parent_name":"ImageDownloader"},"Classes/ImageDownloader.html#/s:14AlamofireImage0B10DownloaderC13cancelRequest4withyAA0E7ReceiptC_tF":{"name":"cancelRequest(with:)","abstract":"
                                                                                                    Cancels the request in the receipt by removing the response handler and cancelling the request if necessary.
                                                                                                    ","parent_name":"ImageDownloader"},"Classes/RequestReceipt.html#/s:14AlamofireImage14RequestReceiptC7request0A004DataC0Cvp":{"name":"request","abstract":"
                                                                                                    The download request created by the ImageDownloader.
                                                                                                    ","parent_name":"RequestReceipt"},"Classes/RequestReceipt.html#/s:14AlamofireImage14RequestReceiptC9receiptIDSSvp":{"name":"receiptID","abstract":"
                                                                                                    The unique identifier for the image filters and completion handlers when duplicate requests are made.
                                                                                                    ","parent_name":"RequestReceipt"},"Classes/AutoPurgingImageCache.html#/s:14AlamofireImage011AutoPurgingB5CacheC11memoryUsages6UInt64Vvp":{"name":"memoryUsage","abstract":"
                                                                                                    The current total memory usage in bytes of all images stored within the cache.
                                                                                                    ","parent_name":"AutoPurgingImageCache"},"Classes/AutoPurgingImageCache.html#/s:14AlamofireImage011AutoPurgingB5CacheC14memoryCapacitys6UInt64Vvp":{"name":"memoryCapacity","abstract":"
                                                                                                    The total memory capacity of the cache in bytes.
                                                                                                    ","parent_name":"AutoPurgingImageCache"},"Classes/AutoPurgingImageCache.html#/s:14AlamofireImage011AutoPurgingB5CacheC30preferredMemoryUsageAfterPurges6UInt64Vvp":{"name":"preferredMemoryUsageAfterPurge","abstract":"
                                                                                                    The preferred memory usage after purge in bytes. During a purge, images will be purged until the memory","parent_name":"AutoPurgingImageCache"},"Classes/AutoPurgingImageCache.html#/s:14AlamofireImage011AutoPurgingB5CacheC14memoryCapacity30preferredMemoryUsageAfterPurgeACs6UInt64V_AGtcfc":{"name":"init(memoryCapacity:preferredMemoryUsageAfterPurge:)","abstract":"
                                                                                                    Initializes the AutoPurgingImageCache instance with the given memory capacity and preferred memory usage","parent_name":"AutoPurgingImageCache"},"Classes/AutoPurgingImageCache.html#/s:14AlamofireImage011AutoPurgingB5CacheC3add_3for14withIdentifierySo7UIImageC_10Foundation10URLRequestVSSSgtF":{"name":"add(_:for:withIdentifier:)","abstract":"
                                                                                                    Adds the image to the cache using an identifier created from the request and optional identifier.
                                                                                                    ","parent_name":"AutoPurgingImageCache"},"Classes/AutoPurgingImageCache.html#/s:14AlamofireImage011AutoPurgingB5CacheC3add_14withIdentifierySo7UIImageC_SStF":{"name":"add(_:withIdentifier:)","abstract":"
                                                                                                    Adds the image to the cache with the given identifier.
                                                                                                    ","parent_name":"AutoPurgingImageCache"},"Classes/AutoPurgingImageCache.html#/s:14AlamofireImage011AutoPurgingB5CacheC06removeB03for14withIdentifierSb10Foundation10URLRequestV_SSSgtF":{"name":"removeImage(for:withIdentifier:)","abstract":"
                                                                                                    Removes the image from the cache using an identifier created from the request and optional identifier.
                                                                                                    ","parent_name":"AutoPurgingImageCache"},"Classes/AutoPurgingImageCache.html#/s:14AlamofireImage011AutoPurgingB5CacheC12removeImages8matchingSb10Foundation10URLRequestV_tF":{"name":"removeImages(matching:)","abstract":"
                                                                                                    Removes all images from the cache created from the request.
                                                                                                    ","parent_name":"AutoPurgingImageCache"},"Classes/AutoPurgingImageCache.html#/s:14AlamofireImage011AutoPurgingB5CacheC06removeB014withIdentifierSbSS_tF":{"name":"removeImage(withIdentifier:)","abstract":"
                                                                                                    Removes the image from the cache matching the given identifier.
                                                                                                    ","parent_name":"AutoPurgingImageCache"},"Classes/AutoPurgingImageCache.html#/s:14AlamofireImage011AutoPurgingB5CacheC15removeAllImagesSbyF":{"name":"removeAllImages()","abstract":"
                                                                                                    Removes all images stored in the cache.
                                                                                                    ","parent_name":"AutoPurgingImageCache"},"Classes/AutoPurgingImageCache.html#/s:14AlamofireImage011AutoPurgingB5CacheC5image3for14withIdentifierSo7UIImageCSg10Foundation10URLRequestV_SSSgtF":{"name":"image(for:withIdentifier:)","abstract":"
                                                                                                    Returns the image from the cache associated with an identifier created from the request and optional identifier.
                                                                                                    ","parent_name":"AutoPurgingImageCache"},"Classes/AutoPurgingImageCache.html#/s:14AlamofireImage011AutoPurgingB5CacheC5image14withIdentifierSo7UIImageCSgSS_tF":{"name":"image(withIdentifier:)","abstract":"
                                                                                                    Returns the image in the cache associated with the given identifier.
                                                                                                    ","parent_name":"AutoPurgingImageCache"},"Classes/AutoPurgingImageCache.html#/s:14AlamofireImage011AutoPurgingB5CacheC05imageE3Key3for14withIdentifierSS10Foundation10URLRequestV_SSSgtF":{"name":"imageCacheKey(for:withIdentifier:)","abstract":"
                                                                                                    Returns the unique image cache key for the specified request and additional identifier.
                                                                                                    ","parent_name":"AutoPurgingImageCache"},"Classes/AutoPurgingImageCache.html":{"name":"AutoPurgingImageCache","abstract":"
                                                                                                    The AutoPurgingImageCache in an in-memory image cache used to store images up to a given memory capacity. When"},"Classes/RequestReceipt.html":{"name":"RequestReceipt","abstract":"
                                                                                                    The RequestReceipt is an object vended by the ImageDownloader when starting a download request. It can be used"},"Classes/ImageDownloader.html":{"name":"ImageDownloader","abstract":"
                                                                                                    The ImageDownloader class is responsible for downloading images in parallel on a prioritized queue. Incoming"},"Classes/ImageResponseSerializer.html":{"name":"ImageResponseSerializer","abstract":"
                                                                                                    Undocumented
                                                                                                    "},"Classes.html":{"name":"Classes","abstract":"
                                                                                                    The following classes are available globally.
                                                                                                    "},"Enums.html":{"name":"Enumerations","abstract":"
                                                                                                    The following enumerations are available globally.
                                                                                                    "},"Extensions.html":{"name":"Extensions","abstract":"
                                                                                                    The following extensions are available globally.
                                                                                                    "},"Protocols.html":{"name":"Protocols","abstract":"
                                                                                                    The following protocols are available globally.
                                                                                                    "},"Structs.html":{"name":"Structures","abstract":"
                                                                                                    The following structures are available globally.
                                                                                                    "},"Typealiases.html":{"name":"Type Aliases","abstract":"
                                                                                                    The following type aliases are available globally.
                                                                                                    "}}
\ No newline at end of file
+{"Typealiases.html#/s:14AlamofireImage0B0a":{"name":"Image","abstract":"
                                                                                                    Undocumented
                                                                                                    "},"Typealiases.html#/Image":{"name":"Image"},"Typealiases.html#/s:14AlamofireImage15AFIDataResponsea":{"name":"AFIDataResponse","abstract":"
                                                                                                    Alias for DataResponse<T, AFIError>.
                                                                                                    "},"Typealiases.html#/s:14AlamofireImage9AFIResulta":{"name":"AFIResult","abstract":"
                                                                                                    Alias for Result<T, AFIError>.
                                                                                                    "},"Typealiases.html#/s:14AlamofireImage12ControlStatea":{"name":"ControlState","abstract":"
                                                                                                    Undocumented
                                                                                                    "},"Typealiases.html#/s:14AlamofireImage16AnimationOptionsa":{"name":"AnimationOptions","abstract":"
                                                                                                    Undocumented
                                                                                                    "},"Structs/AspectScaledToFillSizeCircleFilter.html#/s:14AlamofireImage34AspectScaledToFillSizeCircleFilterV4sizeACSo6CGSizeV_tcfc":{"name":"init(size:)","abstract":"
                                                                                                    Initializes the AspectScaledToFillSizeCircleFilter instance with the given size.
                                                                                                    ","parent_name":"AspectScaledToFillSizeCircleFilter"},"Structs/AspectScaledToFillSizeCircleFilter.html#/s:14AlamofireImage34AspectScaledToFillSizeCircleFilterV7filtersSayAA0bI0_pGvp":{"name":"filters","abstract":"
                                                                                                    The image filters to apply to the image in sequential order.
                                                                                                    ","parent_name":"AspectScaledToFillSizeCircleFilter"},"Structs/ScaledToSizeCircleFilter.html#/s:14AlamofireImage24ScaledToSizeCircleFilterV4sizeACSo6CGSizeV_tcfc":{"name":"init(size:)","abstract":"
                                                                                                    Initializes the ScaledToSizeCircleFilter instance with the given size.
                                                                                                    ","parent_name":"ScaledToSizeCircleFilter"},"Structs/ScaledToSizeCircleFilter.html#/s:14AlamofireImage24ScaledToSizeCircleFilterV7filtersSayAA0bG0_pGvp":{"name":"filters","abstract":"
                                                                                                    The image filters to apply to the image in sequential order.
                                                                                                    ","parent_name":"ScaledToSizeCircleFilter"},"Structs/AspectScaledToFillSizeWithRoundedCornersFilter.html#/s:14AlamofireImage46AspectScaledToFillSizeWithRoundedCornersFilterV4size6radius014divideRadiusByB5ScaleACSo6CGSizeV_12CoreGraphics7CGFloatVSbtcfc":{"name":"init(size:radius:divideRadiusByImageScale:)","abstract":"
                                                                                                    Initializes the AspectScaledToFillSizeWithRoundedCornersFilter instance with the given size and radius.
                                                                                                    ","parent_name":"AspectScaledToFillSizeWithRoundedCornersFilter"},"Structs/AspectScaledToFillSizeWithRoundedCornersFilter.html#/s:14AlamofireImage46AspectScaledToFillSizeWithRoundedCornersFilterV7filtersSayAA0bK0_pGvp":{"name":"filters","abstract":"
                                                                                                    The image filters to apply to the image in sequential order.
                                                                                                    ","parent_name":"AspectScaledToFillSizeWithRoundedCornersFilter"},"Structs/ScaledToSizeWithRoundedCornersFilter.html#/s:14AlamofireImage36ScaledToSizeWithRoundedCornersFilterV4size6radius014divideRadiusByB5ScaleACSo6CGSizeV_12CoreGraphics7CGFloatVSbtcfc":{"name":"init(size:radius:divideRadiusByImageScale:)","abstract":"
                                                                                                    Initializes the ScaledToSizeWithRoundedCornersFilter instance with the given size and radius.
                                                                                                    ","parent_name":"ScaledToSizeWithRoundedCornersFilter"},"Structs/ScaledToSizeWithRoundedCornersFilter.html#/s:14AlamofireImage36ScaledToSizeWithRoundedCornersFilterV7filtersSayAA0bI0_pGvp":{"name":"filters","abstract":"
                                                                                                    The image filters to apply to the image in sequential order.
                                                                                                    ","parent_name":"ScaledToSizeWithRoundedCornersFilter"},"Structs/BlurFilter.html#/s:14AlamofireImage10BlurFilterV10filterNameSSvp":{"name":"filterName","abstract":"
                                                                                                    The filter name.
                                                                                                    ","parent_name":"BlurFilter"},"Structs/BlurFilter.html#/s:14AlamofireImage10BlurFilterV10parametersSDySSypGvp":{"name":"parameters","abstract":"
                                                                                                    The image filter parameters passed to CoreImage.
                                                                                                    ","parent_name":"BlurFilter"},"Structs/BlurFilter.html#/s:14AlamofireImage10BlurFilterV10blurRadiusACSu_tcfc":{"name":"init(blurRadius:)","abstract":"
                                                                                                    Initializes the BlurFilter instance with the given blur radius.
                                                                                                    ","parent_name":"BlurFilter"},"Structs/CircleFilter.html#/s:14AlamofireImage12CircleFilterVACycfc":{"name":"init()","abstract":"
                                                                                                    Initializes the CircleFilter instance.
                                                                                                    ","parent_name":"CircleFilter"},"Structs/CircleFilter.html#/s:14AlamofireImage12CircleFilterV6filterySo7UIImageCAFcvp":{"name":"filter","abstract":"
                                                                                                    The filter closure used to create the modified representation of the given image.
                                                                                                    ","parent_name":"CircleFilter"},"Structs/RoundedCornersFilter.html#/s:14AlamofireImage20RoundedCornersFilterV6radius12CoreGraphics7CGFloatVvp":{"name":"radius","abstract":"
                                                                                                    The radius of the filter.
                                                                                                    ","parent_name":"RoundedCornersFilter"},"Structs/RoundedCornersFilter.html#/s:14AlamofireImage20RoundedCornersFilterV014divideRadiusByB5ScaleSbvp":{"name":"divideRadiusByImageScale","abstract":"
                                                                                                    Whether to divide the radius by the image scale.
                                                                                                    ","parent_name":"RoundedCornersFilter"},"Structs/RoundedCornersFilter.html#/s:14AlamofireImage20RoundedCornersFilterV6radius014divideRadiusByB5ScaleAC12CoreGraphics7CGFloatV_Sbtcfc":{"name":"init(radius:divideRadiusByImageScale:)","abstract":"
                                                                                                    Initializes the RoundedCornersFilter instance with the given radius.
                                                                                                    ","parent_name":"RoundedCornersFilter"},"Structs/RoundedCornersFilter.html#/s:14AlamofireImage20RoundedCornersFilterV6filterySo7UIImageCAFcvp":{"name":"filter","abstract":"
                                                                                                    The filter closure used to create the modified representation of the given image.
                                                                                                    ","parent_name":"RoundedCornersFilter"},"Structs/RoundedCornersFilter.html#/s:14AlamofireImage20RoundedCornersFilterV10identifierSSvp":{"name":"identifier","abstract":"
                                                                                                    The unique idenitifier for an ImageFilter conforming to the Roundable protocol.
                                                                                                    ","parent_name":"RoundedCornersFilter"},"Structs/AspectScaledToFillSizeFilter.html#/s:14AlamofireImage28AspectScaledToFillSizeFilterV4sizeSo6CGSizeVvp":{"name":"size","abstract":"
                                                                                                    The size of the filter.
                                                                                                    ","parent_name":"AspectScaledToFillSizeFilter"},"Structs/AspectScaledToFillSizeFilter.html#/s:14AlamofireImage28AspectScaledToFillSizeFilterV4sizeACSo6CGSizeV_tcfc":{"name":"init(size:)","abstract":"
                                                                                                    Initializes the AspectScaledToFillSizeFilter instance with the given size.
                                                                                                    ","parent_name":"AspectScaledToFillSizeFilter"},"Structs/AspectScaledToFillSizeFilter.html#/s:14AlamofireImage28AspectScaledToFillSizeFilterV6filterySo7UIImageCAFcvp":{"name":"filter","abstract":"
                                                                                                    The filter closure used to create the modified representation of the given image.
                                                                                                    ","parent_name":"AspectScaledToFillSizeFilter"},"Structs/AspectScaledToFitSizeFilter.html#/s:14AlamofireImage27AspectScaledToFitSizeFilterV4sizeSo6CGSizeVvp":{"name":"size","abstract":"
                                                                                                    The size of the filter.
                                                                                                    ","parent_name":"AspectScaledToFitSizeFilter"},"Structs/AspectScaledToFitSizeFilter.html#/s:14AlamofireImage27AspectScaledToFitSizeFilterV4sizeACSo6CGSizeV_tcfc":{"name":"init(size:)","abstract":"
                                                                                                    Initializes the AspectScaledToFitSizeFilter instance with the given size.
                                                                                                    ","parent_name":"AspectScaledToFitSizeFilter"},"Structs/AspectScaledToFitSizeFilter.html#/s:14AlamofireImage27AspectScaledToFitSizeFilterV6filterySo7UIImageCAFcvp":{"name":"filter","abstract":"
                                                                                                    The filter closure used to create the modified representation of the given image.
                                                                                                    ","parent_name":"AspectScaledToFitSizeFilter"},"Structs/ScaledToSizeFilter.html#/s:14AlamofireImage18ScaledToSizeFilterV4sizeSo6CGSizeVvp":{"name":"size","abstract":"
                                                                                                    The size of the filter.
                                                                                                    ","parent_name":"ScaledToSizeFilter"},"Structs/ScaledToSizeFilter.html#/s:14AlamofireImage18ScaledToSizeFilterV4sizeACSo6CGSizeV_tcfc":{"name":"init(size:)","abstract":"
                                                                                                    Initializes the ScaledToSizeFilter instance with the given size.
                                                                                                    ","parent_name":"ScaledToSizeFilter"},"Structs/ScaledToSizeFilter.html#/s:14AlamofireImage18ScaledToSizeFilterV6filterySo7UIImageCAFcvp":{"name":"filter","abstract":"
                                                                                                    The filter closure used to create the modified representation of the given image.
                                                                                                    ","parent_name":"ScaledToSizeFilter"},"Structs/DynamicCompositeImageFilter.html#/s:14AlamofireImage016DynamicCompositeB6FilterV7filtersSayAA0bE0_pGvp":{"name":"filters","abstract":"
                                                                                                    The image filters to apply to the image in sequential order.
                                                                                                    ","parent_name":"DynamicCompositeImageFilter"},"Structs/DynamicCompositeImageFilter.html#/s:14AlamofireImage016DynamicCompositeB6FilterVyACSayAA0bE0_pGcfc":{"name":"init(_:)","abstract":"
                                                                                                    Initializes the DynamicCompositeImageFilter instance with the given filters.
                                                                                                    ","parent_name":"DynamicCompositeImageFilter"},"Structs/DynamicCompositeImageFilter.html#/s:14AlamofireImage016DynamicCompositeB6FilterVyAcA0bE0_pd_tcfc":{"name":"init(_:)","abstract":"
                                                                                                    Initializes the DynamicCompositeImageFilter instance with the given filters.
                                                                                                    ","parent_name":"DynamicCompositeImageFilter"},"Structs/DynamicImageFilter.html#/s:14AlamofireImage07DynamicB6FilterV10identifierSSvp":{"name":"identifier","abstract":"
                                                                                                    The string used to uniquely identify the image filter operation.
                                                                                                    ","parent_name":"DynamicImageFilter"},"Structs/DynamicImageFilter.html#/s:14AlamofireImage07DynamicB6FilterV6filterySo7UIImageCAFcvp":{"name":"filter","abstract":"
                                                                                                    A closure used to create an alternative representation of the given image.
                                                                                                    ","parent_name":"DynamicImageFilter"},"Structs/DynamicImageFilter.html#/s:14AlamofireImage07DynamicB6FilterV_6filterACSS_So7UIImageCAFctcfc":{"name":"init(_:filter:)","abstract":"
                                                                                                    Initializes the DynamicImageFilter instance with the specified identifier and filter closure.
                                                                                                    ","parent_name":"DynamicImageFilter"},"Structs/DynamicImageFilter.html":{"name":"DynamicImageFilter","abstract":"
                                                                                                    The DynamicImageFilter class simplifies custom image filter creation by using a trailing closure initializer.
                                                                                                    "},"Structs/DynamicCompositeImageFilter.html":{"name":"DynamicCompositeImageFilter","abstract":"
                                                                                                    The DynamicCompositeImageFilter class is a composite image filter based on a specified array of filters.
                                                                                                    "},"Structs/ScaledToSizeFilter.html":{"name":"ScaledToSizeFilter","abstract":"
                                                                                                    Scales an image to a specified size.
                                                                                                    "},"Structs/AspectScaledToFitSizeFilter.html":{"name":"AspectScaledToFitSizeFilter","abstract":"
                                                                                                    Scales an image from the center while maintaining the aspect ratio to fit within a specified size.
                                                                                                    "},"Structs/AspectScaledToFillSizeFilter.html":{"name":"AspectScaledToFillSizeFilter","abstract":"
                                                                                                    Scales an image from the center while maintaining the aspect ratio to fill a specified size. Any pixels that fall"},"Structs/RoundedCornersFilter.html":{"name":"RoundedCornersFilter","abstract":"
                                                                                                    Rounds the corners of an image to the specified radius.
                                                                                                    "},"Structs/CircleFilter.html":{"name":"CircleFilter","abstract":"
                                                                                                    Rounds the corners of an image into a circle.
                                                                                                    "},"Structs/BlurFilter.html":{"name":"BlurFilter","abstract":"
                                                                                                    Blurs an image using a CIGaussianBlur filter with the specified blur radius.
                                                                                                    "},"Structs/ScaledToSizeWithRoundedCornersFilter.html":{"name":"ScaledToSizeWithRoundedCornersFilter","abstract":"
                                                                                                    Scales an image to a specified size, then rounds the corners to the specified radius.
                                                                                                    "},"Structs/AspectScaledToFillSizeWithRoundedCornersFilter.html":{"name":"AspectScaledToFillSizeWithRoundedCornersFilter","abstract":"
                                                                                                    Scales an image from the center while maintaining the aspect ratio to fit within a specified size, then rounds the"},"Structs/ScaledToSizeCircleFilter.html":{"name":"ScaledToSizeCircleFilter","abstract":"
                                                                                                    Scales an image to a specified size, then rounds the corners into a circle.
                                                                                                    "},"Structs/AspectScaledToFillSizeCircleFilter.html":{"name":"AspectScaledToFillSizeCircleFilter","abstract":"
                                                                                                    Scales an image from the center while maintaining the aspect ratio to fit within a specified size, then rounds the"},"Protocols/CoreImageFilter.html#/s:14AlamofireImage04CoreB6FilterP10filterNameSSvp":{"name":"filterName","abstract":"
                                                                                                    The filter name of the CoreImage filter.
                                                                                                    ","parent_name":"CoreImageFilter"},"Protocols/CoreImageFilter.html#/s:14AlamofireImage04CoreB6FilterP10parametersSDySSypGvp":{"name":"parameters","abstract":"
                                                                                                    The image filter parameters passed to CoreImage.
                                                                                                    ","parent_name":"CoreImageFilter"},"Protocols/CompositeImageFilter.html#/s:14AlamofireImage09CompositeB6FilterP7filtersSayAA0bD0_pGvp":{"name":"filters","abstract":"
                                                                                                    The image filters to apply to the image in sequential order.
                                                                                                    ","parent_name":"CompositeImageFilter"},"Protocols/CompositeImageFilter.html#/s:14AlamofireImage09CompositeB6FilterPAAE10identifierSSvp":{"name":"identifier","abstract":"
                                                                                                    The unique idenitifier for any CompositeImageFilter type.
                                                                                                    ","parent_name":"CompositeImageFilter"},"Protocols/CompositeImageFilter.html#/s:14AlamofireImage09CompositeB6FilterPAAE6filterySo7UIImageCAFcvp":{"name":"filter","abstract":"
                                                                                                    The filter closure for any CompositeImageFilter type.
                                                                                                    ","parent_name":"CompositeImageFilter"},"Protocols/Roundable.html#/s:14AlamofireImage9RoundableP6radius12CoreGraphics7CGFloatVvp":{"name":"radius","abstract":"
                                                                                                    The radius of the type.
                                                                                                    ","parent_name":"Roundable"},"Protocols/Sizable.html#/s:14AlamofireImage7SizableP4sizeSo6CGSizeVvp":{"name":"size","abstract":"
                                                                                                    The size of the type.
                                                                                                    ","parent_name":"Sizable"},"Protocols/ImageFilter.html#/s:14AlamofireImage0B6FilterP6filterySo7UIImageCAFcvp":{"name":"filter","abstract":"
                                                                                                    A closure used to create an alternative representation of the given image.
                                                                                                    ","parent_name":"ImageFilter"},"Protocols/ImageFilter.html#/s:14AlamofireImage0B6FilterP10identifierSSvp":{"name":"identifier","abstract":"
                                                                                                    The string used to uniquely identify the filter operation.
                                                                                                    ","parent_name":"ImageFilter"},"Protocols/ImageFilter.html#/s:14AlamofireImage0B6FilterPA2A7SizableRzrlE10identifierSSvp":{"name":"identifier","parent_name":"ImageFilter"},"Protocols/ImageFilter.html#/s:14AlamofireImage0B6FilterPA2A9RoundableRzrlE10identifierSSvp":{"name":"identifier","parent_name":"ImageFilter"},"Protocols/ImageFilter.html#/s:14AlamofireImage0B6FilterPA2A04CorebC0RzrlE6filterySo7UIImageCAGcvp":{"name":"filter","parent_name":"ImageFilter"},"Protocols/ImageFilter.html#/s:14AlamofireImage0B6FilterPA2A04CorebC0RzrlE10identifierSSvp":{"name":"identifier","parent_name":"ImageFilter"},"Protocols/ImageRequestCache.html#/s:14AlamofireImage0B12RequestCacheP3add_3for14withIdentifierySo7UIImageC_10Foundation10URLRequestVSSSgtF":{"name":"add(_:for:withIdentifier:)","abstract":"
                                                                                                    Adds the image to the cache using an identifier created from the request and identifier.
                                                                                                    ","parent_name":"ImageRequestCache"},"Protocols/ImageRequestCache.html#/s:14AlamofireImage0B12RequestCacheP06removeB03for14withIdentifierSb10Foundation10URLRequestV_SSSgtF":{"name":"removeImage(for:withIdentifier:)","abstract":"
                                                                                                    Removes the image from the cache using an identifier created from the request and identifier.
                                                                                                    ","parent_name":"ImageRequestCache"},"Protocols/ImageRequestCache.html#/s:14AlamofireImage0B12RequestCacheP5image3for14withIdentifierSo7UIImageCSg10Foundation10URLRequestV_SSSgtF":{"name":"image(for:withIdentifier:)","abstract":"
                                                                                                    Returns the image from the cache associated with an identifier created from the request and identifier.
                                                                                                    ","parent_name":"ImageRequestCache"},"Protocols/ImageCache.html#/s:14AlamofireImage0B5CacheP3add_14withIdentifierySo7UIImageC_SStF":{"name":"add(_:withIdentifier:)","abstract":"
                                                                                                    Adds the image to the cache with the given identifier.
                                                                                                    ","parent_name":"ImageCache"},"Protocols/ImageCache.html#/s:14AlamofireImage0B5CacheP06removeB014withIdentifierSbSS_tF":{"name":"removeImage(withIdentifier:)","abstract":"
                                                                                                    Removes the image from the cache matching the given identifier.
                                                                                                    ","parent_name":"ImageCache"},"Protocols/ImageCache.html#/s:14AlamofireImage0B5CacheP15removeAllImagesSbyF":{"name":"removeAllImages()","abstract":"
                                                                                                    Removes all images stored in the cache.
                                                                                                    ","parent_name":"ImageCache"},"Protocols/ImageCache.html#/s:14AlamofireImage0B5CacheP5image14withIdentifierSo7UIImageCSgSS_tF":{"name":"image(withIdentifier:)","abstract":"
                                                                                                    Returns the image in the cache associated with the given identifier.
                                                                                                    ","parent_name":"ImageCache"},"Protocols/ImageCache.html":{"name":"ImageCache","abstract":"
                                                                                                    The ImageCache protocol defines a set of APIs for adding, removing and fetching images from a cache.
                                                                                                    "},"Protocols/ImageRequestCache.html":{"name":"ImageRequestCache","abstract":"
                                                                                                    The ImageRequestCache protocol extends the ImageCache protocol by adding methods for adding, removing and"},"Protocols/ImageFilter.html":{"name":"ImageFilter","abstract":"
                                                                                                    The ImageFilter protocol defines properties for filtering an image as well as identification of the filter.
                                                                                                    "},"Protocols/Sizable.html":{"name":"Sizable","abstract":"
                                                                                                    The Sizable protocol defines a size property intended for use with ImageFilter types.
                                                                                                    "},"Protocols/Roundable.html":{"name":"Roundable","abstract":"
                                                                                                    The Roundable protocol defines a radius property intended for use with ImageFilter types.
                                                                                                    "},"Protocols/CompositeImageFilter.html":{"name":"CompositeImageFilter","abstract":"
                                                                                                    The CompositeImageFilter protocol defines an additional filters property to support multiple composite filters.
                                                                                                    "},"Protocols/CoreImageFilter.html":{"name":"CoreImageFilter","abstract":"
                                                                                                    The CoreImageFilter protocol defines parameters, filterName properties used by CoreImage.
                                                                                                    "},"Extensions/UIImageView/ImageTransition.html#/s:So11UIImageViewC14AlamofireImageE0D10TransitionO02noE0yA2EmF":{"name":"noTransition","abstract":"
                                                                                                    Undocumented
                                                                                                    ","parent_name":"ImageTransition"},"Extensions/UIImageView/ImageTransition.html#/s:So11UIImageViewC14AlamofireImageE0D10TransitionO13crossDissolveyAESdcAEmF":{"name":"crossDissolve(_:)","abstract":"
                                                                                                    Undocumented
                                                                                                    ","parent_name":"ImageTransition"},"Extensions/UIImageView/ImageTransition.html#/s:So11UIImageViewC14AlamofireImageE0D10TransitionO8curlDownyAESdcAEmF":{"name":"curlDown(_:)","abstract":"
                                                                                                    Undocumented
                                                                                                    ","parent_name":"ImageTransition"},"Extensions/UIImageView/ImageTransition.html#/s:So11UIImageViewC14AlamofireImageE0D10TransitionO6curlUpyAESdcAEmF":{"name":"curlUp(_:)","abstract":"
                                                                                                    Undocumented
                                                                                                    ","parent_name":"ImageTransition"},"Extensions/UIImageView/ImageTransition.html#/s:So11UIImageViewC14AlamofireImageE0D10TransitionO14flipFromBottomyAESdcAEmF":{"name":"flipFromBottom(_:)","abstract":"
                                                                                                    Undocumented
                                                                                                    ","parent_name":"ImageTransition"},"Extensions/UIImageView/ImageTransition.html#/s:So11UIImageViewC14AlamofireImageE0D10TransitionO12flipFromLeftyAESdcAEmF":{"name":"flipFromLeft(_:)","abstract":"
                                                                                                    Undocumented
                                                                                                    ","parent_name":"ImageTransition"},"Extensions/UIImageView/ImageTransition.html#/s:So11UIImageViewC14AlamofireImageE0D10TransitionO13flipFromRightyAESdcAEmF":{"name":"flipFromRight(_:)","abstract":"
                                                                                                    Undocumented
                                                                                                    ","parent_name":"ImageTransition"},"Extensions/UIImageView/ImageTransition.html#/s:So11UIImageViewC14AlamofireImageE0D10TransitionO11flipFromTopyAESdcAEmF":{"name":"flipFromTop(_:)","abstract":"
                                                                                                    Undocumented
                                                                                                    ","parent_name":"ImageTransition"},"Extensions/UIImageView/ImageTransition.html#/s:So11UIImageViewC14AlamofireImageE0D10TransitionO6customyAESd_So22UIViewAnimationOptionsVyAB_So0A0CtcySbcSgtcAEmF":{"name":"custom(duration:animationOptions:animations:completion:)","abstract":"
                                                                                                    Undocumented
                                                                                                    ","parent_name":"ImageTransition"},"Extensions/UIImageView/ImageTransition.html#/s:So11UIImageViewC14AlamofireImageE0D10TransitionO8durationSdvp":{"name":"duration","abstract":"
                                                                                                    The duration of the image transition in seconds.
                                                                                                    ","parent_name":"ImageTransition"},"Extensions/UIImageView/ImageTransition.html#/s:So11UIImageViewC14AlamofireImageE0D10TransitionO16animationOptionsSo015UIViewAnimationG0Vvp":{"name":"animationOptions","abstract":"
                                                                                                    The animation options of the image transition.
                                                                                                    ","parent_name":"ImageTransition"},"Extensions/UIImageView/ImageTransition.html#/s:So11UIImageViewC14AlamofireImageE0D10TransitionO10animationsyyAB_So0A0Ctcvp":{"name":"animations","abstract":"
                                                                                                    The animation options of the image transition.
                                                                                                    ","parent_name":"ImageTransition"},"Extensions/UIImageView/ImageTransition.html#/s:So11UIImageViewC14AlamofireImageE0D10TransitionO10completionySbcSgvp":{"name":"completion","abstract":"
                                                                                                    The completion closure associated with the image transition.
                                                                                                    ","parent_name":"ImageTransition"},"Extensions/UIImageView/ImageTransition.html":{"name":"ImageTransition","abstract":"
                                                                                                    Used to wrap all UIView animation transition options alongside a duration.
                                                                                                    ","parent_name":"UIImageView"},"Extensions/UIImageView.html#/s:So11UIImageViewC14AlamofireImageE18af_imageDownloaderAC0dG0CSgvp":{"name":"af_imageDownloader","abstract":"
                                                                                                    Undocumented
                                                                                                    ","parent_name":"UIImageView"},"Extensions/UIImageView.html#/s:So11UIImageViewC14AlamofireImageE09af_sharedD10DownloaderAC0dG0CvpZ":{"name":"af_sharedImageDownloader","abstract":"
                                                                                                    Undocumented
                                                                                                    ","parent_name":"UIImageView"},"Extensions/UIImageView.html#/s:So11UIImageViewC14AlamofireImageE06af_setD07withURL8cacheKey011placeholderD010serializer6filter8progress0N5Queue15imageTransition03rundQ8IfCached10completiony10Foundation0H0V_SSSgSo0A0CSgAC0D18ResponseSerializerCSgAC0D6Filter_pSgySo10NSProgressCcSgSo17OS_dispatch_queueCAbCE0dQ0OSby0C004DataW0VyAtC8AFIErrorOGcSgtF":{"name":"af_setImage(withURL:cacheKey:placeholderImage:serializer:filter:progress:progressQueue:imageTransition:runImageTransitionIfCached:completion:)","abstract":"
                                                                                                    Undocumented
                                                                                                    ","parent_name":"UIImageView"},"Extensions/UIImageView.html#/s:So11UIImageViewC14AlamofireImageE06af_setD014withURLRequest8cacheKey011placeholderD010serializer6filter8progress0N5Queue15imageTransition03rundQ8IfCached10completiony0C00H11Convertible_p_SSSgSo0A0CSgAC0D18ResponseSerializerCSgAC0D6Filter_pSgySo10NSProgressCcSgSo17OS_dispatch_queueCAbCE0dQ0OSbyAO04DataW0VyAsC8AFIErrorOGcSgtF":{"name":"af_setImage(withURLRequest:cacheKey:placeholderImage:serializer:filter:progress:progressQueue:imageTransition:runImageTransitionIfCached:completion:)","abstract":"
                                                                                                    Undocumented
                                                                                                    ","parent_name":"UIImageView"},"Extensions/UIImageView.html#/s:So11UIImageViewC14AlamofireImageE09af_cancelD7RequestyyF":{"name":"af_cancelImageRequest()","abstract":"
                                                                                                    Undocumented
                                                                                                    ","parent_name":"UIImageView"},"Extensions/UIImageView.html#/s:So11UIImageViewC14AlamofireImageE3run_4withyAbCE0D10TransitionO_So0A0CtF":{"name":"run(_:with:)","abstract":"
                                                                                                    Undocumented
                                                                                                    ","parent_name":"UIImageView"},"Extensions/UIImage.html#/s:So7UIImageC14AlamofireImageE013af_threadSafeC04withABSg10Foundation4DataV_tFZ":{"name":"af_threadSafeImage(with:)","abstract":"
                                                                                                    Undocumented
                                                                                                    ","parent_name":"UIImage"},"Extensions/UIImage.html#/s:So7UIImageC14AlamofireImageE013af_threadSafeC04with5scaleABSg10Foundation4DataV_12CoreGraphics7CGFloatVtFZ":{"name":"af_threadSafeImage(with:scale:)","abstract":"
                                                                                                    Undocumented
                                                                                                    ","parent_name":"UIImage"},"Extensions/UIImage.html#/s:So7UIImageC14AlamofireImageE11af_inflatedSbvp":{"name":"af_inflated","abstract":"
                                                                                                    Undocumented
                                                                                                    ","parent_name":"UIImage"},"Extensions/UIImage.html#/s:So7UIImageC14AlamofireImageE10af_inflateyyF":{"name":"af_inflate()","abstract":"
                                                                                                    Undocumented
                                                                                                    ","parent_name":"UIImage"},"Extensions/UIImage.html#/s:So7UIImageC14AlamofireImageE25af_containsAlphaComponentSbvp":{"name":"af_containsAlphaComponent","abstract":"
                                                                                                    Undocumented
                                                                                                    ","parent_name":"UIImage"},"Extensions/UIImage.html#/s:So7UIImageC14AlamofireImageE11af_isOpaqueSbvp":{"name":"af_isOpaque","abstract":"
                                                                                                    Undocumented
                                                                                                    ","parent_name":"UIImage"},"Extensions/UIImage.html#/s:So7UIImageC14AlamofireImageE14af_imageScaled2to5scaleABSo6CGSizeV_12CoreGraphics7CGFloatVSgtF":{"name":"af_imageScaled(to:scale:)","abstract":"
                                                                                                    Undocumented
                                                                                                    ","parent_name":"UIImage"},"Extensions/UIImage.html#/s:So7UIImageC14AlamofireImageE20af_imageAspectScaled5toFit5scaleABSo6CGSizeV_12CoreGraphics7CGFloatVSgtF":{"name":"af_imageAspectScaled(toFit:scale:)","abstract":"
                                                                                                    Undocumented
                                                                                                    ","parent_name":"UIImage"},"Extensions/UIImage.html#/s:So7UIImageC14AlamofireImageE20af_imageAspectScaled6toFill5scaleABSo6CGSizeV_12CoreGraphics7CGFloatVSgtF":{"name":"af_imageAspectScaled(toFill:scale:)","abstract":"
                                                                                                    Undocumented
                                                                                                    ","parent_name":"UIImage"},"Extensions/UIImage.html#/s:So7UIImageC14AlamofireImageE15af_imageRounded16withCornerRadius06dividei2ByC5ScaleAB12CoreGraphics7CGFloatV_SbtF":{"name":"af_imageRounded(withCornerRadius:divideRadiusByImageScale:)","abstract":"
                                                                                                    Undocumented
                                                                                                    ","parent_name":"UIImage"},"Extensions/UIImage.html#/s:So7UIImageC14AlamofireImageE25af_imageRoundedIntoCircleAByF":{"name":"af_imageRoundedIntoCircle()","abstract":"
                                                                                                    Undocumented
                                                                                                    ","parent_name":"UIImage"},"Extensions/UIImage.html#/s:So7UIImageC14AlamofireImageE16af_imageFiltered08withCoreC6Filter10parametersABSgSS_SDySSypGSgtF":{"name":"af_imageFiltered(withCoreImageFilter:parameters:)","abstract":"
                                                                                                    Undocumented
                                                                                                    ","parent_name":"UIImage"},"Extensions/AlamofireExtension.html#/s:9Alamofire0A9ExtensionV0A5ImageSo8UIButtonCRbzlE15imageDownloaderAD0cF0CSgvp":{"name":"imageDownloader","abstract":"
                                                                                                    The instance image downloader used to download all images. If this property is nil, the UIButton will","parent_name":"AlamofireExtension"},"Extensions/AlamofireExtension.html#/s:9Alamofire0A9ExtensionV0A5ImageSo8UIButtonCRbzlE06sharedC10DownloaderAD0cF0CvpZ":{"name":"sharedImageDownloader","abstract":"
                                                                                                    The shared image downloader used to download all images. By default, this is the default ImageDownloader","parent_name":"AlamofireExtension"},"Extensions/AlamofireExtension.html#/s:9Alamofire0A9ExtensionV0A5ImageSo8UIButtonCRbzlE03setC03for3url8cacheKey011placeholderC010serializer6filter8progress0M5Queue10completionySo14UIControlStateV_10Foundation3URLVSSSgSo7UIImageCSgAD0C18ResponseSerializerCSgAD0C6Filter_pSgySo10NSProgressCcSgSo17OS_dispatch_queueCyAA04DataU0VyAxD8AFIErrorOGcSgtF":{"name":"setImage(for:url:cacheKey:placeholderImage:serializer:filter:progress:progressQueue:completion:)","abstract":"
                                                                                                    Asynchronously downloads an image from the specified URL and sets it once the request is finished.
                                                                                                    ","parent_name":"AlamofireExtension"},"Extensions/AlamofireExtension.html#/s:9Alamofire0A9ExtensionV0A5ImageSo8UIButtonCRbzlE03setC03for10urlRequest8cacheKey011placeholderC010serializer6filter8progress0N5Queue10completionySo14UIControlStateV_AA21URLRequestConvertible_pSSSgSo7UIImageCSgAD0C18ResponseSerializerCSgAD0C6Filter_pSgySo10NSProgressCcSgSo17OS_dispatch_queueCyAA04DataV0VyAvD8AFIErrorOGcSgtF":{"name":"setImage(for:urlRequest:cacheKey:placeholderImage:serializer:filter:progress:progressQueue:completion:)","abstract":"
                                                                                                    Asynchronously downloads an image from the specified URL and sets it once the request is finished.
                                                                                                    ","parent_name":"AlamofireExtension"},"Extensions/AlamofireExtension.html#/s:9Alamofire0A9ExtensionV0A5ImageSo8UIButtonCRbzlE06cancelC7Request3forySo14UIControlStateV_tF":{"name":"cancelImageRequest(for:)","abstract":"
                                                                                                    Cancels the active download request for the image, if one exists.
                                                                                                    ","parent_name":"AlamofireExtension"},"Extensions/AlamofireExtension.html#/s:9Alamofire0A9ExtensionV0A5ImageSo8UIButtonCRbzlE013setBackgroundC03for3url8cacheKey011placeholderC010serializer6filter8progress0N5Queue10completionySo14UIControlStateV_10Foundation3URLVSSSgSo7UIImageCSgAD0C18ResponseSerializerCSgAD0C6Filter_pSgySo10NSProgressCcSgSo17OS_dispatch_queueCyAA04DataV0VyAxD8AFIErrorOGcSgtF":{"name":"setBackgroundImage(for:url:cacheKey:placeholderImage:serializer:filter:progress:progressQueue:completion:)","abstract":"
                                                                                                    Asynchronously downloads an image from the specified URL and sets it once the request is finished.
                                                                                                    ","parent_name":"AlamofireExtension"},"Extensions/AlamofireExtension.html#/s:9Alamofire0A9ExtensionV0A5ImageSo8UIButtonCRbzlE013setBackgroundC03for10urlRequest8cacheKey011placeholderC010serializer6filter8progress0O5Queue10completionySo14UIControlStateV_AA21URLRequestConvertible_pSSSgSo7UIImageCSgAD0C18ResponseSerializerCSgAD0C6Filter_pSgySo10NSProgressCcSgSo17OS_dispatch_queueCyAA04DataW0VyAvD8AFIErrorOGcSgtF":{"name":"setBackgroundImage(for:urlRequest:cacheKey:placeholderImage:serializer:filter:progress:progressQueue:completion:)","abstract":"
                                                                                                    Asynchronously downloads an image from the specified URL request and sets it once the request is finished.
                                                                                                    ","parent_name":"AlamofireExtension"},"Extensions/AlamofireExtension.html#/s:9Alamofire0A9ExtensionV0A5ImageSo8UIButtonCRbzlE016cancelBackgroundC7Request3forySo14UIControlStateV_tF":{"name":"cancelBackgroundImageRequest(for:)","abstract":"
                                                                                                    Cancels the active download request for the background image, if one exists.
                                                                                                    ","parent_name":"AlamofireExtension"},"Extensions/AlamofireExtension.html#/s:9Alamofire0A9ExtensionV0A5ImageSo7UIImageCRbzlE010threadSafeC04withAFSg10Foundation4DataV_tFZ":{"name":"threadSafeImage(with:)","abstract":"
                                                                                                    Initializes and returns the image object with the specified data in a thread-safe manner.
                                                                                                    ","parent_name":"AlamofireExtension"},"Extensions/AlamofireExtension.html#/s:9Alamofire0A9ExtensionV0A5ImageSo7UIImageCRbzlE010threadSafeC04with5scaleAFSg10Foundation4DataV_12CoreGraphics7CGFloatVtFZ":{"name":"threadSafeImage(with:scale:)","abstract":"
                                                                                                    Initializes and returns the image object with the specified data and scale in a thread-safe manner.
                                                                                                    ","parent_name":"AlamofireExtension"},"Extensions/AlamofireExtension.html#/s:9Alamofire0A9ExtensionV0A5ImageSo7UIImageCRbzlE10isInflatedSbvp":{"name":"isInflated","abstract":"
                                                                                                    Returns whether the image is inflated.
                                                                                                    ","parent_name":"AlamofireExtension"},"Extensions/AlamofireExtension.html#/s:9Alamofire0A9ExtensionV0A5ImageSo7UIImageCRbzlE7inflateyyF":{"name":"inflate()","abstract":"
                                                                                                    Inflates the underlying compressed image data to be backed by an uncompressed bitmap representation.
                                                                                                    ","parent_name":"AlamofireExtension"},"Extensions/AlamofireExtension.html#/s:9Alamofire0A9ExtensionV0A5ImageSo7UIImageCRbzlE22containsAlphaComponentSbvp":{"name":"containsAlphaComponent","abstract":"
                                                                                                    Returns whether the image contains an alpha component.
                                                                                                    ","parent_name":"AlamofireExtension"},"Extensions/AlamofireExtension.html#/s:9Alamofire0A9ExtensionV0A5ImageSo7UIImageCRbzlE8isOpaqueSbvp":{"name":"isOpaque","abstract":"
                                                                                                    Returns whether the image is opaque.
                                                                                                    ","parent_name":"AlamofireExtension"},"Extensions/AlamofireExtension.html#/s:9Alamofire0A9ExtensionV0A5ImageSo7UIImageCRbzlE11imageScaled2to5scaleAFSo6CGSizeV_12CoreGraphics7CGFloatVSgtF":{"name":"imageScaled(to:scale:)","abstract":"
                                                                                                    Returns a new version of the image scaled to the specified size.
                                                                                                    ","parent_name":"AlamofireExtension"},"Extensions/AlamofireExtension.html#/s:9Alamofire0A9ExtensionV0A5ImageSo7UIImageCRbzlE17imageAspectScaled5toFit5scaleAFSo6CGSizeV_12CoreGraphics7CGFloatVSgtF":{"name":"imageAspectScaled(toFit:scale:)","abstract":"
                                                                                                    Returns a new version of the image scaled from the center while maintaining the aspect ratio to fit within","parent_name":"AlamofireExtension"},"Extensions/AlamofireExtension.html#/s:9Alamofire0A9ExtensionV0A5ImageSo7UIImageCRbzlE17imageAspectScaled6toFill5scaleAFSo6CGSizeV_12CoreGraphics7CGFloatVSgtF":{"name":"imageAspectScaled(toFill:scale:)","abstract":"
                                                                                                    Returns a new version of the image scaled from the center while maintaining the aspect ratio to fill a","parent_name":"AlamofireExtension"},"Extensions/AlamofireExtension.html#/s:9Alamofire0A9ExtensionV0A5ImageSo7UIImageCRbzlE12imageRounded16withCornerRadius06dividei2ByC5ScaleAF12CoreGraphics7CGFloatV_SbtF":{"name":"imageRounded(withCornerRadius:divideRadiusByImageScale:)","abstract":"
                                                                                                    Returns a new version of the image with the corners rounded to the specified radius.
                                                                                                    ","parent_name":"AlamofireExtension"},"Extensions/AlamofireExtension.html#/s:9Alamofire0A9ExtensionV0A5ImageSo7UIImageCRbzlE22imageRoundedIntoCircleAFyF":{"name":"imageRoundedIntoCircle()","abstract":"
                                                                                                    Returns a new version of the image rounded into a circle.
                                                                                                    ","parent_name":"AlamofireExtension"},"Extensions/AlamofireExtension.html#/s:9Alamofire0A9ExtensionV0A5ImageSo7UIImageCRbzlE13imageFiltered08withCoreC6Filter10parametersAFSgSS_SDySSypGSgtF":{"name":"imageFiltered(withCoreImageFilter:parameters:)","abstract":"
                                                                                                    Returns a new version of the image using a CoreImage filter with the specified name and parameters.
                                                                                                    ","parent_name":"AlamofireExtension"},"Extensions/AlamofireExtension.html#/s:9Alamofire0A9ExtensionV0A5ImageSo11UIImageViewCRbzlE15imageDownloaderAD0cG0CSgvp":{"name":"imageDownloader","abstract":"
                                                                                                    The instance image downloader used to download all images. If this property is nil, the UIImageView will","parent_name":"AlamofireExtension"},"Extensions/AlamofireExtension.html#/s:9Alamofire0A9ExtensionV0A5ImageSo11UIImageViewCRbzlE06sharedC10DownloaderAD0cG0CvpZ":{"name":"sharedImageDownloader","abstract":"
                                                                                                    The shared image downloader used to download all images. By default, this is the default ImageDownloader","parent_name":"AlamofireExtension"},"Extensions/AlamofireExtension.html#/s:9Alamofire0A9ExtensionV0A5ImageSo11UIImageViewCRbzlE03setC07withURL8cacheKey011placeholderC010serializer6filter8progress0N5Queue15imageTransition03runcQ8IfCached10completiony10Foundation0H0V_SSSgSo0D0CSgAD0C18ResponseSerializerCSgAD0C6Filter_pSgySo10NSProgressCcSgSo17OS_dispatch_queueCAfDE0cQ0OSbyAA04DataW0VyAwD8AFIErrorOGcSgtF":{"name":"setImage(withURL:cacheKey:placeholderImage:serializer:filter:progress:progressQueue:imageTransition:runImageTransitionIfCached:completion:)","abstract":"
                                                                                                    Asynchronously downloads an image from the specified URL, applies the specified image filter to the downloaded","parent_name":"AlamofireExtension"},"Extensions/AlamofireExtension.html#/s:9Alamofire0A9ExtensionV0A5ImageSo11UIImageViewCRbzlE03setC014withURLRequest8cacheKey011placeholderC010serializer6filter8progress0N5Queue15imageTransition03runcQ8IfCached10completionyAA0H11Convertible_p_SSSgSo0D0CSgAD0C18ResponseSerializerCSgAD0C6Filter_pSgySo10NSProgressCcSgSo17OS_dispatch_queueCAfDE0cQ0OSbyAA04DataW0VyAuD8AFIErrorOGcSgtF":{"name":"setImage(withURLRequest:cacheKey:placeholderImage:serializer:filter:progress:progressQueue:imageTransition:runImageTransitionIfCached:completion:)","abstract":"
                                                                                                    Asynchronously downloads an image from the specified URL Request, applies the specified image filter to the downloaded","parent_name":"AlamofireExtension"},"Extensions/AlamofireExtension.html#/s:9Alamofire0A9ExtensionV0A5ImageSo11UIImageViewCRbzlE06cancelC7RequestyyF":{"name":"cancelImageRequest()","abstract":"
                                                                                                    Cancels the active download request, if one exists.
                                                                                                    ","parent_name":"AlamofireExtension"},"Extensions/AlamofireExtension.html#/s:9Alamofire0A9ExtensionV0A5ImageSo11UIImageViewCRbzlE3run_4withyAfDE0C10TransitionO_So0D0CtF":{"name":"run(_:with:)","abstract":"
                                                                                                    Runs the image transition on the image view with the specified image.
                                                                                                    ","parent_name":"AlamofireExtension"},"Extensions/UIButton.html#/s:So8UIButtonC14AlamofireImageE18af_imageDownloaderAC0cF0CSgvp":{"name":"af_imageDownloader","abstract":"
                                                                                                    Undocumented
                                                                                                    ","parent_name":"UIButton"},"Extensions/UIButton.html#/s:So8UIButtonC14AlamofireImageE09af_sharedC10DownloaderAC0cF0CvpZ":{"name":"af_sharedImageDownloader","abstract":"
                                                                                                    Undocumented
                                                                                                    ","parent_name":"UIButton"},"Extensions/UIButton.html#/s:So8UIButtonC14AlamofireImageE06af_setC03for3url8cacheKey011placeholderC010serializer6filter8progress0M5Queue10completionySo14UIControlStateV_10Foundation3URLVSSSgSo7UIImageCSgAC0C18ResponseSerializerCSgAC0C6Filter_pSgySo10NSProgressCcSgSo17OS_dispatch_queueCy0B004DataU0VyAuC8AFIErrorOGcSgtF":{"name":"af_setImage(for:url:cacheKey:placeholderImage:serializer:filter:progress:progressQueue:completion:)","abstract":"
                                                                                                    Undocumented
                                                                                                    ","parent_name":"UIButton"},"Extensions/UIButton.html#/s:So8UIButtonC14AlamofireImageE06af_setC03for10urlRequest8cacheKey011placeholderC010serializer6filter8progress0N5Queue10completionySo14UIControlStateV_0B021URLRequestConvertible_pSSSgSo7UIImageCSgAC0C18ResponseSerializerCSgAC0C6Filter_pSgySo10NSProgressCcSgSo17OS_dispatch_queueCyAP04DataV0VyAtC8AFIErrorOGcSgtF":{"name":"af_setImage(for:urlRequest:cacheKey:placeholderImage:serializer:filter:progress:progressQueue:completion:)","abstract":"
                                                                                                    Undocumented
                                                                                                    ","parent_name":"UIButton"},"Extensions/UIButton.html#/s:So8UIButtonC14AlamofireImageE09af_cancelC7Request3forySo14UIControlStateV_tF":{"name":"af_cancelImageRequest(for:)","abstract":"
                                                                                                    Cancels the active download request for the image, if one exists.
                                                                                                    ","parent_name":"UIButton"},"Extensions/UIButton.html#/s:So8UIButtonC14AlamofireImageE016af_setBackgroundC03for3url8cacheKey011placeholderC010serializer6filter8progress0N5Queue10completionySo14UIControlStateV_10Foundation3URLVSSSgSo7UIImageCSgAC0C18ResponseSerializerCSgAC0C6Filter_pSgySo10NSProgressCcSgSo17OS_dispatch_queueCy0B004DataV0VyAuC8AFIErrorOGcSgtF":{"name":"af_setBackgroundImage(for:url:cacheKey:placeholderImage:serializer:filter:progress:progressQueue:completion:)","abstract":"
                                                                                                    Undocumented
                                                                                                    ","parent_name":"UIButton"},"Extensions/UIButton.html#/s:So8UIButtonC14AlamofireImageE016af_setBackgroundC03for10urlRequest8cacheKey011placeholderC010serializer6filter8progress0O5Queue10completionySo14UIControlStateV_0B021URLRequestConvertible_pSSSgSo7UIImageCSgAC0C18ResponseSerializerCSgAC0C6Filter_pSgySo10NSProgressCcSgSo17OS_dispatch_queueCyAP04DataW0VyAtC8AFIErrorOGcSgtF":{"name":"af_setBackgroundImage(for:urlRequest:cacheKey:placeholderImage:serializer:filter:progress:progressQueue:completion:)","abstract":"
                                                                                                    Undocumented
                                                                                                    ","parent_name":"UIButton"},"Extensions/UIButton.html#/s:So8UIButtonC14AlamofireImageE019af_cancelBackgroundC7Request3forySo14UIControlStateV_tF":{"name":"af_cancelBackgroundImageRequest(for:)","abstract":"
                                                                                                    Cancels the active download request for the background image, if one exists.
                                                                                                    ","parent_name":"UIButton"},"Extensions/DataRequest.html#/responseImage(queue:completionHandler:)":{"name":"responseImage(queue:completionHandler:)","abstract":"
                                                                                                    Adds a response handler to be called once the request has finished.
                                                                                                    ","parent_name":"DataRequest"},"Extensions/DataRequest.html#/s:9Alamofire11DataRequestC0A5ImageE10imageScale12CoreGraphics7CGFloatVvpZ":{"name":"imageScale","abstract":"
                                                                                                    Undocumented
                                                                                                    ","parent_name":"DataRequest"},"Extensions/DataRequest.html#/s:9Alamofire11DataRequestC0A5ImageE08responseD010imageScale015inflateResponseD05queue17completionHandlerACXD12CoreGraphics7CGFloatV_SbSo012OS_dispatch_J0CyAA0bI0VySo7UIImageCAA7AFErrorOGctF":{"name":"responseImage(imageScale:inflateResponseImage:queue:completionHandler:)","abstract":"
                                                                                                    Adds a response handler to be called once the request has finished.
                                                                                                    ","parent_name":"DataRequest"},"Extensions/DataRequest.html":{"name":"DataRequest"},"Extensions/UIButton.html":{"name":"UIButton"},"Extensions/AlamofireExtension.html":{"name":"AlamofireExtension"},"Extensions/UIImage.html":{"name":"UIImage"},"Extensions/UIImageView.html":{"name":"UIImageView"},"Enums/AFIError.html#/s:14AlamofireImage8AFIErrorO16requestCancelledyA2CmF":{"name":"requestCancelled","abstract":"
                                                                                                    Undocumented
                                                                                                    ","parent_name":"AFIError"},"Enums/AFIError.html#/s:14AlamofireImage8AFIErrorO24imageSerializationFailedyA2CmF":{"name":"imageSerializationFailed","abstract":"
                                                                                                    Undocumented
                                                                                                    ","parent_name":"AFIError"},"Enums/AFIError.html#/s:14AlamofireImage8AFIErrorO14alamofireErroryAC0A07AFErrorOcACmF":{"name":"alamofireError(_:)","abstract":"
                                                                                                    Undocumented
                                                                                                    ","parent_name":"AFIError"},"Enums/AFIError.html#/s:14AlamofireImage8AFIErrorO23isRequestCancelledErrorSbvp":{"name":"isRequestCancelledError","abstract":"
                                                                                                    Returns true if the AFIError is a request cancellation error, false otherwise.
                                                                                                    ","parent_name":"AFIError"},"Enums/AFIError.html#/s:14AlamofireImage8AFIErrorO02isB24SerializationFailedErrorSbvp":{"name":"isImageSerializationFailedError","abstract":"
                                                                                                    Returns true if the AFIError is an image serialization error, false otherwise.
                                                                                                    ","parent_name":"AFIError"},"Enums/AFIError.html#/s:14AlamofireImage8AFIErrorO02isA5ErrorSbvp":{"name":"isAlamofireError","abstract":"
                                                                                                    Undocumented
                                                                                                    ","parent_name":"AFIError"},"Enums/AFIError.html#/s:10Foundation14LocalizedErrorP16errorDescriptionSSSgvp":{"name":"errorDescription","parent_name":"AFIError"},"Enums/AFIError.html":{"name":"AFIError","abstract":"
                                                                                                    AFIError is the error type returned by AlamofireImage.
                                                                                                    "},"Classes/ImageResponseSerializer.html#/s:14AlamofireImage0B18ResponseSerializerC17deviceScreenScale12CoreGraphics7CGFloatVvpZ":{"name":"deviceScreenScale","abstract":"
                                                                                                    Undocumented
                                                                                                    ","parent_name":"ImageResponseSerializer"},"Classes/ImageResponseSerializer.html#/s:14AlamofireImage0B18ResponseSerializerC10imageScale12CoreGraphics7CGFloatVvp":{"name":"imageScale","abstract":"
                                                                                                    Undocumented
                                                                                                    ","parent_name":"ImageResponseSerializer"},"Classes/ImageResponseSerializer.html#/s:14AlamofireImage0B18ResponseSerializerC07inflatecB0Sbvp":{"name":"inflateResponseImage","abstract":"
                                                                                                    Undocumented
                                                                                                    ","parent_name":"ImageResponseSerializer"},"Classes/ImageResponseSerializer.html#/s:9Alamofire18ResponseSerializerP05emptyB5CodesShySiGvp":{"name":"emptyResponseCodes","parent_name":"ImageResponseSerializer"},"Classes/ImageResponseSerializer.html#/s:9Alamofire18ResponseSerializerP19emptyRequestMethodsShyAA10HTTPMethodVGvp":{"name":"emptyRequestMethods","parent_name":"ImageResponseSerializer"},"Classes/ImageResponseSerializer.html#/s:14AlamofireImage0B18ResponseSerializerC10imageScale07inflatecB005emptyC5Codes0H14RequestMethodsAC12CoreGraphics7CGFloatV_SbShySiGShy0A010HTTPMethodVGtcfc":{"name":"init(imageScale:inflateResponseImage:emptyResponseCodes:emptyRequestMethods:)","abstract":"
                                                                                                    Undocumented
                                                                                                    ","parent_name":"ImageResponseSerializer"},"Classes/ImageResponseSerializer.html#/s:9Alamofire30DataResponseSerializerProtocolP9serialize7request8response4data5error16SerializedObjectQz10Foundation10URLRequestVSg_So17NSHTTPURLResponseCSgAK0B0VSgs5Error_pSgtKF":{"name":"serialize(request:response:data:error:)","parent_name":"ImageResponseSerializer"},"Classes/ImageResponseSerializer.html#/s:14AlamofireImage0B18ResponseSerializerC09serializeB04fromSo7UIImageC10Foundation4DataV_tKF":{"name":"serializeImage(from:)","abstract":"
                                                                                                    Undocumented
                                                                                                    ","parent_name":"ImageResponseSerializer"},"Classes/ImageResponseSerializer.html#/s:14AlamofireImage0B18ResponseSerializerC013addAcceptableB12ContentTypesyyShySSGFZ":{"name":"addAcceptableImageContentTypes(_:)","abstract":"
                                                                                                    Adds the content types specified to the list of acceptable images content types for validation.
                                                                                                    ","parent_name":"ImageResponseSerializer"},"Classes/ImageResponseSerializer.html#/s:14AlamofireImage0B18ResponseSerializerC19validateContentType3for8responsey10Foundation10URLRequestVSg_So17NSHTTPURLResponseCSgtKF":{"name":"validateContentType(for:response:)","abstract":"
                                                                                                    Undocumented
                                                                                                    ","parent_name":"ImageResponseSerializer"},"Classes/ImageDownloader/DownloadPrioritization.html#/s:14AlamofireImage0B10DownloaderC22DownloadPrioritizationO4fifoyA2EmF":{"name":"fifo","abstract":"
                                                                                                    Undocumented
                                                                                                    ","parent_name":"DownloadPrioritization"},"Classes/ImageDownloader/DownloadPrioritization.html#/s:14AlamofireImage0B10DownloaderC22DownloadPrioritizationO4lifoyA2EmF":{"name":"lifo","abstract":"
                                                                                                    Undocumented
                                                                                                    ","parent_name":"DownloadPrioritization"},"Classes/ImageDownloader.html#/s:14AlamofireImage0B10DownloaderC17CompletionHandlera":{"name":"CompletionHandler","abstract":"
                                                                                                    The completion handler closure used when an image download completes.
                                                                                                    ","parent_name":"ImageDownloader"},"Classes/ImageDownloader.html#/s:14AlamofireImage0B10DownloaderC15ProgressHandlera":{"name":"ProgressHandler","abstract":"
                                                                                                    The progress handler closure called periodically during an image download.
                                                                                                    ","parent_name":"ImageDownloader"},"Classes/ImageDownloader/DownloadPrioritization.html":{"name":"DownloadPrioritization","abstract":"
                                                                                                    Defines the order prioritization of incoming download requests being inserted into the queue.
                                                                                                    ","parent_name":"ImageDownloader"},"Classes/ImageDownloader.html#/s:14AlamofireImage0B10DownloaderC10imageCacheAA0b7RequestE0_pSgvp":{"name":"imageCache","abstract":"
                                                                                                    The image cache used to store all downloaded images in.
                                                                                                    ","parent_name":"ImageDownloader"},"Classes/ImageDownloader.html#/s:14AlamofireImage0B10DownloaderC10credentialSo15NSURLCredentialCSgvp":{"name":"credential","abstract":"
                                                                                                    The credential used for authenticating each download request.
                                                                                                    ","parent_name":"ImageDownloader"},"Classes/ImageDownloader.html#/s:14AlamofireImage0B10DownloaderC23imageResponseSerializerAA0beF0Cvp":{"name":"imageResponseSerializer","abstract":"
                                                                                                    Response serializer used to convert the image data to UIImage.
                                                                                                    ","parent_name":"ImageDownloader"},"Classes/ImageDownloader.html#/s:14AlamofireImage0B10DownloaderC7session0A07SessionCvp":{"name":"session","abstract":"
                                                                                                    The underlying Alamofire Session instance used to handle all download requests.
                                                                                                    ","parent_name":"ImageDownloader"},"Classes/ImageDownloader.html#/s:14AlamofireImage0B10DownloaderC7defaultACvpZ":{"name":"default","abstract":"
                                                                                                    The default instance of ImageDownloader initialized with default values.
                                                                                                    ","parent_name":"ImageDownloader"},"Classes/ImageDownloader.html#/s:14AlamofireImage0B10DownloaderC30defaultURLSessionConfigurationSo012NSURLSessionF0CyFZ":{"name":"defaultURLSessionConfiguration()","abstract":"
                                                                                                    Creates a default URLSessionConfiguration with common usage parameter values.
                                                                                                    ","parent_name":"ImageDownloader"},"Classes/ImageDownloader.html#/s:14AlamofireImage0B10DownloaderC15defaultURLCacheSo10NSURLCacheCyFZ":{"name":"defaultURLCache()","abstract":"
                                                                                                    Creates a default URLCache with common usage parameter values.
                                                                                                    ","parent_name":"ImageDownloader"},"Classes/ImageDownloader.html#/s:14AlamofireImage0B10DownloaderC13configuration22downloadPrioritization22maximumActiveDownloads10imageCacheACSo25NSURLSessionConfigurationC_AC08DownloadF0OSiAA0b7RequestK0_pSgtcfc":{"name":"init(configuration:downloadPrioritization:maximumActiveDownloads:imageCache:)","abstract":"
                                                                                                    Initializes the ImageDownloader instance with the given configuration, download prioritization, maximum active","parent_name":"ImageDownloader"},"Classes/ImageDownloader.html#/s:14AlamofireImage0B10DownloaderC7session22downloadPrioritization22maximumActiveDownloads10imageCacheAC0A07SessionC_AC08DownloadF0OSiAA0b7RequestK0_pSgtcfc":{"name":"init(session:downloadPrioritization:maximumActiveDownloads:imageCache:)","abstract":"
                                                                                                    Initializes the ImageDownloader instance with the given session manager, download prioritization, maximum","parent_name":"ImageDownloader"},"Classes/ImageDownloader.html#/s:14AlamofireImage0B10DownloaderC17addAuthentication4user8password11persistenceySS_SSSo26NSURLCredentialPersistenceVtF":{"name":"addAuthentication(user:password:persistence:)","abstract":"
                                                                                                    Associates an HTTP Basic Auth credential with all future download requests.
                                                                                                    ","parent_name":"ImageDownloader"},"Classes/ImageDownloader.html#/s:14AlamofireImage0B10DownloaderC17addAuthentication15usingCredentialySo15NSURLCredentialC_tF":{"name":"addAuthentication(usingCredential:)","abstract":"
                                                                                                    Associates the specified credential with all future download requests.
                                                                                                    ","parent_name":"ImageDownloader"},"Classes/ImageDownloader.html#/s:14AlamofireImage0B10DownloaderC8download_8cacheKey9receiptID10serializer6filter8progress0K5Queue10completionAA14RequestReceiptCSg0A021URLRequestConvertible_p_SSSgSSAA0B18ResponseSerializerCSgAA0B6Filter_pSgySo10NSProgressCcSgSo17OS_dispatch_queueCyAO04DataR0VySo7UIImageCAA8AFIErrorOGcSgtF":{"name":"download(_:cacheKey:receiptID:serializer:filter:progress:progressQueue:completion:)","abstract":"
                                                                                                    Creates a download request using the internal Alamofire SessionManager instance for the specified URL request.
                                                                                                    ","parent_name":"ImageDownloader"},"Classes/ImageDownloader.html#/s:14AlamofireImage0B10DownloaderC8download_6filter8progress0F5Queue10completionSayAA14RequestReceiptCGSay0A021URLRequestConvertible_pG_AA0B6Filter_pSgySo10NSProgressCcSgSo17OS_dispatch_queueCyAL12DataResponseVySo7UIImageCAA8AFIErrorOGcSgtF":{"name":"download(_:filter:progress:progressQueue:completion:)","abstract":"
                                                                                                    Creates a download request using the internal Alamofire SessionManager instance for each specified URL request.
                                                                                                    ","parent_name":"ImageDownloader"},"Classes/ImageDownloader.html#/s:14AlamofireImage0B10DownloaderC13cancelRequest4withyAA0E7ReceiptC_tF":{"name":"cancelRequest(with:)","abstract":"
                                                                                                    Cancels the request contained inside the receipt calls the completion handler with a request cancelled error.
                                                                                                    ","parent_name":"ImageDownloader"},"Classes/RequestReceipt.html#/s:14AlamofireImage14RequestReceiptC7request0A004DataC0Cvp":{"name":"request","abstract":"
                                                                                                    The download request created by the ImageDownloader.
                                                                                                    ","parent_name":"RequestReceipt"},"Classes/RequestReceipt.html#/s:14AlamofireImage14RequestReceiptC9receiptIDSSvp":{"name":"receiptID","abstract":"
                                                                                                    The unique identifier for the image filters and completion handlers when duplicate requests are made.
                                                                                                    ","parent_name":"RequestReceipt"},"Classes/AutoPurgingImageCache.html#/s:14AlamofireImage011AutoPurgingB5CacheC11memoryUsages6UInt64Vvp":{"name":"memoryUsage","abstract":"
                                                                                                    The current total memory usage in bytes of all images stored within the cache.
                                                                                                    ","parent_name":"AutoPurgingImageCache"},"Classes/AutoPurgingImageCache.html#/s:14AlamofireImage011AutoPurgingB5CacheC14memoryCapacitys6UInt64Vvp":{"name":"memoryCapacity","abstract":"
                                                                                                    The total memory capacity of the cache in bytes.
                                                                                                    ","parent_name":"AutoPurgingImageCache"},"Classes/AutoPurgingImageCache.html#/s:14AlamofireImage011AutoPurgingB5CacheC30preferredMemoryUsageAfterPurges6UInt64Vvp":{"name":"preferredMemoryUsageAfterPurge","abstract":"
                                                                                                    The preferred memory usage after purge in bytes. During a purge, images will be purged until the memory","parent_name":"AutoPurgingImageCache"},"Classes/AutoPurgingImageCache.html#/s:14AlamofireImage011AutoPurgingB5CacheC14memoryCapacity30preferredMemoryUsageAfterPurgeACs6UInt64V_AGtcfc":{"name":"init(memoryCapacity:preferredMemoryUsageAfterPurge:)","abstract":"
                                                                                                    Initializes the AutoPurgingImageCache instance with the given memory capacity and preferred memory usage","parent_name":"AutoPurgingImageCache"},"Classes/AutoPurgingImageCache.html#/s:14AlamofireImage011AutoPurgingB5CacheC3add_3for14withIdentifierySo7UIImageC_10Foundation10URLRequestVSSSgtF":{"name":"add(_:for:withIdentifier:)","abstract":"
                                                                                                    Adds the image to the cache using an identifier created from the request and optional identifier.
                                                                                                    ","parent_name":"AutoPurgingImageCache"},"Classes/AutoPurgingImageCache.html#/s:14AlamofireImage011AutoPurgingB5CacheC3add_14withIdentifierySo7UIImageC_SStF":{"name":"add(_:withIdentifier:)","abstract":"
                                                                                                    Adds the image to the cache with the given identifier.
                                                                                                    ","parent_name":"AutoPurgingImageCache"},"Classes/AutoPurgingImageCache.html#/s:14AlamofireImage011AutoPurgingB5CacheC06removeB03for14withIdentifierSb10Foundation10URLRequestV_SSSgtF":{"name":"removeImage(for:withIdentifier:)","abstract":"
                                                                                                    Removes the image from the cache using an identifier created from the request and optional identifier.
                                                                                                    ","parent_name":"AutoPurgingImageCache"},"Classes/AutoPurgingImageCache.html#/s:14AlamofireImage011AutoPurgingB5CacheC12removeImages8matchingSb10Foundation10URLRequestV_tF":{"name":"removeImages(matching:)","abstract":"
                                                                                                    Removes all images from the cache created from the request.
                                                                                                    ","parent_name":"AutoPurgingImageCache"},"Classes/AutoPurgingImageCache.html#/s:14AlamofireImage011AutoPurgingB5CacheC06removeB014withIdentifierSbSS_tF":{"name":"removeImage(withIdentifier:)","abstract":"
                                                                                                    Removes the image from the cache matching the given identifier.
                                                                                                    ","parent_name":"AutoPurgingImageCache"},"Classes/AutoPurgingImageCache.html#/s:14AlamofireImage011AutoPurgingB5CacheC15removeAllImagesSbyF":{"name":"removeAllImages()","abstract":"
                                                                                                    Removes all images stored in the cache.
                                                                                                    ","parent_name":"AutoPurgingImageCache"},"Classes/AutoPurgingImageCache.html#/s:14AlamofireImage011AutoPurgingB5CacheC5image3for14withIdentifierSo7UIImageCSg10Foundation10URLRequestV_SSSgtF":{"name":"image(for:withIdentifier:)","abstract":"
                                                                                                    Returns the image from the cache associated with an identifier created from the request and optional identifier.
                                                                                                    ","parent_name":"AutoPurgingImageCache"},"Classes/AutoPurgingImageCache.html#/s:14AlamofireImage011AutoPurgingB5CacheC5image14withIdentifierSo7UIImageCSgSS_tF":{"name":"image(withIdentifier:)","abstract":"
                                                                                                    Returns the image in the cache associated with the given identifier.
                                                                                                    ","parent_name":"AutoPurgingImageCache"},"Classes/AutoPurgingImageCache.html#/s:14AlamofireImage011AutoPurgingB5CacheC05imageE3Key3for14withIdentifierSS10Foundation10URLRequestV_SSSgtF":{"name":"imageCacheKey(for:withIdentifier:)","abstract":"
                                                                                                    Returns the unique image cache key for the specified request and additional identifier.
                                                                                                    ","parent_name":"AutoPurgingImageCache"},"Classes/AutoPurgingImageCache.html":{"name":"AutoPurgingImageCache","abstract":"
                                                                                                    The AutoPurgingImageCache in an in-memory image cache used to store images up to a given memory capacity. When"},"Classes/RequestReceipt.html":{"name":"RequestReceipt","abstract":"
                                                                                                    The RequestReceipt is an object vended by the ImageDownloader when starting a download request. It can be used"},"Classes/ImageDownloader.html":{"name":"ImageDownloader","abstract":"
                                                                                                    The ImageDownloader class is responsible for downloading images in parallel on a prioritized queue. Incoming"},"Classes/ImageResponseSerializer.html":{"name":"ImageResponseSerializer","abstract":"
                                                                                                    Undocumented
                                                                                                    "},"Classes.html":{"name":"Classes","abstract":"
                                                                                                    The following classes are available globally.
                                                                                                    "},"Enums.html":{"name":"Enumerations","abstract":"
                                                                                                    The following enumerations are available globally.
                                                                                                    "},"Extensions.html":{"name":"Extensions","abstract":"
                                                                                                    The following extensions are available globally.
                                                                                                    "},"Protocols.html":{"name":"Protocols","abstract":"
                                                                                                    The following protocols are available globally.
                                                                                                    "},"Structs.html":{"name":"Structures","abstract":"
                                                                                                    The following structures are available globally.
                                                                                                    "},"Typealiases.html":{"name":"Type Aliases","abstract":"
                                                                                                    The following type aliases are available globally.
                                                                                                    "}}
\ No newline at end of file
diff --git a/docs/undocumented.json b/docs/undocumented.json
index 1f962651..6f386979 100644
--- a/docs/undocumented.json
+++ b/docs/undocumented.json
@@ -1,187 +1,355 @@
 {
   "warnings": [
     {
-      "file": "/Users/jshier/Desktop/Code/AlamofireImage/Source/AFIError.swift",
+      "file": "/Users/cnoon/Programming/GitHub/Alamofire/AlamofireImage/Source/AFIError.swift",
       "line": 33,
       "symbol": "AFIError.requestCancelled",
       "symbol_kind": "source.lang.swift.decl.enumelement",
       "warning": "undocumented"
     },
     {
-      "file": "/Users/jshier/Desktop/Code/AlamofireImage/Source/AFIError.swift",
+      "file": "/Users/cnoon/Programming/GitHub/Alamofire/AlamofireImage/Source/AFIError.swift",
       "line": 34,
       "symbol": "AFIError.imageSerializationFailed",
       "symbol_kind": "source.lang.swift.decl.enumelement",
       "warning": "undocumented"
     },
     {
-      "file": "/Users/jshier/Desktop/Code/AlamofireImage/Source/AFIError.swift",
+      "file": "/Users/cnoon/Programming/GitHub/Alamofire/AlamofireImage/Source/AFIError.swift",
       "line": 35,
       "symbol": "AFIError.alamofireError(_:)",
       "symbol_kind": "source.lang.swift.decl.enumelement",
       "warning": "undocumented"
     },
     {
-      "file": "/Users/jshier/Desktop/Code/AlamofireImage/Source/AFIError.swift",
+      "file": "/Users/cnoon/Programming/GitHub/Alamofire/AlamofireImage/Source/AFIError.swift",
       "line": 53,
       "symbol": "AFIError.isAlamofireError",
       "symbol_kind": "source.lang.swift.decl.var.instance",
       "warning": "undocumented"
     },
     {
-      "file": "/Users/jshier/Desktop/Code/AlamofireImage/Source/Image.swift",
+      "file": "/Users/cnoon/Programming/GitHub/Alamofire/AlamofireImage/Source/Image.swift",
       "line": 29,
       "symbol": "Image",
       "symbol_kind": "source.lang.swift.decl.typealias",
       "warning": "undocumented"
     },
     {
-      "file": "/Users/jshier/Desktop/Code/AlamofireImage/Source/ImageDownloader.swift",
+      "file": "/Users/cnoon/Programming/GitHub/Alamofire/AlamofireImage/Source/ImageDownloader.swift",
       "line": 79,
       "symbol": "ImageDownloader.DownloadPrioritization.fifo",
       "symbol_kind": "source.lang.swift.decl.enumelement",
       "warning": "undocumented"
     },
     {
-      "file": "/Users/jshier/Desktop/Code/AlamofireImage/Source/ImageDownloader.swift",
+      "file": "/Users/cnoon/Programming/GitHub/Alamofire/AlamofireImage/Source/ImageDownloader.swift",
       "line": 79,
       "symbol": "ImageDownloader.DownloadPrioritization.lifo",
       "symbol_kind": "source.lang.swift.decl.enumelement",
       "warning": "undocumented"
     },
     {
-      "file": "/Users/jshier/Desktop/Code/AlamofireImage/Source/Request+AlamofireImage.swift",
+      "file": "/Users/cnoon/Programming/GitHub/Alamofire/AlamofireImage/Source/Request+AlamofireImage.swift",
       "line": 37,
       "symbol": "ImageResponseSerializer",
       "symbol_kind": "source.lang.swift.decl.class",
       "warning": "undocumented"
     },
     {
-      "file": "/Users/jshier/Desktop/Code/AlamofireImage/Source/Request+AlamofireImage.swift",
-      "line": 41,
+      "file": "/Users/cnoon/Programming/GitHub/Alamofire/AlamofireImage/Source/Request+AlamofireImage.swift",
+      "line": 40,
       "symbol": "ImageResponseSerializer.deviceScreenScale",
       "symbol_kind": "source.lang.swift.decl.var.static",
       "warning": "undocumented"
     },
     {
-      "file": "/Users/jshier/Desktop/Code/AlamofireImage/Source/Request+AlamofireImage.swift",
-      "line": 43,
+      "file": "/Users/cnoon/Programming/GitHub/Alamofire/AlamofireImage/Source/Request+AlamofireImage.swift",
+      "line": 42,
       "symbol": "ImageResponseSerializer.imageScale",
       "symbol_kind": "source.lang.swift.decl.var.instance",
       "warning": "undocumented"
     },
     {
-      "file": "/Users/jshier/Desktop/Code/AlamofireImage/Source/Request+AlamofireImage.swift",
-      "line": 44,
+      "file": "/Users/cnoon/Programming/GitHub/Alamofire/AlamofireImage/Source/Request+AlamofireImage.swift",
+      "line": 43,
       "symbol": "ImageResponseSerializer.inflateResponseImage",
       "symbol_kind": "source.lang.swift.decl.var.instance",
       "warning": "undocumented"
     },
     {
-      "file": "/Users/jshier/Desktop/Code/AlamofireImage/Source/Request+AlamofireImage.swift",
-      "line": 66,
+      "file": "/Users/cnoon/Programming/GitHub/Alamofire/AlamofireImage/Source/Request+AlamofireImage.swift",
+      "line": 64,
       "symbol": "ImageResponseSerializer.init(imageScale:inflateResponseImage:emptyResponseCodes:emptyRequestMethods:)",
       "symbol_kind": "source.lang.swift.decl.function.method.instance",
       "warning": "undocumented"
     },
     {
-      "file": "/Users/jshier/Desktop/Code/AlamofireImage/Source/Request+AlamofireImage.swift",
-      "line": 98,
+      "file": "/Users/cnoon/Programming/GitHub/Alamofire/AlamofireImage/Source/Request+AlamofireImage.swift",
+      "line": 94,
       "symbol": "ImageResponseSerializer.serializeImage(from:)",
       "symbol_kind": "source.lang.swift.decl.function.method.instance",
       "warning": "undocumented"
     },
     {
-      "file": "/Users/jshier/Desktop/Code/AlamofireImage/Source/Request+AlamofireImage.swift",
-      "line": 130,
+      "file": "/Users/cnoon/Programming/GitHub/Alamofire/AlamofireImage/Source/Request+AlamofireImage.swift",
+      "line": 126,
       "symbol": "ImageResponseSerializer.validateContentType(for:response:)",
       "symbol_kind": "source.lang.swift.decl.function.method.instance",
       "warning": "undocumented"
     },
     {
-      "file": "/Users/jshier/Desktop/Code/AlamofireImage/Source/Request+AlamofireImage.swift",
-      "line": 151,
+      "file": "/Users/cnoon/Programming/GitHub/Alamofire/AlamofireImage/Source/Request+AlamofireImage.swift",
+      "line": 147,
       "symbol": "DataRequest.imageScale",
       "symbol_kind": "source.lang.swift.decl.var.class",
       "warning": "undocumented"
     },
     {
-      "file": "/Users/jshier/Desktop/Code/AlamofireImage/Source/UIButton+AlamofireImage.swift",
+      "file": "/Users/cnoon/Programming/GitHub/Alamofire/AlamofireImage/Source/UIButton+AlamofireImage.swift",
       "line": 32,
       "symbol": "ControlState",
       "symbol_kind": "source.lang.swift.decl.typealias",
       "warning": "undocumented"
     },
     {
-      "file": "/Users/jshier/Desktop/Code/AlamofireImage/Source/UIImageView+AlamofireImage.swift",
+      "file": "/Users/cnoon/Programming/GitHub/Alamofire/AlamofireImage/Source/UIButton+AlamofireImage.swift",
+      "line": 502,
+      "symbol": "UIButton.af_imageDownloader",
+      "symbol_kind": "source.lang.swift.decl.var.instance",
+      "warning": "undocumented"
+    },
+    {
+      "file": "/Users/cnoon/Programming/GitHub/Alamofire/AlamofireImage/Source/UIButton+AlamofireImage.swift",
+      "line": 508,
+      "symbol": "UIButton.af_sharedImageDownloader",
+      "symbol_kind": "source.lang.swift.decl.var.class",
+      "warning": "undocumented"
+    },
+    {
+      "file": "/Users/cnoon/Programming/GitHub/Alamofire/AlamofireImage/Source/UIButton+AlamofireImage.swift",
+      "line": 514,
+      "symbol": "UIButton.af_setImage(for:url:cacheKey:placeholderImage:serializer:filter:progress:progressQueue:completion:)",
+      "symbol_kind": "source.lang.swift.decl.function.method.instance",
+      "warning": "undocumented"
+    },
+    {
+      "file": "/Users/cnoon/Programming/GitHub/Alamofire/AlamofireImage/Source/UIButton+AlamofireImage.swift",
+      "line": 535,
+      "symbol": "UIButton.af_setImage(for:urlRequest:cacheKey:placeholderImage:serializer:filter:progress:progressQueue:completion:)",
+      "symbol_kind": "source.lang.swift.decl.function.method.instance",
+      "warning": "undocumented"
+    },
+    {
+      "file": "/Users/cnoon/Programming/GitHub/Alamofire/AlamofireImage/Source/UIButton+AlamofireImage.swift",
+      "line": 561,
+      "symbol": "UIButton.af_setBackgroundImage(for:url:cacheKey:placeholderImage:serializer:filter:progress:progressQueue:completion:)",
+      "symbol_kind": "source.lang.swift.decl.function.method.instance",
+      "warning": "undocumented"
+    },
+    {
+      "file": "/Users/cnoon/Programming/GitHub/Alamofire/AlamofireImage/Source/UIButton+AlamofireImage.swift",
+      "line": 582,
+      "symbol": "UIButton.af_setBackgroundImage(for:urlRequest:cacheKey:placeholderImage:serializer:filter:progress:progressQueue:completion:)",
+      "symbol_kind": "source.lang.swift.decl.function.method.instance",
+      "warning": "undocumented"
+    },
+    {
+      "file": "/Users/cnoon/Programming/GitHub/Alamofire/AlamofireImage/Source/UIImage+AlamofireImage.swift",
+      "line": 78,
+      "symbol": "UIImage.af_threadSafeImage(with:)",
+      "symbol_kind": "source.lang.swift.decl.function.method.static",
+      "warning": "undocumented"
+    },
+    {
+      "file": "/Users/cnoon/Programming/GitHub/Alamofire/AlamofireImage/Source/UIImage+AlamofireImage.swift",
+      "line": 83,
+      "symbol": "UIImage.af_threadSafeImage(with:scale:)",
+      "symbol_kind": "source.lang.swift.decl.function.method.static",
+      "warning": "undocumented"
+    },
+    {
+      "file": "/Users/cnoon/Programming/GitHub/Alamofire/AlamofireImage/Source/UIImage+AlamofireImage.swift",
+      "line": 119,
+      "symbol": "UIImage.af_inflated",
+      "symbol_kind": "source.lang.swift.decl.var.instance",
+      "warning": "undocumented"
+    },
+    {
+      "file": "/Users/cnoon/Programming/GitHub/Alamofire/AlamofireImage/Source/UIImage+AlamofireImage.swift",
+      "line": 124,
+      "symbol": "UIImage.af_inflate()",
+      "symbol_kind": "source.lang.swift.decl.function.method.instance",
+      "warning": "undocumented"
+    },
+    {
+      "file": "/Users/cnoon/Programming/GitHub/Alamofire/AlamofireImage/Source/UIImage+AlamofireImage.swift",
+      "line": 150,
+      "symbol": "UIImage.af_containsAlphaComponent",
+      "symbol_kind": "source.lang.swift.decl.var.instance",
+      "warning": "undocumented"
+    },
+    {
+      "file": "/Users/cnoon/Programming/GitHub/Alamofire/AlamofireImage/Source/UIImage+AlamofireImage.swift",
+      "line": 153,
+      "symbol": "UIImage.af_isOpaque",
+      "symbol_kind": "source.lang.swift.decl.var.instance",
+      "warning": "undocumented"
+    },
+    {
+      "file": "/Users/cnoon/Programming/GitHub/Alamofire/AlamofireImage/Source/UIImage+AlamofireImage.swift",
+      "line": 254,
+      "symbol": "UIImage.af_imageScaled(to:scale:)",
+      "symbol_kind": "source.lang.swift.decl.function.method.instance",
+      "warning": "undocumented"
+    },
+    {
+      "file": "/Users/cnoon/Programming/GitHub/Alamofire/AlamofireImage/Source/UIImage+AlamofireImage.swift",
+      "line": 259,
+      "symbol": "UIImage.af_imageAspectScaled(toFit:scale:)",
+      "symbol_kind": "source.lang.swift.decl.function.method.instance",
+      "warning": "undocumented"
+    },
+    {
+      "file": "/Users/cnoon/Programming/GitHub/Alamofire/AlamofireImage/Source/UIImage+AlamofireImage.swift",
+      "line": 264,
+      "symbol": "UIImage.af_imageAspectScaled(toFill:scale:)",
+      "symbol_kind": "source.lang.swift.decl.function.method.instance",
+      "warning": "undocumented"
+    },
+    {
+      "file": "/Users/cnoon/Programming/GitHub/Alamofire/AlamofireImage/Source/UIImage+AlamofireImage.swift",
+      "line": 333,
+      "symbol": "UIImage.af_imageRounded(withCornerRadius:divideRadiusByImageScale:)",
+      "symbol_kind": "source.lang.swift.decl.function.method.instance",
+      "warning": "undocumented"
+    },
+    {
+      "file": "/Users/cnoon/Programming/GitHub/Alamofire/AlamofireImage/Source/UIImage+AlamofireImage.swift",
+      "line": 338,
+      "symbol": "UIImage.af_imageRoundedIntoCircle()",
+      "symbol_kind": "source.lang.swift.decl.function.method.instance",
+      "warning": "undocumented"
+    },
+    {
+      "file": "/Users/cnoon/Programming/GitHub/Alamofire/AlamofireImage/Source/UIImage+AlamofireImage.swift",
+      "line": 384,
+      "symbol": "UIImage.af_imageFiltered(withCoreImageFilter:parameters:)",
+      "symbol_kind": "source.lang.swift.decl.function.method.instance",
+      "warning": "undocumented"
+    },
+    {
+      "file": "/Users/cnoon/Programming/GitHub/Alamofire/AlamofireImage/Source/UIImageView+AlamofireImage.swift",
       "line": 32,
       "symbol": "AnimationOptions",
       "symbol_kind": "source.lang.swift.decl.typealias",
       "warning": "undocumented"
     },
     {
-      "file": "/Users/jshier/Desktop/Code/AlamofireImage/Source/UIImageView+AlamofireImage.swift",
-      "line": 40,
+      "file": "/Users/cnoon/Programming/GitHub/Alamofire/AlamofireImage/Source/UIImageView+AlamofireImage.swift",
+      "line": 37,
       "symbol": "UIImageView.ImageTransition.noTransition",
       "symbol_kind": "source.lang.swift.decl.enumelement",
       "warning": "undocumented"
     },
     {
-      "file": "/Users/jshier/Desktop/Code/AlamofireImage/Source/UIImageView+AlamofireImage.swift",
-      "line": 41,
+      "file": "/Users/cnoon/Programming/GitHub/Alamofire/AlamofireImage/Source/UIImageView+AlamofireImage.swift",
+      "line": 38,
       "symbol": "UIImageView.ImageTransition.crossDissolve(_:)",
       "symbol_kind": "source.lang.swift.decl.enumelement",
       "warning": "undocumented"
     },
     {
-      "file": "/Users/jshier/Desktop/Code/AlamofireImage/Source/UIImageView+AlamofireImage.swift",
-      "line": 42,
+      "file": "/Users/cnoon/Programming/GitHub/Alamofire/AlamofireImage/Source/UIImageView+AlamofireImage.swift",
+      "line": 39,
       "symbol": "UIImageView.ImageTransition.curlDown(_:)",
       "symbol_kind": "source.lang.swift.decl.enumelement",
       "warning": "undocumented"
     },
     {
-      "file": "/Users/jshier/Desktop/Code/AlamofireImage/Source/UIImageView+AlamofireImage.swift",
-      "line": 43,
+      "file": "/Users/cnoon/Programming/GitHub/Alamofire/AlamofireImage/Source/UIImageView+AlamofireImage.swift",
+      "line": 40,
       "symbol": "UIImageView.ImageTransition.curlUp(_:)",
       "symbol_kind": "source.lang.swift.decl.enumelement",
       "warning": "undocumented"
     },
     {
-      "file": "/Users/jshier/Desktop/Code/AlamofireImage/Source/UIImageView+AlamofireImage.swift",
-      "line": 44,
+      "file": "/Users/cnoon/Programming/GitHub/Alamofire/AlamofireImage/Source/UIImageView+AlamofireImage.swift",
+      "line": 41,
       "symbol": "UIImageView.ImageTransition.flipFromBottom(_:)",
       "symbol_kind": "source.lang.swift.decl.enumelement",
       "warning": "undocumented"
     },
     {
-      "file": "/Users/jshier/Desktop/Code/AlamofireImage/Source/UIImageView+AlamofireImage.swift",
-      "line": 45,
+      "file": "/Users/cnoon/Programming/GitHub/Alamofire/AlamofireImage/Source/UIImageView+AlamofireImage.swift",
+      "line": 42,
       "symbol": "UIImageView.ImageTransition.flipFromLeft(_:)",
       "symbol_kind": "source.lang.swift.decl.enumelement",
       "warning": "undocumented"
     },
     {
-      "file": "/Users/jshier/Desktop/Code/AlamofireImage/Source/UIImageView+AlamofireImage.swift",
-      "line": 46,
+      "file": "/Users/cnoon/Programming/GitHub/Alamofire/AlamofireImage/Source/UIImageView+AlamofireImage.swift",
+      "line": 43,
       "symbol": "UIImageView.ImageTransition.flipFromRight(_:)",
       "symbol_kind": "source.lang.swift.decl.enumelement",
       "warning": "undocumented"
     },
     {
-      "file": "/Users/jshier/Desktop/Code/AlamofireImage/Source/UIImageView+AlamofireImage.swift",
-      "line": 47,
+      "file": "/Users/cnoon/Programming/GitHub/Alamofire/AlamofireImage/Source/UIImageView+AlamofireImage.swift",
+      "line": 44,
       "symbol": "UIImageView.ImageTransition.flipFromTop(_:)",
       "symbol_kind": "source.lang.swift.decl.enumelement",
       "warning": "undocumented"
     },
     {
-      "file": "/Users/jshier/Desktop/Code/AlamofireImage/Source/UIImageView+AlamofireImage.swift",
-      "line": 48,
+      "file": "/Users/cnoon/Programming/GitHub/Alamofire/AlamofireImage/Source/UIImageView+AlamofireImage.swift",
+      "line": 45,
       "symbol": "UIImageView.ImageTransition.custom(duration:animationOptions:animations:completion:)",
       "symbol_kind": "source.lang.swift.decl.enumelement",
       "warning": "undocumented"
+    },
+    {
+      "file": "/Users/cnoon/Programming/GitHub/Alamofire/AlamofireImage/Source/UIImageView+AlamofireImage.swift",
+      "line": 424,
+      "symbol": "UIImageView.af_imageDownloader",
+      "symbol_kind": "source.lang.swift.decl.var.instance",
+      "warning": "undocumented"
+    },
+    {
+      "file": "/Users/cnoon/Programming/GitHub/Alamofire/AlamofireImage/Source/UIImageView+AlamofireImage.swift",
+      "line": 430,
+      "symbol": "UIImageView.af_sharedImageDownloader",
+      "symbol_kind": "source.lang.swift.decl.var.class",
+      "warning": "undocumented"
+    },
+    {
+      "file": "/Users/cnoon/Programming/GitHub/Alamofire/AlamofireImage/Source/UIImageView+AlamofireImage.swift",
+      "line": 436,
+      "symbol": "UIImageView.af_setImage(withURL:cacheKey:placeholderImage:serializer:filter:progress:progressQueue:imageTransition:runImageTransitionIfCached:completion:)",
+      "symbol_kind": "source.lang.swift.decl.function.method.instance",
+      "warning": "undocumented"
+    },
+    {
+      "file": "/Users/cnoon/Programming/GitHub/Alamofire/AlamofireImage/Source/UIImageView+AlamofireImage.swift",
+      "line": 459,
+      "symbol": "UIImageView.af_setImage(withURLRequest:cacheKey:placeholderImage:serializer:filter:progress:progressQueue:imageTransition:runImageTransitionIfCached:completion:)",
+      "symbol_kind": "source.lang.swift.decl.function.method.instance",
+      "warning": "undocumented"
+    },
+    {
+      "file": "/Users/cnoon/Programming/GitHub/Alamofire/AlamofireImage/Source/UIImageView+AlamofireImage.swift",
+      "line": 482,
+      "symbol": "UIImageView.af_cancelImageRequest()",
+      "symbol_kind": "source.lang.swift.decl.function.method.instance",
+      "warning": "undocumented"
+    },
+    {
+      "file": "/Users/cnoon/Programming/GitHub/Alamofire/AlamofireImage/Source/UIImageView+AlamofireImage.swift",
+      "line": 487,
+      "symbol": "UIImageView.run(_:with:)",
+      "symbol_kind": "source.lang.swift.decl.function.method.instance",
+      "warning": "undocumented"
     }
   ],
-  "source_directory": "/Users/jshier/Desktop/Code/AlamofireImage"
+  "source_directory": "/Users/cnoon/Programming/GitHub/Alamofire/AlamofireImage"
 }
\ No newline at end of file