Books

  • A protocol to be implemented by the host application for handling article open requests from the SDK.

    See more

    Declaration

    Swift

    public protocol ArticleOpener

  • Undocumented

    Declaration

    Swift

    public struct AudioPlaybackInfo : Sendable

  • Undocumented

    See more

    Declaration

    Swift

    public struct Book : Sendable

  • The context where a book cover is shown.

    See more

    Declaration

    Swift

    public enum BookCoverContext : Sendable

  • A protocol to be implemented by the host application for providing optional descriptions to the book covers shown in book lists etc.

    See more

    Declaration

    Swift

    public protocol BookCoverOverlayProvider

  • Description of a book’s media type.

    See more

    Declaration

    Swift

    public enum BookMediaType : Sendable

  • Undocumented

    See more

    Declaration

    Swift

    public protocol BookOpening

  • The policy to pass back to the callback from the willOpenBook(_:currentPolicy:callback:) method.

    • allow: Allow opening of this book
    • deny: Deny opening of this book
    See more

    Declaration

    Swift

    public enum BookOpeningPolicy : Equatable, Sendable

  • Undocumented

    See more

    Declaration

    Swift

    public enum BooksFeedSortingType : Sendable

  • The content type for books.

    See more

    Declaration

    Swift

    public enum BooksFilterContentType : Sendable

  • The download status for books.

    See more

    Declaration

    Swift

    public enum BooksFilterDownloadStatus : Sendable

  • Books filter item.

    Specifies filtering options for books filter, as well as an image resource to represent those options.

    See more

    Declaration

    Swift

    public struct BooksFilterItem : Equatable, Sendable

  • Books filter options.

    See more

    Declaration

    Swift

    public struct BooksFilterOptions : Equatable, Sendable

  • The progress status for books.

    See more

    Declaration

    Swift

    public enum BooksFilterProgressStatus : Sendable

  • The publication status for books.

    See more

    Declaration

    Swift

    public enum BooksFilterPublicationStatus : Sendable

  • The source type for books.

    See more

    Declaration

    Swift

    public enum BooksFilterSourceType : Sendable

  • Protocol to implement if the host app is interested in the books library analytics events provided by the SDK.

    See more

    Declaration

    Swift

    public protocol BooksLibraryAnalyticsEventListener

  • Analytics events describing navigation in the library and in an epub.

    See more

    Declaration

    Swift

    public protocol BooksLibraryEventListener : AnyObject

  • A protocol to be implemented by the host application for listening to when the navigation level in the library UI changes

    See more

    Declaration

    Swift

    public protocol BooksLibraryNavigationDelegate

  • Tab bar style for books library.

    See more

    Declaration

    Swift

    public enum BooksLibraryTabBarStyle : Sendable

  • Undocumented

    Declaration

    Swift

    @MainActor
public final class MiniplayerProvider

  • ReadingList defines the user’s reading list.

    See more

    Declaration

    Swift

    public struct ReadingList : Equatable, Sendable

  • A protocol to be implemented by the host application for communicating reading list information with the SDK.

    See also

    ReadingList
    See more

    Declaration

    Swift

    public protocol ReadingListHost

  • Undocumented

    See more

    Declaration

    Objective-C

    @interface RichieBooksBook : NSObject

-(nonnull instancetype) init NS_UNAVAILABLE;

@property (nonatomic, readonly, nonnull) MaggioGuid *guid;
@property (nonatomic, readonly) NSInteger version; //!< Version number of downloaded book instance. Book can be modified on server and that will increment version number. The version number is zero when book hasn't been downloaded. Zero is not a valid version number.

@property (nonatomic, readonly) RichieBooksBookPresentationState presentationState;
@property (nonatomic, readonly) RichieBooksBookDiskState diskState;
@property (nonatomic, readonly, nullable) RichieBooksBookLoadingState *loadingState; //!< @p nil if loading is not in progress.

@property (nonatomic, readonly, nullable) NSDate *modificationDate;
-(BOOL) touchMetadata;

-(void) addListener:(nonnull id<RichieBooksBookListener>)listener; //!< @note Listeners are held weakly.
-(void) removeListener:(nonnull id<RichieBooksBookListener>)listener;

@end

    Swift

    class RichieBooksBook : NSObject

  • Undocumented

    See more

    Declaration

    Objective-C

    NS_ENUM(NSInteger, RichieBooksBookDiskState)
{
	RichieBooksBookDiskState_Undownloaded			= 0,
	RichieBooksBookDiskState_PartiallyDownloaded	= 1,
	RichieBooksBookDiskState_Downloaded				= 2,
}

    Swift

    enum RichieBooksBookDiskState : Int, @unchecked Sendable

  • Undocumented

    See more

    Declaration

    Objective-C

    @protocol RichieBooksBookListener <NSObject>

-(void) bookDidChangeDiskState:(nonnull RichieBooksBook *)book;
-(void) bookDidChangePresentationState:(nonnull RichieBooksBook *)book;
-(void) bookDidChangeLoadingState:(nonnull RichieBooksBook *)book;

-(void) bookDidStartLoading:(nonnull RichieBooksBook *)book
			   withUserInfo:(nullable id)userInfo;
-(void) bookDidSucceedLoading:(nonnull RichieBooksBook *)book
				 withUserInfo:(nullable id)userInfo;
-(void) bookDidStopLoading:(nonnull RichieBooksBook *)book;
-(void) book:(nonnull RichieBooksBook *)book didFailLoadingWithError:(nullable NSError *)error;

@end

    Swift

    @MainActor protocol RichieBooksBookListener : NSObjectProtocol

  • Undocumented

    See more

    Declaration

    Objective-C

    @protocol RichieBooksBookLoadingListener <NSObject>

-(void) bookLoadingStateProvider:(nonnull id<RichieBooksBookLoadingStateProvider>)stateProvider
	   didStartLoadingBookWithId:(nonnull NSString *)bookId
						userInfo:(nullable id)userInfo;
-(void) bookLoadingStateProvider:(nonnull id<RichieBooksBookLoadingStateProvider>)stateProvider
	  didFinishLoadingBookWithId:(nonnull NSString *)bookId
						userInfo:(nullable id)userInfo;

@end

    Swift

    @MainActor protocol RichieBooksBookLoadingListener : NSObjectProtocol

  • Undocumented

    See more

    Declaration

    Objective-C

    @interface RichieBooksBookLoadingState : NSObject

@property (nonatomic, readonly) int64_t bytesDownloaded;
@property (nonatomic, readonly) int64_t expectedByteLength;

@end

    Swift

    class RichieBooksBookLoadingState : NSObject

  • Undocumented

    See more

    Declaration

    Objective-C

    @protocol RichieBooksBookLoadingStateProvider <NSObject>

-(void) addBookLoadingListener:(nonnull id<RichieBooksBookLoadingListener>)listener;
-(void) removeBookLoadingListener:(nonnull id<RichieBooksBookLoadingListener>)listener;

@end

    Swift

    @MainActor protocol RichieBooksBookLoadingStateProvider : NSObjectProtocol

  • Undocumented

    See more

    Declaration

    Objective-C

    NS_ENUM(NSInteger, RichieBooksBookPresentationState)
{
	RichieBooksBookPresentationState_Unpresentable				= 0,	// For example, before has been downloaded
	RichieBooksBookPresentationState_Preparable					= 1,
	RichieBooksBookPresentationState_PreparingForPresentation	= 2,
	RichieBooksBookPresentationState_Presentable				= 3,
}

    Swift

    enum RichieBooksBookPresentationState : Int, @unchecked Sendable

  • RichieBooksLibrary manages a set of books on the local file system.

    See more

    Declaration

    Objective-C

    @interface RichieBooksLibrary : NSObject

    Swift

    class RichieBooksLibrary : NSObject

  • Undocumented

    See more

    Declaration

    Objective-C

    @protocol RichieBooksLibraryListener <NSObject>

-(void) didLoadBooksFromDisk:(nonnull NSArray<RichieBooksBook *> *)books;
-(void) didCreateBook:(nonnull RichieBooksBook *)book;
-(void) didUpdateBook:(nonnull RichieBooksBook *)book;

@end

    Swift

    @MainActor protocol RichieBooksLibraryListener : NSObjectProtocol

  • Undocumented

    See more

    Declaration

    Objective-C

    NS_ENUM(NSInteger, RichieBooksOrientation)
{
	kRichieBooksOrientationPortrait		= 1,
	kRichieBooksOrientationLandscape	= 2,
}

    Swift

    enum RichieBooksOrientation : Int, @unchecked Sendable

  • Undocumented

    See more

    Declaration

    Objective-C

    @protocol RichieBooksReaderUiEventListener <NSObject>

-(void) readerForBook:(RichieBooksBook *)book
  didPresentWithTheme:(NSString *)themeIdentifier
		inOrientation:(RichieBooksOrientation)orientation;

-(void) readerForBookDidDismiss:(RichieBooksBook *)book;

-(void) readerForBook:(RichieBooksBook *)book
	didNavigateToPage:(NSInteger)pageNumber
			pageCount:(NSInteger)pageCount;

-(void) readerForBook:(RichieBooksBook *)book didFinishBookLayoutWithPageCount:(NSInteger)pageCount;

-(void) readerForBook:(RichieBooksBook *)book
didChangeLayoutOrientation:(RichieBooksOrientation)orientation
		   pageNumber:(NSInteger)pageNumber
			pageCount:(NSInteger)pageCount;

-(void) readerForBookDidOpenTOC:(RichieBooksBook *)book;

-(void) readerForBookDidCloseTOC:(RichieBooksBook *)book;

@end

    Swift

    @MainActor protocol RichieBooksReaderUiEventListener : NSObjectProtocol

  • Undocumented

    See more

    Declaration

    Objective-C

    @interface RichieBooksSingleBookProvider : NSObject

-(instancetype) initWithBooksLibrary:(RichieBooksLibrary *)library;

-(void) loadBookWithURL:(NSURL *)url
					 iv:(NSString *)iv
					key:(NSString *)key
		  forWindowSize:(CGSize)windowSize
			 completion:(void (^)(RichieBooksBook *))completionBlock;

@end

    Swift

    class RichieBooksSingleBookProvider : NSObject