muzei/muzei api3.1.0-alpha1

Muzei API 3.1.0 Alpha 1

on GitHub

Muzei API 3.1.0 Alpha 1 includes a number of functional and API changes. It is compatible with Muzei 3.0.2 and higher.

• #587 allows a MuzeiArtProvider to implement isArtworkValid(Artwork) to confirm that an Artwork that being opened is still valid, even if the image is cached.
• #588 ensures that onInvalidArtwork(Artwork) is called in cases where you return false from isArtworkValid()
• #589 treats all non-IOExceptions (rather than just any SecurityException) coming from openFile as permanent errors resulting in a callback to onInvalidArtwork.
• #590 - static methods in ProviderContract.Artwork have been deprecated, with alternatives now encapsulated in the new ProviderClient interface
  • Methods that took a Class can now be accessed by using ProviderContract.getProviderClient(Context, Class)
  • Methods that took a String authority can now be accessed by using ProviderContract.getProviderClient(Context, String)
  • MuzeiArtProvider itself now implements ProviderClient, ensuring that the same APIs are also available directly within MuzeiArtProvider
  • The helper method ProviderContract.Artwork.getContentUri(String authority) is now available via ProviderContract.getContentUri(String).
• #591 provides an addArtwork API on ProviderClient that takes multiple Artwork, allowing batch inserts
• #592 provides a setArtwork API on ProviderClient that takes multiple Artwork, automatically deleting any Artwork not in the given list

See milestone for full change details.

Include the Muzei API in your app by adding the dependency to your build.gradle:

implementation "com.google.android.apps.muzei:muzei-api:3.1.0-alpha01"