Package-level declarations

Types

Link copied to clipboard
@Serializable
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.

Link copied to clipboard
@Serializable
data class BluetoothConnectionRequired(val underlyingError: Throwable? = null) : SeamError

Prompt the app user to enable Bluetooth on their phone.

Link copied to clipboard
data class ClientSessionExpiredError(val requestId: String? = null, val message: String, val underlyingError: Throwable? = null) : SeamError

The client session has expired and needs to be renewed.

Link copied to clipboard
typealias CredentialId = String
Link copied to clipboard
@Serializable
data class CredentialsRequired(val underlyingError: Throwable? = null) : SeamError

No credentials found for the app user's phone.

Link copied to clipboard
interface IDeviceInfo
Link copied to clipboard
@Serializable
data class InternetConnectionRequired(val underlyingError: Throwable? = null) : SeamError

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

Link copied to clipboard
@Serializable
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.

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

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

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

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

Link copied to clipboard

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

Link copied to clipboard
@Serializable
enum ProviderName : Enum<ProviderName>
Link copied to clipboard
data class RefreshResult(var wantsUnregister: Boolean = false, var wantsFastRefresh: Boolean = false, var propagateErrors: List<SeamError> = listOf())
Link copied to clipboard
data class SeamCredential(val id: CredentialId?, val name: String, val location: String?, val expiry: LocalDateTime?, val cardNumber: String?, val code: String?, val errors: List<SeamCredentialError>)

A Seam credential object

Link copied to clipboard
@Serializable
open class SeamError(val message: String, val underlyingError: Throwable? = null) : Throwable

Initialization, provider initialization, or configuration error.

Link copied to clipboard
@Serializable
sealed class SeamEvent

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

Link copied to clipboard
typealias SeamEventHandler = (event: SeamEvent) -> Unit

Seam event handler to handle the following SeamEvent types:

Link copied to clipboard
@Serializable
data class SeamFailure<T>(val error: SeamError) : SeamResult<T>
Link copied to clipboard
@Serializable
sealed class SeamIntegrationDebugInfo
Link copied to clipboard
@Serializable
sealed class SeamResult<T>

Success or failure result.

Link copied to clipboard
object SeamSchema

Schema definitions for returned data.

Link copied to clipboard
@Serializable
data class SeamSuccess<T>(val data: T) : SeamResult<T>
Link copied to clipboard
@Serializable
data class SeamWarning(val type: String)

Warning.

Link copied to clipboard
@Serializable
data class SeosDebugInfo(val providerId: SeosProviderId, val seosSdkMetadata: SeamSchema.SeosSdkMetadata) : SeamIntegrationDebugInfo
Link copied to clipboard
data class UnauthorizedError(val requestId: String? = null, val message: String, val underlyingError: Throwable? = null) : SeamError

The client session has expired and needs to be renewed.

Functions

Link copied to clipboard
Link copied to clipboard

Forms an internal Seam SDK-related error.

Link copied to clipboard
Link copied to clipboard
inline suspend fun withRefreshResult(crossinline block: suspend (refreshResult: RefreshResult) -> RefreshResult): RefreshResult