All Implemented Interfaces:

java.io.Serializable , org.forgerock.android.auth.callback.Binding , org.forgerock.android.auth.callback.Callback
```
public class DeviceBindingCallback
extends AbstractCallback implements Binding
                    
```
Callback to collect the device binding information

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description
`private final String`	`userId`
`private final String`	`userName`
`private final String`	`challenge`
`private final DeviceBindingAuthenticationType`	`deviceBindingAuthenticationType`
`private final String`	`title`
`private final String`	`subtitle`
`private final String`	`description`
`private final Integer`	`timeout`
`private final Attestation`	`attestation`
`private final Function1<DeviceBindingAuthenticationType, DeviceAuthenticator>`	`deviceAuthenticatorIdentifier`

Constructor Summary

Constructors
Constructor	Description
`DeviceBindingCallback(JSONObject jsonObject, Integer index)`
`DeviceBindingCallback()`

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final String`	`getUserId()`	The userId received from server
`final String`	`getUserName()`	The userName received from server
`final String`	`getChallenge()`	The challenge received from server
`final DeviceBindingAuthenticationType`	`getDeviceBindingAuthenticationType()`	The authentication type of the journey
`final String`	`getTitle()`	The title to be displayed in biometric prompt
`final String`	`getSubtitle()`	The subtitle to be displayed in biometric prompt
`final String`	`getDescription()`	The description to be displayed in biometric prompt
`final Integer`	`getTimeout()`	The timeout to be to expire the biometric authentication
`final Attestation`	`getAttestation()`	Enable Attestation
`String`	`getType()`	Return the type of the Callback, the type name should align with the Callback type returned from AM
`final Unit`	`setJws(String value)`	Input the JWS key to the server
`final Unit`	`setDeviceName(String value)`	Input the Device Name to the server
`final Unit`	`setDeviceId(String value)`	Input the Device Id to the server
`Unit`	`setClientError(String value)`	Input the Client Error to the server
`Unit`	`bind(Context context, Function1<DeviceBindingAuthenticationType, DeviceAuthenticator> deviceAuthenticator, FRListener<Void> listener)`	Bind the device.
`Unit`	`bind(Context context, FRListener<Void> listener)`	Bind the device.
`Unit`	`bind(Context context, Function1<DeviceBindingAuthenticationType, DeviceAuthenticator> deviceAuthenticator)`	Bind the device.
`CryptoKey`	`getCryptoKey()`

Methods inherited from class org.forgerock.android.auth.callback.Binding
getDeviceAuthenticator, getDeviceAuthenticatorIdentifier, getDuration, getExpiration, handleException
Methods inherited from class org.forgerock.android.auth.callback.AbstractCallback
getContent, getInputValue, getInputValue, get_id
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - DeviceBindingCallback
```
DeviceBindingCallback(JSONObject jsonObject, Integer index)
```
  - DeviceBindingCallback
```
DeviceBindingCallback()
```
- Method Detail
  - getUserId
```
 final String getUserId()
```
    The userId received from server
  - getUserName
```
 final String getUserName()
```
    The userName received from server
  - getChallenge
```
 final String getChallenge()
```
    The challenge received from server
  - getDeviceBindingAuthenticationType
```
 final DeviceBindingAuthenticationType getDeviceBindingAuthenticationType()
```
    The authentication type of the journey
  - getTitle
```
 final String getTitle()
```
    The title to be displayed in biometric prompt
  - getSubtitle
```
 final String getSubtitle()
```
    The subtitle to be displayed in biometric prompt
  - getDescription
```
 final String getDescription()
```
    The description to be displayed in biometric prompt
  - getTimeout
```
 final Integer getTimeout()
```
    The timeout to be to expire the biometric authentication
  - getAttestation
```
 final Attestation getAttestation()
```
    Enable Attestation
  - getType
```
 String getType()
```
    Return the type of the Callback, the type name should align with the Callback type returned from AM
  - setJws
```
 final Unit setJws(String value)
```
    Input the JWS key to the server
    
    Parameters:
    
    value - The JWS value.
  - setDeviceName
```
 final Unit setDeviceName(String value)
```
    Input the Device Name to the server
    
    Parameters:
    
    value - The device name value.
  - setDeviceId
```
 final Unit setDeviceId(String value)
```
    Input the Device Id to the server
    
    Parameters:
    
    value - The device Id.
  - setClientError
```
 Unit setClientError(String value)
```
    Input the Client Error to the server
    
    Parameters:
    
    value - DeviceBind ErrorType .
  - bind
```
@JvmOverloads() Unit bind(Context context, Function1<DeviceBindingAuthenticationType, DeviceAuthenticator> deviceAuthenticator, FRListener<Void> listener)
```
    Bind the device. Calling the bind function, the existing bounded keys will be removed. If don't want to replace or remove existing keys, please use FRUserKeys to check existing keys before calling this method
    
    Parameters:
    
    context - The Application Context
    
    deviceAuthenticator - A function to return a DeviceAuthenticator, deviceAuthenticatorIdentifier will be used if not provided
    
    listener - The Listener to listen for the result
  - bind
```
@JvmOverloads() Unit bind(Context context, FRListener<Void> listener)
```
    Bind the device. Calling the bind function, the existing bounded keys will be removed. If don't want to replace or remove existing keys, please use FRUserKeys to check existing keys before calling this method
    
    Parameters:
    
    context - The Application Context
    
    listener - The Listener to listen for the result
  - bind
```
 Unit bind(Context context, Function1<DeviceBindingAuthenticationType, DeviceAuthenticator> deviceAuthenticator)
```
    Bind the device. Calling the bind function, the existing bounded keys will be removed. If don't want to replace or remove existing keys, please use FRUserKeys to check existing keys before calling this method
    
    Parameters:
    
    context - The Application Context
    
    deviceAuthenticator - A function to return a DeviceAuthenticator, deviceAuthenticatorIdentifier will be used if not provided
  - getCryptoKey
```
 CryptoKey getCryptoKey()
```

Class DeviceBindingCallback

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class org.forgerock.android.auth.callback.Binding

Methods inherited from class org.forgerock.android.auth.callback.AbstractCallback

Methods inherited from class java.lang.Object

Constructor Detail

DeviceBindingCallback

DeviceBindingCallback

Method Detail

getUserId

getUserName

getChallenge

getDeviceBindingAuthenticationType

getTitle

getSubtitle

getDescription

getTimeout

getAttestation

getType

setJws

setDeviceName

setDeviceId

setClientError

bind

bind

bind

getCryptoKey