Parakey SDK for Android/co.parakey.sdk/Parakey

Parakey

object Parakey

The facade for the SDK.

Functions

Link copied to clipboard
suspend fun configure(tokenBundle: String): ParakeyError?

Validates and saves the provided token bundle. The SDK needs a valid bundle to unlock locks.

Link copied to clipboard
suspend fun deconfigure()

Clears all data associated with the current token bundle.

Link copied to clipboard
fun initialize(app: Application)

Initializes the SDK, registers background jobs, and starts app lifecycle listeners. Background syncing is required to keep the user's access up to date.

Link copied to clipboard
suspend fun showScan(): ParakeyError?

Opens a new activity which displays all nearby Parakey locks that the user has access to. Available locks can be unlocked from this view.

Link copied to clipboard
fun theme(@ColorInt actionLight: Int? = null, @ColorInt actionDark: Int? = null, @ColorInt titleLight: Int? = null, @ColorInt titleDark: Int? = null)

Sets colors used throughout the SDK. If no color is provided the default Parakey colors will be used.