Classes

The following classes are available globally.

  • Represents a hybrid caching system which is composed by a MemoryStorage.Backend and a DiskStorage.Backend. ImageCache is a high level abstract for storing an image as well as its data to disk memory and disk, and retrieving them back.

    While a default image cache object will be used if you prefer the extension methods of Kingfisher, you can create your own cache object and configure its storages as your need. This class also provide an interface for you to set the memory and disk storage config.

    See more

    Declaration

    Swift

    open class ImageCache

Deprecated

  • Undocumented

    See more

    Declaration

    Swift

    public final class RetrieveImageTask
  • Main manager class of Kingfisher. It connects Kingfisher downloader and cache, to provide a set of convenience methods to use Kingfisher for tasks. You can use this class to retrieve an image via a specified URL from web or cache.

    See more

    Declaration

    Swift

    public class KingfisherManager
  • Represents a downloading manager for requesting the image with a URL from server.

    See more

    Declaration

    Swift

    open class ImageDownloader
    extension ImageDownloader: AuthenticationChallengeResponsable
    extension ImageDownloader: ImageDownloaderDelegate
  • ImagePrefetcher represents a downloading manager for requesting many images via URLs, then caching them. This is useful when you know a list of image resources and want to download them before showing. It also works with some Cocoa prefetching mechanism like table view or collection view prefetchDataSource, to start image downloading and caching before they display on screen.

    See more

    Declaration

    Swift

    public class ImagePrefetcher : CustomStringConvertible
  • Represents a retry context which could be used to determine the current retry status.

    See more

    Declaration

    Swift

    public class RetryContext
  • Represents a session data task in ImageDownloader. It consists of an underlying URLSessionDataTask and an array of TaskCallback. Multiple TaskCallbacks could be added for a single downloading data task.

    See more

    Declaration

    Swift

    public class SessionDataTask
  • Represents a subclass of UIImageView for displaying animated image. Different from showing animated image in a normal UIImageView (which load all frames at one time), AnimatedImageView only tries to load several frames (defined by framePreloadCount) to reduce memory usage. It provides a tradeoff between memory usage and CPU time. If you have a memory issue when using a normal image view to load GIF data, you could give this class a try.

    Kingfisher supports setting GIF animated data to either UIImageView and AnimatedImageView out of box. So it would be fairly easy to switch between them.

    See more