core/co.seam.core.api/PhoneNative

PhoneNative

class PhoneNative(mobileController: MobileController)

Use initialize to initialize the phone setup processes so that the app user's phone is ready to accept mobile keys and downloads any existing mobile keys. Use credentials to retrieve the list of credentials. Use UnlockWithTap functions to start and stop UnlockWithTap scanning.

Constructors

PhoneNative

constructor(mobileController: MobileController)

Types

Credentials

class Credentials(mobileController: MobileController)

list retrieves the list of credentials for PhoneNative.credentials.

UnlockWithTap

class UnlockWithTap(mobileController: MobileController)

Use launch to start UnlockWithTap scanning. Use stop to stop scanning. Use get to retrieve UnlockWithTap instance properties and status.

Properties

credentials

val credentials: PhoneNative.Credentials

List of relevant credentials.

unlockWithTap

val unlockWithTap: PhoneNative.UnlockWithTap

An unlock scanning process that enables mobile apps to open granted entrances.

Functions

deactivate

suspend fun deactivate(): SeamResult<Unit>

Deactivates the app user's phone. That is, deletes the phone on the backend, all credentials on the phone, the corresponding provider resource, and so on. More permanent than deinitialize.

deinitialize

fun deinitialize()

Deinitializes the app user's phone. More lightweight than deactivate.

initialize

suspend fun initialize(enableUnlockWithTap: Boolean): SeamResult<Unit>

Initializes the phone setup processes so that the app user's phone is ready to accept mobile keys and downloads any existing mobile keys.

listRequiredAndroidPermissions

fun listRequiredAndroidPermissions(enableUnlockWithTap: Boolean): List<String>

Retrieves a list of required permissions that the user must grant to your app.