Added in API level 37.2

BiometricPromptStyleSpec

class BiometricPromptStyleSpec : Parcelable
kotlin.Any
   ↳ android.hardware.biometrics.BiometricPromptStyleSpec

A class that describes the visual styles of the embedded BiometricPrompt UI to allow client applications to maintain visual consistency. This includes background color, font family, dimensions, etc.

These style values are supplied by the system to the client application. The dimensional values (width, height, corner radius) are in pixels (px) and are scaled for the density of the display where the biometric prompt is displayed.

Summary

Inherited constants
Public constructors
BiometricPromptStyleSpec(backgroundColor: Int, width: Int, height: Int, cornerRadius: Int)
Public methods
Int

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
Boolean
equals(other: Any?)

Indicates whether some other object is "equal to" this one.
Int

Int

Int

Int

Int

Returns a hash code value for the object.
Unit
writeToParcel(dest: Parcel, flags: Int)

Flatten this object in to a Parcel.
Properties
static Parcelable.Creator<BiometricPromptStyleSpec!>

Public constructors

BiometricPromptStyleSpec

Added in API level 37.2
BiometricPromptStyleSpec(
    backgroundColor: Int, 
    width: Int, 
    height: Int, 
    cornerRadius: Int)
Parameters
backgroundColor Int: The background color for BiometricPrompt.
width Int: The total width of the prompt in pixels.
height Int: The total height of the prompt in pixels.
cornerRadius Int: The corner radius of the prompt in pixels.

Public methods

describeContents

Added in API level 37.2
fun describeContents(): Int

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of writeToParcel(Parcel,int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

Return
Int a bitmask indicating the set of special object types marshaled by this Parcelable object instance.
Value is either 0 or

equals

Added in API level 37.2
fun equals(other: Any?): Boolean

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
obj the reference object with which to compare.
Return
Boolean true if this object is the same as the obj argument; false otherwise.

getBackgroundColor

Added in API level 37.2
fun getBackgroundColor(): Int
Return
Int The background color for BiometricPrompt.

getCornerRadius

Added in API level 37.2
fun getCornerRadius(): Int
Return
Int The corner radius of the prompt in pixels.

getHeight

Added in API level 37.2
fun getHeight(): Int
Return
Int The total height of the prompt in pixels.

getWidth

Added in API level 37.2
fun getWidth(): Int
Return
Int The total width of the prompt in pixels.

hashCode

Added in API level 37.2
fun hashCode(): Int

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Return
Int a hash code value for this object.

writeToParcel

Added in API level 37.2
fun writeToParcel(
    dest: Parcel, 
    flags: Int
): Unit

Flatten this object in to a Parcel.

Parameters
dest Parcel: This value cannot be null.
flags Int: Additional flags about how the object should be written. May be 0 or PARCELABLE_WRITE_RETURN_VALUE.
Value is either 0 or a combination of the following:

Properties

CREATOR

Added in API level 37.2
static val CREATOR: Parcelable.Creator<BiometricPromptStyleSpec!>