Books

ArticleOpener
A protocol to be implemented by the host application for handling article open requests from the SDK.
See more
Declaration
Swift

public protocol ArticleOpener


                      
                      
                      AudioPlaybackInfo

Undocumented

Declaration

Swift

public struct AudioPlaybackInfo : Sendable

Book
Undocumented
See more
Declaration
Swift

public struct Book : Sendable
BookCoverContext
The context where a book cover is shown.
See more
Declaration
Swift

public enum BookCoverContext : Sendable
BookCoverOverlayProvider
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
BookMediaType
Description of a book’s media type.
See more
Declaration
Swift

public enum BookMediaType : Sendable
BookOpening
Undocumented
See more
Declaration
Swift

public protocol BookOpening
BookOpeningPolicy
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
BooksFeedSortingType
Undocumented
See more
Declaration
Swift

public enum BooksFeedSortingType : Sendable
BooksFilterContentType
The content type for books.
See more
Declaration
Swift

public enum BooksFilterContentType : Sendable
BooksFilterDownloadStatus
The download status for books.
See more
Declaration
Swift

public enum BooksFilterDownloadStatus : Sendable
BooksFilterItem
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
BooksFilterOptions
Books filter options.
See more
Declaration
Swift

public struct BooksFilterOptions : Equatable, Sendable
BooksFilterProgressStatus
The progress status for books.
See more
Declaration
Swift

public enum BooksFilterProgressStatus : Sendable
BooksFilterPublicationStatus
The publication status for books.
See more
Declaration
Swift

public enum BooksFilterPublicationStatus : Sendable
BooksFilterSourceType
The source type for books.
See more
Declaration
Swift

public enum BooksFilterSourceType : Sendable
BooksLibraryAnalyticsEventListener
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
BooksLibraryEventListener
Analytics events describing navigation in the library and in an epub.
See more
Declaration
Swift

public protocol BooksLibraryEventListener : AnyObject
BooksLibraryNavigationDelegate
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
BooksLibraryTabBarStyle
Tab bar style for books library.
See more
Declaration
Swift

public enum BooksLibraryTabBarStyle : Sendable


                      
                      
                      MiniplayerProvider

Undocumented

Declaration

Swift

@MainActor
public final class MiniplayerProvider

ReadingList
ReadingList defines the user’s reading list.
See more
Declaration
Swift

public struct ReadingList : Equatable, Sendable
ReadingListHost
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

RichieBooksBook


                      
                      
                      RichieBooksBook

Undocumented

Declaration

Swift

@MainActor
public final class RichieBooksBook : NSObject

Enums

RichieBooksBookDiskState
Undocumented
See more
Declaration
Swift

public enum RichieBooksBookDiskState : Int

Book Listener Protocol


                      
                      
                      RichieBooksBookListener

Undocumented

Declaration

Swift

@MainActor
public protocol RichieBooksBookListener : AnyObject


                      
                      
                      RichieBooksBookLoadingListener

Undocumented

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

Loading State

RichieBooksBookLoadingState
Undocumented
Declaration
Swift

public final class RichieBooksBookLoadingState


                      
                      
                      RichieBooksBookLoadingStateProvider

Undocumented

Declaration

Objective-C

@protocol RichieBooksBookLoadingStateProvider <NSObject>

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

@end

Swift

@MainActor protocol RichieBooksBookLoadingStateProvider : NSObjectProtocol


                      
                      
                      RichieBooksOrientation

Undocumented

Declaration

Objective-C

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

Swift

enum RichieBooksOrientation : Int, @unchecked Sendable


                      
                      
                      RichieBooksReaderUiEventListener

Undocumented

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