RichieSDK 202404.11.0 Docs
RichieSDK Reference
RichieSDK Reference
Richie SDK
Welcome to the Richie SDK!
Topics
Using Threads with Richie SDK
Analytics
AnalyticsEvent
AnalyticsEventId
BooksLibraryAnalyticsLogger
AnalyticsListener
Token Authentication
TokenCompletion
TokenProvider
TokenRequestReason
TokenRequestTrigger
Books
ArticleOpener
Book
BookCoverContext
BookCoverOverlayProvider
BooksFilterItem
BooksFilterOptions
BookMediaType
BookOpening
BookOpeningPolicy
– DenialReason
BooksLibraryController
BooksLibraryEventListener
BooksLibraryNavigationDelegate
ReadingList
ReadingListHost
Books Configuration
BookActionsMenuDisplayConfig
– Action
– BackgroundStyle
BooksDisplayConfig
– ButtonStyle
– NavigationControllerType
BooksDisplayConfigProvider
BooksFilterViewDisplayConfig
– Spacing
BooksFont
– FixedFaceAccessor
– Style
BooksFontAccessor
BooksImageResource
BooksImageResourceAccessor
BooksTextStyle
BookViewDisplayConfig
– RowColors
– Style
– ActionsMenuLocation
– RatingsInputViewConfig
– BookViewTuscany
ButtonConfig
CatalogViewDisplayConfig
– Spacing
– CategoryAllPosition
CategoryListIconProvider
CategoryViewDisplayConfig
– Style
CircularProgressBarConfig
DiscoverViewDisplayConfig
– Style
– AccountViewAccessStyle
– BookCellShadowSource
– DiscoverTuscany
– BookListPickTuscany
– PodcastPick
– PodcastPicks
– PodcastStyle
– Spacing
EditablePlaylistViewDisplayConfig
EmptyListPlaceholderStrings
FrontViewDisplayConfig
HorizontalMargin
LibraryTab
ListenTOCViewDisplayConfig
– HeaderTimeStyle
– HeaderTimeLeftStyle
– NavigationBarContent
ListenViewDisplayConfig
– NavigationTitleCloseStyle
– NavigationTitleStyle
– Style
– TuscanyConfig
MiniplayerConfig
NavigationBarConfig
OverlayButtonConfig
ReaderViewDisplayConfig
SeparatorConfig
– RowSeparatorStyle
ShadowConfig
TrackViewConfig
UserVisibleStringIdentifier
UserVisibleStringProvider
Editions
DownloadedEdition
DownloadedEditionsManager
DownloadedEditionsProvider
DownloadProgressListener
Edition
EditionCoverProvider
EditionCoverDataProvider
EditionPresenter
EditionProductsProvider
EditionProvider
Editions
EditionsConfiguration
EditionsDiskUsageProvider
EditionsProduct
OpenError
Page
Paginator
Analytics Events and Attributes
kMaggioAnalytics_Attribute_IsIOS
kMaggioAnalytics_PublisherExternalUserAddressCity
kMaggioAnalytics_PublisherExternalUserProductIdentifiers
kMaggioAnalytics_PublisherExternalUserProductIdentifiersString
kMaggioAnalytics_Attribute_AppInstallIdentifier
kMaggioAnalytics_Attribute_AppName
kMaggioAnalytics_Attribute_BundleId
kMaggioAnalytics_Attribute_Device
kMaggioAnalytics_Attribute_DeviceModel
kMaggioAnalytics_Attribute_IdentifierForVendor
kMaggioAnalytics_Attribute_OSVersion
kMaggioAnalytics_Attribute_Version
kMaggioAnalytics_Attribute_SDKVersion
kMaggioAnalytics_Attribute_Locale
kMaggioAnalytics_Attribute_Platform
kMaggioAnalytics_Attribute_RichieDeviceIdentifier
kMaggioAnalytics_Attribute_TabIdentifier
kMaggioAnalytics_Attribute_Organization
kMaggioAnalytics_Attribute_Product
kMaggioAnalytics_Attribute_ProductTag
kMaggioAnalytics_Attribute_ProductName
kMaggioAnalytics_Attribute_IssueName
kMaggioAnalytics_Attribute_IssueGuid
kMaggioAnalytics_Attribute_ContentPageNumber
kMaggioAnalytics_Attribute_PageNumber
kMaggioAnalytics_Attribute_PageCount
kMaggioAnalytics_Attribute_PageId
kMaggioAnalytics_Attribute_PageGuid
kMaggioAnalytics_Attribute_PageTitle
kMaggioAnalytics_Attribute_PageCategory
kMaggioAnalytics_Attribute_Orientation
kMaggioAnalytics_Attribute_PageViewDuration
kMaggioAnalytics_Attribute_ReachabilityType
kMaggioAnalytics_Attribute_Gesture
kMaggioAnalytics_Attribute_Selected
kMaggioAnalytics_Attribute_PurchaseType
kMaggioAnalytics_Attribute_PurchaseTypeSubscription
kMaggioAnalytics_Attribute_PurchaseTypeSingleIssue
kMaggioAnalytics_Attribute_PurchasePriceGross
kMaggioAnalytics_Attribute_PurchaseCurrency
kMaggioAnalytics_Attribute_DownloadType
kMaggioAnalytics_Attribute_DownloadTypeBackground
kMaggioAnalytics_Attribute_DownloadTypeNormal
kMaggioAnalytics_Attribute_DownloadState
kMaggioAnalytics_Attribute_DownloadStateBackground
kMaggioAnalytics_Attribute_DownloadStateForeground
kMaggioAnalytics_Attribute_NewsArticleAttributes
kMaggioAnalytics_Attribute_NewsPageIndex
kMaggioAnalytics_Attribute_NewsArticleAnalyticsID
kMaggioAnalytics_Attribute_NewsArticleTitle
kMaggioAnalytics_Attribute_URL
kMaggioAnalytics_Attribute_TimestampUTC
kMaggioAnalytics_Attribute_TimestampLocalTZ
kMaggioAnalytics_Attribute_Timestamp
kMaggioAnalytics_Attribute_TimestampWithTZ
kMaggioAnalytics_Attribute_Receipt
kMaggioAnalytics_Attribute_TransactionId
kMaggioAnalytics_Attribute_LatestTransactionId
kMaggioAnalytics_Attribute_OriginalPurchaseDate
kMaggioAnalytics_Attribute_PreviousAnalyticsData
kMaggioAnalytics_Attribute_NavigationSource
kMaggioAnalytics_Attribute_Section
kMaggioAnalytics_Attribute_PaymeterOverlay
kMaggioAnalytics_Attribute_PaymeterRemainingCount
kMaggioAnalytics_Attribute_PaymeterConsumedCount
kMaggioAnalytics_Attribute_FreeArticlesForPeriod
kMaggioAnalytics_Attribute_PaymeterConsumed
kMaggioAnalytics_Attribute_NewOfflineDownloadSetting
kMaggioAnalytics_Attribute_SharingService
kMaggioAnalytics_Attribute_UserIsSignedIn
kMaggioAnalytics_Attribute_UserToken
kMaggioAnalytics_Attribute_PushNotificationSubscribedTopics
kMaggioAnalytics_Attribute_PushNotificationToken
kMaggioAnalytics_Attribute_PushNotificationMasterState
kMaggioAnalytics_Attribute_PushNotificationTopicID
kMaggioAnalytics_Attribute_PushNotificationTopicState
kMaggioAnalytics_Attribute_PushNotificationArticleWasFound
kMaggioAnalytics_Attribute_PushNotificationFeedsRequiredUpdate
kMaggioAnalytics_Attribute_PushNotificationFeedUpdateFailed
kMaggioAnalytics_Attribute_PushNotificationFeedUpdateTimedOut
kMaggioAnalytics_Attribute_IdentifierSession
kMaggioAnalytics_Attribute_IdentifierEvent
kMaggioAnalytics_Attribute_IdentifierScreen
kMaggioAnalytics_Attribute_EventNumber
kMaggioAnalytics_Attribute_AnalyticsInstanceID
kMaggioAnalytics_Attribute_ApplicationState
kMaggioAnalytics_Attribute_ApplicationAge
kMaggioAnalytics_Attribute_DynamicTypeCategory
kMaggioAnalytics_Attribute_CCPAOptOut
kMaggioAnalytics_Attribute_PrivacyPolicyConsentString
kMaggioAnalytics_Attribute_IABTCString
kMaggioAnalytics_Attribute_USTCString
kMaggioAnalytics_Attribute_Book_Id
kMaggioAnalytics_Attribute_Book_External
kMaggioAnalytics_Attribute_Book_Publisher
kMaggioAnalytics_Attribute_Book_Title
kMaggioAnalytics_Attribute_Book_Author
kMaggioAnalytics_Attribute_Book_WorkId
kMaggioAnalytics_Attribute_Book_Categories
kMaggioAnalytics_Attribute_Book_AudioISBN
kMaggioAnalytics_Attribute_Book_EpubISBN
kMaggioAnalytics_Attribute_Book_Progress
kMaggioAnalytics_Attribute_Book_CurrentPage
kMaggioAnalytics_Attribute_Book_TotalPages
kMaggioAnalytics_Attribute_Book_Category
kMaggioAnalytics_Attribute_Book_CategoryPath
kMaggioAnalytics_Attribute_Book_Review
kMaggioAnalytics_Attribute_Book_MediaType
kMaggioAnalytics_Attribute_BooksLibrary_LibraryTabIndex
kMaggioAnalytics_AttributeValue_PurchaseTypeSingle
kMaggioAnalytics_AttributeValue_PurchaseTypeSubscription
kMaggioAnalytics_AttributeValue_PurchaseTypeBundle
kMaggioAnalytics_EventName_App_DidLaunchToForeground
kMaggioAnalytics_EventName_App_DidMoveToBackground
kMaggioAnalytics_EventName_App_DidMoveToForeground
kMaggioAnalytics_EventName_Library_DownloadBegan
kMaggioAnalytics_EventName_Library_DownloadResumed
kMaggioAnalytics_EventName_Library_DownloadCompleted
kMaggioAnalytics_EventName_Library_DownloadCancelled
kMaggioAnalytics_EventName_Library_DownloadFailed
kMaggioAnalytics_EventName_Library_ProcessingResumed
kMaggioAnalytics_EventName_Library_DownloadOrProcessingStopped
kMaggioAnalytics_EventName_Library_ProcessingCompleted
kMaggioAnalytics_EventName_MaggioReader_DidBeginReading
kMaggioAnalytics_EventName_MaggioReader_DidNavigateToPage
kMaggioAnalytics_EventName_MaggioReader_DidNavigateToPageGridView
kMaggioAnalytics_EventName_MaggioReader_DidRotateToOrientation
kMaggioAnalytics_EventName_MaggioReader_DidOpenTOCList
kMaggioAnalytics_EventName_MaggioReader_DidCloseTOCList
kMaggioAnalytics_EventName_MaggioReader_HTMLOverlayEvent
kMaggioAnalytics_EventName_MaggioReader_DidOpenLink
kMaggioAnalytics_EventName_MaggioReader_DidStartFillingCrossword
kMaggioAnalytics_EventName_MaggioReader_DidEndReading
kMaggioAnalytics_EventName_AppUI_DidNavigateToAppTab
kMaggioAnalytics_EventName_AppUI_LargeCoverIssueTouched
kMaggioAnalytics_EventName_AppUI_StoppedDownload
kMaggioAnalytics_EventName_AppUI_SignInSuccessful
kMaggioAnalytics_EventName_AppUI_PurchaseOptionsViewPurchaseButtonTouched
kMaggioAnalytics_EventName_AppUI_PurchaseOptionsViewUserDismissed
kMaggioAnalytics_EventName_AppUI_PurchaseOptionsViewDisplayed
kMaggioAnalytics_EventName_AppUI_DirectPurchaseButtonTapped
kMaggioAnalytics_EventName_AppUI_DisplayPurchaseOptionsButtonTapped
kMaggioAnalytics_EventName_AppUI_SignInButtonTouched
kMaggioAnalytics_EventName_AppUI_DownloadButtonTouched
kMaggioAnalytics_EventName_AppUI_TappedIssueInGrid
kMaggioAnalytics_EventName_AppUI_TappedIssueInScroller
kMaggioAnalytics_EventName_AppUI_SettingsEnabledPushNotifications
kMaggioAnalytics_EventName_AppUI_AskingForPushNotificationsSetting
kMaggioAnalytics_EventName_AppUI_SelectedPushNotificationsSettingNotify
kMaggioAnalytics_EventName_AppUI_SelectedPushNotificationsSettingAskAgainLater
kMaggioAnalytics_EventName_AppUI_SelectedPushNotificationsSettingDontNotify
kMaggioAnalytics_EventName_AppUI_DidDismissPrivacyPolicyConsentDialogWithConsent
kMaggioAnalytics_EventName_AppUI_DidDismissPrivacyPolicyConsentDialogWithoutConsent
kMaggioAnalytics_EventName_PurchaseManager_IAPPurchaseBegan
kMaggioAnalytics_EventName_PurchaseManager_PurchaseCancelled
kMaggioAnalytics_EventName_PurchaseManager_PurchaseFailed
kMaggioAnalytics_EventName_PurchaseManager_PurchaseSuccessful
kMaggioAnalytics_EventName_PurchaseManager_RestoreBegan
kMaggioAnalytics_EventName_PurchaseManager_RestoreCancelled
kMaggioAnalytics_EventName_PurchaseManager_RestoreCompleted
kMaggioAnalytics_EventName_PurchaseManager_RestoreFailed
kMaggioAnalytics_EventName_NewsArticlesController_DidOpenExternalLink
kMaggioAnalytics_EventName_NewsArticlesController_PageView
kMaggioAnalytics_EventName_NewsArticlesController_PageViewStarted
kMaggioAnalytics_EventName_NewsArticlesController_PaymeterOverlayDisplay
kMaggioAnalytics_EventName_NewsArticlesController_SectionFrontOpen
kMaggioAnalytics_EventName_NewsArticlesController_SectionFrontReveal
kMaggioAnalytics_EventName_NewsArticlesController_ArticleClosed
kMaggioAnalytics_EventName_NewsArticleGetAccessTapped
kMaggioAnalytics_EventName_NewsArticlePaymeterConsumed
kMaggioAnalytics_EventName_NewsArticle_OpenSlideShow
kMaggioAnalytics_EventName_NewsArticle_CloseSlideShow
kMaggioAnalytics_EventName_NewsArticle_SlideView
kMaggioAnalytics_EventName_NewsArticle_ExternalLinkOpened
kMaggioAnalytics_EventName_Settings_Login
kMaggioAnalytics_EventName_Settings_Logout
kMaggioAnalytics_EventName_Settings_OfflineDownloadSettingChanged
kMaggioAnalytics_EventName_Settings_Open
kMaggioAnalytics_EventName_Settings_ExternalLinkTapped
kMaggioAnalytics_EventName_Settings_PrivacyPolicyConsentButtonTapped
kMaggioAnalytics_EventName_Application_FirstLaunch
kMaggioAnalytics_EventName_ShareSheet_ShareArticle
kMaggioAnalytics_EventName_ShareSheet_Open
kMaggioAnalytics_EventName_PushNotifications_SubscriptionStatus
kMaggioAnalytics_EventName_PushNotifications_MasterSwitchChanged
kMaggioAnalytics_EventName_PushNotifications_TopicSwitchChanged
kMaggioAnalytics_EventName_PushNotifications_NotificationTapped
kMaggioAnalytics_EventName_BooksLibrary_DidOpenBookDetailsView
kMaggioAnalytics_EventName_BooksLibrary_DidStartReadingBook
kMaggioAnalytics_EventName_BooksLibrary_DidChangeBookPage
kMaggioAnalytics_EventName_BooksLibrary_DidEndReadingBook
kMaggioAnalytics_EventName_BooksLibrary_DidStartListeningToBook
kMaggioAnalytics_EventName_BooksLibrary_DidEndListeningToBook
kMaggioAnalytics_EventName_BooksLibrary_DidStartListeningToTrack
kMaggioAnalytics_EventName_BooksLibrary_DidEndListeningToTrack
kMaggioAnalytics_EventName_BooksLibrary_DidOpenBookCategory
kMaggioAnalytics_EventName_BooksLibrary_DidAddBookToReadingList
kMaggioAnalytics_EventName_BooksLibrary_DidRemoveBookFromReadingList
kMaggioAnalytics_EventName_BooksLibrary_DidReviewBook
kMaggioAnalytics_EventName_BooksLibrary_DidStartOfflineBookDownload
kMaggioAnalytics_EventName_BooksLibrary_DidFinishOfflineBookDownload
kMaggioAnalytics_EventName_BooksLibrary_DidSelectLibraryTab
Other Classes
AudioPlaybackController
BooksLibraryEditionsEventLogger
BooksPushNotification
EditionsBooksContext
ISO8601DecoderProvider
MaggioAnalyticsContextData
MaggioGuid
MaggioMustacheAnalyticsTemplateRenderer
MiniplayerProvider
Richie
RichieAds
RichieAdsController
RichieAdsSlotAdFlight
RichieAdsView
RichieBackgroundDownloadManager
RichieBooksBook
RichieBooksBookLoadingState
RichieBooksLibrary
RichieBooksSingleBookProvider
RichieIndexedContainerView
RichieLinkTapHandler
RichiePageScrollerView
RichieRemoteReporter
RichieRemoteReportingLocalLog
RichieRemoteReportingSpan
RichieSwiperAdTracker
RichieSwiperViewController
RichieUIApplicationBackgroundTaskSource
RichieV1Cryptor
Other Constants
MaggioErrorDomain
MaggioErrorHTTPStatusCode
RichieAdsDidFailLoadingAdNotification
RichieAdsDidLoadAdNotification
RichieAdsDidProgressDownloadingAdNotification
RichieAdsDidStartLoadingAdNotification
RichieAdsErrorDomain
RichieAdsSlotsDidChangeNotification
RichieBooksErrorDomain
RichieSDKVersionNumber
RichieSDKVersionString
kMaggioAnalytics_ContextTimestampFormatDefault
kMaggioAnalytics_ContextTimestampFormatDefaultWithTZ
kMaggioAnalytics_EventName_OAuth_Flow_Complete_Login
kMaggioAnalytics_EventName_OAuth_Flow_Complete_Registration
kMaggioCoverThumbnailMaxSize
kMaggioOriginalPointSizeEnlargementFactorUserDefaultsKey
kMaggioTransitionAnimationDuration
kRichieAdsAdIdentifierKey
kRichieAdsContainerURLKey
kRichieAdsDownloadedBytesKey
kRichieAdsErrorKey
kRichieAdsExpectedTotalBytesKey
kRichieScrollViewFlickVelocityMinimum
Other Enumerations
AudioPlaybackAction
BackgroundViewConfig
BooksFeedSortingType
BooksFilterContentType
BooksFilterDownloadStatus
BooksFilterProgressStatus
BooksFilterPublicationStatus
BooksFilterSourceType
BooksLibraryTabBarStyle
CoverProviderError
CredentialsExchangeResult
DownloadCoverError
DownloadError
MaggioAnalyticsTemplateRenderingFlags
MaggioImagePurpose
MaggioOrientation
NagType
PaginatorError
RichieBooksBookDiskState
RichieBooksBookPresentationState
RichieBooksOrientation
SearchResultsProviderType
ToastViewRoundingMode
UserVisibleOptionalStringIdentifier
– OptionalString
ViewRoundingMode
Other Protocols
Cancelable
CredentialsExchanging
MaggioAnalytics
MaggioAnalyticsTemplateRenderer
RichieAdsViewDelegate
RichieAudiobooksHostAppEventSink
RichieBackgroundTask
RichieBackgroundTaskSource
RichieBooksBookListener
RichieBooksBookLoadingListener
RichieBooksBookLoadingStateProvider
RichieBooksLibraryListener
RichieBooksReaderUiEventListener
RichieCryptor
RichiePageScrollerViewDataSource
RichiePageScrollerViewDelegate
RichieReusableView
RichieSwiper
RichieSwiperDataSource
RichieSwiperDataSourceAdViewPolicy
RichieSwiperDelegate
RichieSwiperSlotAdProvider
Other Type Definitions
CredentialsExchangeCompletionBlock
MaggioDownloadDataProcessBlock
RichieCryptorProvider
Other Functions
MaggioBundle
MaggioBundleImageForName
MaggioBundleLocalizedString
MaggioOrientationFromInterfaceOrientation
MaggioOrientationFromSize
MaggioOrientationIsValid
MaggioOtherOrientationFromOrientation
MaggioStandaloneBundle
MaggioStringFromOrientation
RichieBooksMaggioStandardDecryptProvider
RichieBooksNoSharedSecretDecryptProvider
RichieBooksOrientationToString
RichieOrientationFromInterfaceOrientation
RichieStringFromOrientation
StandaloneImageForName
StandaloneLocalizedString
Other Extensions
RichieOrientation
Other Structures
AlertDescription
– Button
AudioPlaybackInfo
BooksHTMLToAttributedStringConverter
DistributedTracingIDSource
DynamicStatusBarStyle
EditionsInitializationError
MiniplayerStyle
– Position
PodcastEpisodeViewDisplayConfig
PodcastSeriesViewDisplayConfig
SearchViewDisplayConfig
TabBarConfig
ToastViewConfig
Other Type Aliases
EditionCounts
ViewControllerProvider