Skip to content

pin-authentication / io.matthewnelson.pin_authentication.service / PinAuthentication / Settings

Settings

class Settings (source)

PUBLIC methods to be utilized by the Application that’s implementing PinAuthentication for allowing Users the ability to modify various settings.

Constructors

Name Summary
<init> PUBLIC methods to be utilized by the Application that’s implementing PinAuthentication for allowing Users the ability to modify various settings.Settings()

Functions

Name Summary
enableHapticFeedback ENABLE/DISABLE haptic feedback on interactions with PinAuthenticationActivity.fun enableHapticFeedback(enable:Boolean):Unit
enablePinSecurity Starts the process for ENABLING/DISABLING pin security.fun enablePinSecurity(enable:Boolean):Unit
enableScrambledPin ENABLE/DISABLE scrambled pin for PinAuthenticationActivityfun enableScrambledPin(enable:Boolean):Unit
isHapticFeedbackEnabled Checks if haptic feedback is enabled.fun isHapticFeedbackEnabled():Boolean
isPinSecurityEnabled Checks if PIN security is enabled.fun isPinSecurityEnabled(): LiveData<Boolean>?
isScrambledPinEnabled Checks if scrambled pin is enabled.fun isScrambledPinEnabled():Boolean
resetColorsToApplicationDefaults Will clear currently applied colors and set them back to colors defined in the Application onCreate()’s initialization of PinAuthentication.Builder.OptionsBuilder.setCustomColors, if they were specified. Otherwise it will fall back to PinAuthentication‘s default colors.fun resetColorsToApplicationDefaults():Unit
resetPin Launches PinAuthenticationActivity in PAPinEntryState.RESET_PIN configuration for the user to reset their PIN.fun resetPin():Unit
setCustomColors Change the colors of PinAuthenticationActivity on the fly. These settings get saved to PinAuthentication‘s SharedPreferences and loaded at startup after custom colors that may have been specified in the Application onCreate()’s PinAuthentication.Builder.OptionsBuilder.setCustomColors.fun setCustomColors(): ColorsBuilder