MimiCore

public final class MimiCore

MimiCore is the gateway to Mimi services; providing access to key functionality such as authentication, personalization and test management. It handles all aspects of communication with the Mimi API, providing a robust framework that can be used to integrate an app into the Mimi eco-system.

Types
  • ClientCredentials

    Credentials for a client

    • client: Client with an identifier and secret.
    Declaration

    Swift

    public enum ClientCredentials

Singleton
  • shared

    The shared mocked MimiCore instance.

  • shared

    The shared MimiCore instance.

    Declaration

    Swift

    public static let shared: MimiCore

Properties
  • log

    Logger that will print outputs to the console.

    Declaration

    Swift

    public let log: MimiLogger
  • allowsUsageDataCollection

    Whether collection of usage data for use by Mimi is currently enabled.

    Declaration

    Swift

    public var allowsUsageDataCollection: Bool { get set }

Set Up
  • start(credentials:delegate:)

    Start MimiCore with client credentials.

    This is a required step to use any of MimiCore’s APIs. Failing to do so will result in a fatal error. This will also error if called multiple times. To update the client credentials, use update(credentials:).

    Declaration

    Swift

    public func start(credentials: ClientCredentials,
                  delegate: MimiCoreDelegate)
    Parameters
    credentials

    Your client credentials.
    delegate

    Object that acts as a delegate for MimiCore.
  • update(credentials:)

    Update client credentials.

    This can only be called after start() has been called and MimiCore has started.

    Declaration

    Swift

    public func update(credentials: ClientCredentials)
    Parameters
    environment

    New environment to use.
    credentials

    New client credentials to use.
  • version

    Version number of MimiCore.

    Declaration

    Swift

    public static let version: String

Controllers