UserDataStore

public protocol UserDataStore : AnyObject

Interface to access user specific data sourcery: StreamWrapped

Onboarding

  • Publisher that returns if the onboarding screens should be displayed

    Declaration

    Swift

    var hideOnboarding: AnyPublisher<Bool, Never> { get }

  • Indicates if the onboarding screens should be displayed (alternative to publisher)

    Declaration

    Swift

    var isOnboardingHidden: Bool { get }

  • Publisher that returns the date when the onboarding was completed

    Declaration

    Swift

    var onboardingDate: AnyPublisher<Date?, Never> { get }

  • Set the onboardingDate The new value is published through onboardingDate

    Declaration

    Swift

    func set(onboardingDate: Date?)

    Parameters

    onboardingDate

    the current date when the function is called

  • Set the hideOnboarding The new value is published through hideOnboarding

    Declaration

    Swift

    func set(hideOnboarding: Bool)

    Parameters

    hideOnboarding

    trueif it should be hidden, otherwise false

  • Indicates with which version the onboarding has been shown

    Declaration

    Swift

    var onboardingVersion: AnyPublisher<String?, Never> { get }

  • Set the app version in which onboarding has been presented The new value is published through onboardingVersion

    Declaration

    Swift

    func set(onboardingVersion: String?)

    Parameters

    onboardingVersion

    app version that was installed when onboarding has finished

CardWall

  • Indicates if the card wall intro screen should be displayed

    Declaration

    Swift

    var hideCardWallIntro: AnyPublisher<Bool, Never> { get }

  • Set the hideCardWallIntro The new value is published through hideCardWallIntro

    Declaration

    Swift

    func set(hideCardWallIntro: Bool)

    Parameters

    hideCardWallIntro

    trueif it should be hidden, otherwise false

Server configuration name

  • Server environment name to use. Only available in non production builds.

    Declaration

    Swift

    func set(serverEnvironmentConfiguration: String?)

  • Server environment name to use. Only available in non production builds.

    Declaration

    Swift

    var serverEnvironmentConfiguration: AnyPublisher<String?, Never> { get }

  • Get name for server environment configuration without publisher

    Declaration

    Swift

    var serverEnvironmentName: String? { get }

App Security

  • The app security option

    Declaration

    Swift

    var appSecurityOption: AnyPublisher<AppSecurityOption, Never> { get }

  • Set the app security option The new value is published through appSecurityOption

    Declaration

    Swift

    func set(appSecurityOption: AppSecurityOption)

    Parameters

    appSecurityOption

    The option selected to secure the app

  • The current count of failed app authentications

    Declaration

    Swift

    var failedAppAuthentications: AnyPublisher<Int, Never> { get }

  • Set the count of failed app authentications during login

    Declaration

    Swift

    func set(failedAppAuthentications: Int)

    Parameters

    failedAppAuthentications

    number of failures

  • Whether the “your device is not secured” warning should be ignored permanently.

    Declaration

    Swift

    var ignoreDeviceNotSecuredWarningPermanently: AnyPublisher<Bool, Never> { get }

  • Set whether the “your device is not secured” warning should be ignored permanently.

    Declaration

    Swift

    func set(ignoreDeviceNotSecuredWarningPermanently: Bool)

    Parameters

    ignoreDeviceNotSecuredWarningForSession

    ignore the warning permanently

Profile Selection

General

  • Declaration

    Swift

    var latestCompatibleModelVersion: ModelVersion { get set }

  • Counter that is increased every time the app has been opened

    Declaration

    Swift

    var appStartCounter: Int { get set }

  • Deletes all data stored in the UserDataStore

    Declaration

    Swift

    func wipeAll()

Messages

  • Publisher that returns all the ids from internal messages that already got displayed

    Declaration

    Swift

    var readInternalCommunications: AnyPublisher<[String], Never> { get }

  • Set the readInternalCommunications The new value is published through readInternalCommunications

    Declaration

    Swift

    func markInternalCommunicationAsRead(messageId: String)

    Parameters

    messageId

    id of an internal message that got displayed

  • Indicates if the internal communication welcome message should be displayed

    Declaration

    Swift

    var hideWelcomeMessage: AnyPublisher<Bool, Never> { get }

  • Set the hideWelcomeMessage The new value is published through hideWelcomeMessage

    Declaration

    Swift

    func set(hideWelcomeMessage: Bool)

    Parameters

    hideWelcomeMessage

    trueif it should be hidden, otherwise false