PromptVerticalListContentView


public final class PromptVerticalListContentView
extends Object implements PromptContentView, Parcelable

java.lang.Object
   ↳ android.hardware.biometrics.PromptVerticalListContentView


Contains the information of the template of vertical list content view for Biometric Prompt.

Here's how you'd set a PromptVerticalListContentView on a Biometric Prompt:

 BiometricPrompt biometricPrompt = new BiometricPrompt.Builder(...)
     .setTitle(...)
     .setSubTitle(...)
     .setContentView(new PromptVerticalListContentView.Builder()
         .setDescription("test description")
         .addListItem(new PromptContentItemPlainText("test item 1"))
         .addListItem(new PromptContentItemPlainText("test item 2"))
         .addListItem(new PromptContentItemBulletedText("test item 3"))
         .build())
     .build();
 

Summary

Nested classes

class PromptVerticalListContentView.Builder

A builder that collects arguments to be shown on the vertical list view. 

Inherited constants

Fields

public static final Creator<PromptVerticalListContentView> CREATOR

Public methods

int describeContents()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.

String getDescription()

Gets the description for the content view, as set by PromptVerticalListContentView.Builder#setDescription(String).

List<PromptContentItem> getListItems()

Gets the list of items on the content view, as set by PromptVerticalListContentView.Builder#addListItem(PromptContentItem).

static int getMaxEachItemCharacterNumber()

Returns the maximum number of characters allowed for each item's text.

static int getMaxItemCount()

Returns the maximum count of the list items.

void writeToParcel(Parcel dest, int flags)

Flatten this object in to a Parcel.

Inherited methods

Fields

CREATOR

Added in API level 35
public static final Creator<PromptVerticalListContentView> CREATOR

See also:

Public methods

describeContents

Added in API level 35
public int describeContents ()

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(android.os.Parcel, int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

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

getDescription

Added in API level 35
public String getDescription ()

Gets the description for the content view, as set by PromptVerticalListContentView.Builder#setDescription(String).

Returns
String The description for the content view, or null if the content view has no description.

getListItems

Added in API level 35
public List<PromptContentItem> getListItems ()

Gets the list of items on the content view, as set by PromptVerticalListContentView.Builder#addListItem(PromptContentItem).

Returns
List<PromptContentItem> The item list on the content view. This value cannot be null.

getMaxEachItemCharacterNumber

Added in API level 35
public static int getMaxEachItemCharacterNumber ()

Returns the maximum number of characters allowed for each item's text.

Returns
int

getMaxItemCount

Added in API level 35
public static int getMaxItemCount ()

Returns the maximum count of the list items.

Returns
int

writeToParcel

Added in API level 35
public void writeToParcel (Parcel dest, 
                int flags)

Flatten this object in to a Parcel.

Parameters
dest Parcel: The Parcel in which the object should be written. This value cannot be null.

flags int: Additional flags about how the object should be written. May be 0 or Parcelable.PARCELABLE_WRITE_RETURN_VALUE. Value is either 0 or a combination of Parcelable.PARCELABLE_WRITE_RETURN_VALUE, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES