MimiTestFlow

public class MimiTestFlow : MimiUserFlow

User Flow which provides access to take a Mimi Hearing Test.

Supports MT Test.

Navigation
  • present(from:animated:completion:)
    Declaration

    Swift

    public override func present(from presentingviewController: UIViewController, animated: Bool, completion: (() -> Void)?)
  • push(in:animated:)
    Declaration

    Swift

    public override func push(in navigationController: UINavigationController?, animated: Bool)
  • addAsChild(to:layout:)
    Declaration

    Swift

    public override func addAsChild(to viewController: UIViewController, layout: ((UIViewController, UIView) -> Void)? = nil)
  • makeViewControllerForPresentation()

    Make Test Flow view controller for presentation.

    Note

    completion needs to be called after the testFlowViewController has been presented.

    Throws

    Error if making failed.

    Declaration

    Swift

    public func makeViewControllerForPresentation() throws -> (testFlowViewController: UIViewController, completion: (() -> Void))
    Return Value

    Flow view controller and completion in a tuple.

Notifications
  • didStartNotification

    Posted when the Test Flow starts.

    This indicates that a Test Flow has become visible on screen and can be interacted with. However, this does not mean that the user has necessarily began the test and audio context has been captured, therefore you don’t need to stop any audio just yet.

    Declaration

    Swift

    public static let didStartNotification: Notification.Name
  • didBecomeActiveNotification

    Posted when the Test Flow became active and will start outputting audio.

    This indicates that the user has decided to begin a test and the test flow will start outputting audio. If you have not already, you should stop any audio your app is currently playing now.

    Declaration

    Swift

    public static let didBecomeActiveNotification: Notification.Name
  • didBecomeInactiveNotification

    Posted when the Test Flow has finished outputting audio and is now inactive.

    From this point you can resume any in-app audio, however it does not indicate that the test flow has completely finished.

    Declaration

    Swift

    public static let didBecomeInactiveNotification: Notification.Name
  • didFinishNotification

    Posted when the Test Flow finishes.

    This indicates that a Test Flow has successfully finished and completed.

    Declaration

    Swift

    public static let didFinishNotification: Notification.Name
  • didSubmitTestNotification

    Posted when the Test Flow successfully submitted a Hearing Test.

    This indicates the test was successfully taken and submitted. The userInfo dictionary contains the following information:

    Key Value
    “testResults” The result of the submitted test
    Declaration

    Swift

    public static let didSubmitTestNotification: Notification.Name
  • didFailToSubmitTestNotification

    Posted when the Test Flow failed to submit a Hearing Test.

    This indicates a test was taken but failed to submit due to a network or other error.

    Declaration

    Swift

    public static let didFailToSubmitTestNotification: Notification.Name

Flow
  • build()

    Build a new test flow.

    Throws

    Error if building failed.
    Declaration

    Swift

    public class func build() async throws -> MimiTestFlow
    Return Value

    Test flow.