FRAClient.FRAClientBuilder (forgerock-authenticator 3.3.3 API)

java.lang.Object
- org.forgerock.android.auth.FRAClient.FRAClientBuilder

Enclosing class:: FRAClient

public static class FRAClient.FRAClientBuilder
extends java.lang.Object

The asynchronous Authenticator client builder.

Constructor Summary

Constructors
Constructor Description

FRAClientBuilder()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`FRAClient`	`start()`	Initialize the authenticator client `FRAClient`.
`FRAClient.FRAClientBuilder`	`withContext(android.content.Context context)`	Initialize the FRAClient instance with an Android Context.
`FRAClient.FRAClientBuilder`	`withDeviceToken(java.lang.String deviceToken)`	Initialize the FRAClient instance with the FCM device token obtained from FCM service `FirebaseMessagingService`.
`FRAClient.FRAClientBuilder`	`withStorage(StorageClient storage)`	Initialize the FRAClient instance with a custom storage implementation.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - FRAClientBuilder
```
public FRAClientBuilder()
```
- Method Detail
  - withContext
```
public FRAClient.FRAClientBuilder withContext(@NonNull
                                              android.content.Context context)
```
    Initialize the FRAClient instance with an Android Context.
    
    Parameters:
    
    context - the context
    
    Returns:
    
    this builder
  - withStorage
```
public FRAClient.FRAClientBuilder withStorage(@NonNull
                                              StorageClient storage)
```
    Initialize the FRAClient instance with a custom storage implementation. You can define your own storage implementing StorageClient or use the default implementation DefaultStorageClient.
    
    Parameters:
    
    storage - the storage implementation
    
    Returns:
    
    this builder
  - withDeviceToken
```
public FRAClient.FRAClientBuilder withDeviceToken(@NonNull
                                                  java.lang.String deviceToken)
```
    Initialize the FRAClient instance with the FCM device token obtained from FCM service FirebaseMessagingService.
    
    Parameters:
    
    deviceToken - the FCM device token
    
    Returns:
    
    this builder
  - start
```
public FRAClient start()
                throws AuthenticatorException
```
    Initialize the authenticator client FRAClient.
    
    Throws:
    
    AuthenticatorException - If Context was not provided