common/co.seam.common.models

Package-level declarations

Types

@Serializable

@SerialName(value = "background_scan_unsupported")

data class BackgroundScanUnsupported(val underlyingError: Throwable? = null) : SeamError

You have set PhoneNative.UnlockWithTap.launch.foreground to false, but the app user's phone does not currently support scanning in the background.

BluetoothConnectionRequired

@Serializable

@SerialName(value = "bluetooth_connection_required")

data class BluetoothConnectionRequired(val underlyingError: Throwable? = null) : SeamError

Prompt the app user to enable Bluetooth on their phone.

CredentialsRequired

@Serializable

@SerialName(value = "credentials_required")

data class CredentialsRequired(val underlyingError: Throwable? = null) : SeamError

No credentials found for the app user's phone.

IAndroidDeviceInfo

interface IAndroidDeviceInfo

InternetConnectionRequired

@Serializable

@SerialName(value = "internet_connection_required")

data class InternetConnectionRequired(val underlyingError: Throwable? = null) : SeamError

The app user's phone is not connected to the internet.

MissingRequiredAndroidPermissions

@Serializable

@SerialName(value = "missing_required_android_permissions")

data class MissingRequiredAndroidPermissions(val androidPermissions: List<String>, val underlyingError: Throwable? = null) : SeamError

Prompt the app user to grant your app the listed permissions on their phone.

MustEnableUnlockWithTapAtInitializationError

@Serializable

@SerialName(value = "must_enable_unlock_with_tap_at_initialization")

data class MustEnableUnlockWithTapAtInitializationError(val underlyingError: Throwable? = null) : SeamError

Use the default value (true) for initialize.enableUnlockWithTap.

MustProvideNotificationInUnlockWithTapLaunch

@Serializable

@SerialName(value = "must_provide_notification_in_unlock_with_tap_launch")

data class MustProvideNotificationInUnlockWithTapLaunch(val underlyingError: Throwable? = null) : SeamError

When you launch unlockWithTap for ASSA ABLOY, you must include the notification parameter.

PhoneInitializationRequired

@Serializable

@SerialName(value = "phone_initialization_required")

class PhoneInitializationRequired : SeamError

Use PhoneNative.initialize to initialize the app user's phone.

ProviderName

@Serializable

enum ProviderName : Enum<ProviderName>

RefreshResult

data class RefreshResult(var wantsUnregister: Boolean = false, var wantsFastRefresh: Boolean = false, var propagateErrors: List<SeamError> = listOf())

SeamError

@Serializable

open class SeamError(val message: String, val underlyingError: Throwable? = null) : Throwable

Initialization, provider initialization, or configuration error.

SeamEvent

@Serializable

sealed class SeamEvent

Event that indicates a status change or an issue that has occurred.

SeamEventHandler

typealias SeamEventHandler = (event: SeamEvent) -> Unit

Seam event handler to handle the following SeamEvent types:

SeamFailure

@Serializable

@SerialName(value = "error")

data class SeamFailure<T>(val error: SeamError) : SeamResult<T>

SeamIntegrationDebugInfo

@Serializable

sealed class SeamIntegrationDebugInfo

SeamProviderName

@Serializable

enum SeamProviderName : Enum<SeamProviderName>

SeamResult

@Serializable

sealed class SeamResult<T>

Success or failure result.

SeamSchema

object SeamSchema

Schema definitions for returned data.

SeamSuccess

@Serializable

@SerialName(value = "success")

data class SeamSuccess<T>(val data: T) : SeamResult<T>

SeamWarning

@Serializable

data class SeamWarning(val type: String)

Warning.

SeosDebugInfo

@SerialName(value = "seos")

@Serializable

data class SeosDebugInfo(val providerId: SeosProviderId, val seosSdkMetadata: SeamSchema.SeosSdkMetadata) : SeamIntegrationDebugInfo

Functions

asSeamFailure

fun <T> SeamError.asSeamFailure(): SeamFailure<T>

asSeamSDKError

fun Throwable?.asSeamSDKError(): SeamError

Forms an internal Seam SDK-related error.

asSeamSuccess

fun <T> T.asSeamSuccess(): SeamSuccess<T>

toRefreshResult

fun SeamError.toRefreshResult(): RefreshResult

fun Exception.toRefreshResult(): RefreshResult

fun Throwable?.toRefreshResult(): RefreshResult

withRefreshResult

inline suspend fun withRefreshResult(crossinline block: suspend (refreshResult: RefreshResult) -> RefreshResult): RefreshResult