futuraekit-java/com.futurae.sdk/FuturaeSDK

FuturaeSDK

public class FuturaeSDK implements FuturaeSDKApi

Properties

client

private final FuturaeClientApi client

FuturaeClientApi object getter method.

INSTANCE

private final FuturaeSDK INSTANCE

public final static FuturaeSDK INSTANCE

isSDKInitialized

private final Boolean isSDKInitialized

notificationsFlow

private final SharedFlow<Result<FTRNotificationEvent>> notificationsFlow

Flow emitting whenever a Futurae FCM notification has been handled. The notification is wrapped in Kotlin Result to also delegate any failures while handing a notification.

Functions

disableAdaptive

@Deprecated(message = "Use FuturaeAdaptiveApi methods instead")

public Unit ~~disableAdaptive~~()

Deprecated, please use FuturaeAdaptiveApi.disableAdaptive instead. Disables Adaptive SDK.

enableAdaptive

@Deprecated(message = "Use FuturaeAdaptiveApi methods instead")

public Unit ~~enableAdaptive~~(Application application)

Deprecated, please use FuturaeAdaptiveApi.enableAdaptive instead. Enables the Adaptive SDK.

getClient

public FuturaeClientApi getClient()

getFTAccounts

public final List<FTAccount> getFTAccounts(Context context)

Returns a list of enrolled accounts FTAccount

getFTRNotificationFactory

public final FTRNotificationFactory getFTRNotificationFactory()

FTRNotificationFactory object getter method.

getINSTANCE

public final FuturaeSDK getINSTANCE()

getNotificationsFlow

public final SharedFlow<Result<FTRNotificationEvent>> getNotificationsFlow()

Flow emitting whenever a Futurae FCM notification has been handled. The notification is wrapped in Kotlin Result to also delegate any failures while handing a notification.

isSDKInitialized

public final Boolean isSDKInitialized()

launch

public Unit launch(Application application, SDKConfiguration sdkConfiguration)

Function that Initializes the SDK.

launchAccountRecovery

public AsyncCompletableOperation launchAccountRecovery(Application application, SDKConfiguration sdkConfiguration)

Function that Initializes the SDK bypassing FTCorruptedStateException and attempting to recover Accounts for LockConfigurationType.NONE

@Deprecated(message = "Please use launchAccountRecovery with UserPresenceVerificationMode argument")

public final Unit ~~launchAccountRecovery~~(Application application, SDKConfiguration sdkConfiguration, Callback<Unit> callback)

Function that Initializes the SDK bypassing FTCorruptedStateException and attempting to recover Accounts. Recovery via this method is only available for LockConfigurationType.NONE

public Unit launchAccountRecovery(Application application, SDKConfiguration sdkConfiguration, UserPresenceVerificationMode userPresenceVerificationMode, Callback<Unit> callback)

Function that Initializes the SDK bypassing FTCorruptedStateException and attempting to recover Accounts.

reset

public Unit reset(Context context)

Resets the SDK to a clean installation state. This will irreversibly reset the configuration and remove all accounts, keys, secrets and credentials from the SDK.

sdkState

public final StateFlow<FuturaeSDKState> sdkState()

switchToLockConfigurationBiometrics

public final Unit switchToLockConfigurationBiometrics(SDKConfiguration sdkConfiguration, FragmentActivity fragmentActivity, String promptTitle, String promptSubtitle, String promptDescription, String negativeButtonText, Callback<Unit> callback)

Protected operation to change SDK configuration without resetting. Requires at least one enrolled account. This method will attempt to authenticate the user.

switchToLockConfigurationBiometricsOrCredentials

public final Unit switchToLockConfigurationBiometricsOrCredentials(SDKConfiguration sdkConfiguration, FragmentActivity fragmentActivity, String promptTitle, String promptSubtitle, String promptDescription, Callback<Unit> callback)

Protected operation to change SDK configuration without resetting. Requires at least one enrolled account. This method will attempt to authenticate the user.

switchToLockConfigurationNone

public final Unit switchToLockConfigurationNone(Application application, SDKConfiguration sdkConfiguration, Callback<Unit> callback)

Protected operation to change SDK configuration without resetting. Requires at least one enrolled account.

switchToLockConfigurationWithPin

public final Unit switchToLockConfigurationWithPin(Application application, SDKConfiguration sdkConfiguration, CharArray sdkPin, Callback<Unit> callback)

Protected operation to change SDK configuration without resetting. Requires at least one enrolled account.