libcore/io.mimi.sdk.core

Package-level declarations

Types

data class DispatcherProvider(val Main: CoroutineDispatcher = Dispatchers.Main, val IO: CoroutineDispatcher = Dispatchers.IO, val Default: CoroutineDispatcher = Dispatchers.Default)

Convenience class to choose the type Coroutine context

MimiConfiguration

data class MimiConfiguration(val allowRemoteDeviceAuthorization: Boolean = false, val allowAnonymousUserOnly: Boolean = false, val mimiPersonalizationConfiguration: MimiPersonalizationConfiguration = MimiPersonalizationConfiguration(), val mimiOnboardingConfiguration: MimiOnboardingConfiguration = MimiOnboardingConfiguration())

Object which can be used to configure and customize various Mimi features and functionality.

MimiCore

object MimiCore : MimiCoreServices

MimiCore instance provides the global access point to use MimiCoreServices.

MimiCoreException

sealed class MimiCoreException : Exception

Raised on any errors that occur within the core module.

MimiCoreServices

interface MimiCoreServices

Definition of the MimiCore main public API; 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.

MimiEvents

interface MimiEvents

Interface containing callback methods regarding internal events triggered by the mSDK

MimiOnboardingConfiguration

data class MimiOnboardingConfiguration(val showProfileOnboardingIntroduction: Boolean = true)

Used to define the configuration of the Mimi Profile onboarding functionality.

MimiPersonalizationConfiguration

data class MimiPersonalizationConfiguration(val showSampleSoundPlayerInProfile: Boolean = true)

Used to define the configuration of the Mimi Profile personalization functionality.

OAuth2Error

data class OAuth2Error(val error: String, val error_description: String)

Wrapper for OAuth2 compliant errors

ServerError

data class ServerError(val statusCode: Int, val error: String?, val message: String)

Wrapper class for errors returned by the backend.

Properties

EMAIL_ALREADY_IN_USE

const val EMAIL_ALREADY_IN_USE: Int = 422

Server code for email already in use error.

moshi

val moshi: Moshi

Functions

createQrCode

fun DeviceAuthorizationRequest.createQrCode(width: Int, height: Int, contrastLow: Int? = null, contrastHigh: Int? = null): Bitmap

doNothing

fun doNothing()

launchHandled

fun CoroutineScope.launchHandled(block: suspend () -> Unit): Job

A launch Coroutine Builder that handles MimiCoreException