TokenRequestTrigger

public enum TokenRequestTrigger : Sendable

The event that triggered a request.

You can use this information for example to decide what, if any, alerts to show. This list may expand in the future.

  • User is downloading a book.

    Declaration

    Swift

    case bookDownload

  • The reading list sync service is being called.

    Declaration

    Swift

    case readingListOperation

  • The reading list sync service is being called with addition.

    Declaration

    Swift

    case readingListAddOperation

  • The reading list sync service is being called with removal.

    Declaration

    Swift

    case readingListRemoveOperation

  • User is downloading an edition.

    Declaration

    Swift

    case editionDownload(id: UUID)

  • The user wants to post a new rating. This trigger occurs when the user taps on the rating button. If the host app cannot provide a token, it may want to show a login UI or a warning dialog.

    Declaration

    Swift

    case userRatingsPost

  • The SDK is executing a ratings sync and wants to fetch ratings given by the current user. This trigger occurs on the SDK’s discretion. If the host app cannot provide a token, it should return null in order to skip the fetching of user-specific ratings. Ratings sync will be restarted by the SDK once user’s login state will change.

    Declaration

    Swift

    case userRatingsGet

  • The reading position sync service is being called.

    Declaration

    Swift

    case readingPositionOperation

  • Personalized recommendations are being fetched.

    Declaration

    Swift

    case recommendationsOperation

  • Playlist operations are being performed.

    Declaration

    Swift

    case playlistsOperation

  • User is downloading an audio asset or a key for one.

    Declaration

    Swift

    case audioAssetDownload