forgerock-authenticator/org.forgerock.android.auth/FRAClient

FRAClient

open class FRAClient

The top level FRAClient object represents the Authenticator module of the ForgeRock Mobile SDK. It is the front facing class where the configuration settings for the SDK can be found and utilized.

To create a new FRAClient object use the static builder.

Constructors

Link copied to clipboard
private constructor(authenticatorManager: AuthenticatorManager)

Types

Link copied to clipboard
open class FRAClientBuilder
The asynchronous Authenticator client builder.

Properties

Link copied to clipboard
private open var authenticatorManager: AuthenticatorManager
The Authenticator Manager instance.
Link copied to clipboard
private val TAG: String

Functions

Link copied to clipboard
open fun builder(): FRAClient.FRAClientBuilder
Obtain FRAClient builder.
Link copied to clipboard
open fun createMechanismFromUri(@NonNull uri: String, @NonNull listener: FRAListener<Mechanism>)
Create a Mechanism using the URL extracted from the QRCode.
Link copied to clipboard
open fun getAccount(@NonNull accountId: String): Account
Get the Account object with its id.
open fun getAccount(@NonNull mechanism: Mechanism): Account
Get the Account object with its associated Mechanism.
Link copied to clipboard
open fun getAllAccounts(): List<Account>
Get all accounts stored in the system.
Link copied to clipboard
open fun getAllNotifications(): List<PushNotification>
Get single list of notifications across all mechanisms.
open fun getAllNotifications(@NonNull mechanism: Mechanism): List<PushNotification>
Get all of the notifications that belong to a PushMechanism object.
Link copied to clipboard
Link copied to clipboard
open fun getMechanism(@NonNull notification: PushNotification): Mechanism
Get the Mechanism object associated with the PushNotification object.
Link copied to clipboard
open fun getNotification(@NonNull notificationId: String): PushNotification
Get the PushNotification object with its id.
Link copied to clipboard
open fun handleMessage(@NonNull message: RemoteMessage): PushNotification
Receives a FCM remote message and covert into a PushNotification object, which allows accept or deny Push Authentication requests.
open fun handleMessage(@NonNull messageId: String, @NonNull message: String): PushNotification
Receives the parameters from a FCM remote message and covert into a PushNotification object, which allows accept or deny Push Authentication requests.
Link copied to clipboard
open fun lockAccount(@NonNull account: Account, @NonNull policy: FRAPolicy): Boolean
Lock the Account that was passed in, limiting the access to all Mechanism objects and any PushNotification objects associated with it.
Link copied to clipboard
open fun registerForRemoteNotifications(@NonNull deviceToken: String)
This method allows to register the FCM device token to handle Push mechanisms after the SDK initialization.
Link copied to clipboard
open fun removeAccount(@NonNull account: Account): Boolean
Remove from the storage the Account that was passed in, all Mechanism objects and any PushNotification objects associated with it.
Link copied to clipboard
open fun removeMechanism(@NonNull mechanism: Mechanism): Boolean
Remove from the storage the Mechanism that was passed in and any notifications associated with it.
Link copied to clipboard
open fun removeNotification(@NonNull notification: PushNotification): Boolean
Remove from the storage the PushNotification that was passed in.
Link copied to clipboard
open fun unlockAccount(@NonNull account: Account): Boolean
Unlock the Account that was passed in.
Link copied to clipboard
open fun updateAccount(@NonNull account: Account): Boolean
Update the Account object the storage system.