Editions

  • Undocumented

    See more

    Declaration

    Swift

    public struct DownloadedEdition : Sendable

  • Interface to manage downloaded editions.

    See more

    Declaration

    Swift

    @MainActor
public protocol DownloadedEditionsManager

  • Interface for querying the editions on disk, which usually means they are prepared to be presented to the user.

    See more

    Declaration

    Swift

    @MainActor
public protocol DownloadedEditionsProvider

  • Interface that provides information about the edition download progress.

    See more

    Declaration

    Swift

    public protocol DownloadProgressListener

  • Undocumented

    See more

    Declaration

    Swift

    public struct Edition : Equatable, Hashable, Sendable

  • Contains the number of editions per month and grouped by year in a time interval.

    Format for years and months is numeric (e.g. “2023”, “01”).

    See editionCounts(productTags:callback:).

    Declaration

    Swift

    public typealias EditionCounts = [String : [String : Int]]

  • Interface to get the cover for a edition as an image.

    The SDK keeps a cache, so it is safe to call these methods in offline mode. If the network fails or can’t be accessed the SDK will use any cached image available, even if it needs to upscale to satisfy boundingBoxSize parameters passed to the methods.

    See more

    Declaration

    Swift

    @MainActor
public protocol EditionCoverProvider

  • Interface to get the cover for a edition as data.

    See more

    Declaration

    Swift

    @MainActor
public protocol EditionCoverDataProvider

  • Error thrown when Editions initialization with initialize() fails.

    Declaration

    Swift

    public struct EditionsInitializationError : Error, Sendable

  • Interface for downloading and presenting editions to the user.

    See more

    Declaration

    Swift

    public protocol EditionPresenter

  • Interface for getting the products the issues belong to since the latest feed update, see Editions.updateFeed.

    See more

    Declaration

    Swift

    public protocol EditionProductsProvider

  • Protocol to get the the editions available since the latest feed update.

    See also

    updateFeed(completion:)
    See more

    Declaration

    Swift

    public protocol EditionProvider

  • Protocol to get disk usage from downloaded editions.

    See more

    Declaration

    Swift

    @MainActor
public protocol EditionsDiskUsageProvider

  • Undocumented

    See more

    Declaration

    Swift

    public struct EditionsProduct : Equatable, Sendable

  • List of errors that can happen when trying to present an edition.

    See more

    Declaration

    Swift

    public enum OpenError : Error

  • This is the struct containing the actual Edition objects. You can check hasNext to know if there are more pages in the Paginator.

    See more

    Declaration

    Swift

    public struct Page : Sendable

  • Interface to iterate over the results queried from EditionProvider.

    Call next(callback:) or next() as needed until the Paginator is exhausted (hasNext == false). It provides a Result containing a Page on success.

    Note

    Calling updateFeed() will render any Paginator object invalid. To keep receiving Editions you need to query them again using editions(productTags:startDate:endDate:pageSize:) after an update.
    See more

    Declaration

    Swift

    public protocol Paginator : Sendable