Editions Class Reference


                      
                      
                      editionProductsProvider

Use editionProductsProvider to access to edition products, see EditionProductsProvider.

Declaration

Swift

public private(set) var editionProductsProvider: EditionProductsProvider? { get }


                      
                      
                      editionProvider

Use editionProvider to access to editions, see EditionProvider.

Declaration

Swift

public private(set) var editionProvider: EditionProvider? { get }


                      
                      
                      editionCoverProvider

Use editionCoverProvider to get an UIImage or a Data for an edition cover.

The EditionCoverProvider protocol conformance can provide an UIImage, and the EditionCoverDataProvider conformance provides the image files as Data.

Declaration

Swift

public private(set) var editionCoverProvider: (EditionCoverProvider & EditionCoverDataProvider)? { get }


                      
                      
                      downloadedEditionsProvider

Use downloadedEditionsProvider to get a list of downloaded editions, see DownloadedEditionsProvider.

Declaration

Swift

public private(set) var downloadedEditionsProvider: DownloadedEditionsProvider? { get }


                      
                      
                      editionPresenter

Use editionPresenter to download and present editions, see EditionPresenter.

Declaration

Swift

public private(set) var editionPresenter: EditionPresenter? { get }


                      
                      
                      downloadedEditionsManager

Use downloadedEditionsManager to delete downloaded editions, see DownloadedEditionsManager.

Declaration

Swift

public private(set) var downloadedEditionsManager: DownloadedEditionsManager? { get }


                      
                      
                      editionsDiskUsageProvider

Use editionsDiskUsageProvider to get downloaded editions disk usage, see EditionsDiskUsageProvider.

Declaration

Swift

public private(set) var editionsDiskUsageProvider: EditionsDiskUsageProvider? { get }


                      
                      
                      init(bundleId:distributedTracingIDSource:tokenProvider:analyticsListener:ads:configuration:)

Undocumented

Declaration

Swift

public init(
    bundleId: String,
    distributedTracingIDSource: DistributedTracingIDSource? = nil,
    tokenProvider: TokenProvider,
    analyticsListener: AnalyticsListener?,
    ads: RichieAdsController? = nil,
    configuration: EditionsConfiguration = EditionsConfiguration(maxZoomFactor: 1.0)
)


                      
                      
                      setConfiguration(configuration:)

Use this method to update the configuration of Editions.

It takes an EditionsConfiguration object.

Declaration

Swift

public func setConfiguration(configuration: EditionsConfiguration)


                      
                      
                      initialize(completion:)

Initialize Editions.

Call this method, and wait for a successful completion, before using any of the features, otherwise the SDK will be in a undetermined state. If completion ends with success == false you can keep calling initialize until it finishes successfully.

Once initialize completes succesfuly you can start querying cached editions or products using EditionProvider EditionProductsProvider, but you need to call updateFeed(completion:) if you want to receive new content. The main use case for querying cached editions before updating the feed is to show content to the user as soon as posibble while the feed is being updated.

See initialize() for an async version of this method.

Declaration

Swift

public func initialize(completion: @escaping (_ success: Bool) -> Void)


                      
                      
                      initialize()

Asynchronous

See initialize(completion:) for details.

Declaration

Swift

public func initialize() async throws


                      
                      
                      updateFeed(completion:)

Method that updates the editions available through the SDK.

Using EditionProvider after completion finishes with success warranties that it will contain the latest editions available from the feed.

Declaration

Swift

public func updateFeed(completion: @escaping (_ success: Bool) -> Void)