public final class

InputSignInMethod.Builder

extends java.lang.Object

 java.lang.Object

↳androidx.car.app.model.signin.InputSignInMethod.Builder

Overview

A builder of InputSignInMethod.

Summary

Constructors
publicBuilder(InputCallback listener)

Returns an InputSignInMethod.Builder instance.

Methods
public InputSignInMethodbuild()

Builds an InputSignInMethod instance.

public InputSignInMethod.BuildersetDefaultValue(java.lang.String defaultValue)

Sets the default value for this input.

public InputSignInMethod.BuildersetErrorMessage(java.lang.CharSequence message)

Sets the error message associated with this input box.

public InputSignInMethod.BuildersetHint(java.lang.CharSequence hint)

Sets the text explaining to the user what should be entered in this input box.

public InputSignInMethod.BuildersetInputType(int inputType)

Sets the input type.

public InputSignInMethod.BuildersetKeyboardType(int keyboardType)

Sets the keyboard type to display when this input box gets focused.

public InputSignInMethod.BuildersetShowKeyboardByDefault(boolean showKeyboardByDefault)

Sets whether keyboard should be opened by default when this template is presented.

from java.lang.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructors

public Builder(InputCallback listener)

Returns an InputSignInMethod.Builder instance.

Note that the listener relates to UI events and will be executed on the main thread using .

Parameters:

listener: the InputCallbackDelegate to be notified of input events

Methods

public InputSignInMethod.Builder setHint(java.lang.CharSequence hint)

Sets the text explaining to the user what should be entered in this input box.

Unless set with this method, the sign-in method will not show any hint.

Spans are supported in the input string.

public InputSignInMethod.Builder setDefaultValue(java.lang.String defaultValue)

Sets the default value for this input.

Unless set with this method, the input box will not have a default value.

For InputSignInMethod.INPUT_TYPE_PASSWORD input types, in order to indicate that is not empty it is recommended to use a special value rather the actual credential. Any user input on a InputSignInMethod.INPUT_TYPE_PASSWORD input box will replace this default value instead of appending to it.

public InputSignInMethod.Builder setInputType(int inputType)

Sets the input type.

This must be one of InputSignInMethod.INPUT_TYPE_DEFAULT or InputSignInMethod.INPUT_TYPE_PASSWORD

If not set, InputSignInMethod.INPUT_TYPE_DEFAULT will be assumed.

public InputSignInMethod.Builder setErrorMessage(java.lang.CharSequence message)

Sets the error message associated with this input box.

For example, this can be used to indicate formatting errors, wrong username or password or any other problem related to the user input.

Requirements

Error messages can have only up to 2 lines of text, amd additional texts beyond the second line may be truncated.

Spans are not supported in the input string and will be ignored.

public InputSignInMethod.Builder setKeyboardType(int keyboardType)

Sets the keyboard type to display when this input box gets focused.

This must be one of InputSignInMethod.KEYBOARD_DEFAULT, InputSignInMethod.KEYBOARD_PHONE, InputSignInMethod.KEYBOARD_NUMBER, or InputSignInMethod.KEYBOARD_EMAIL. A host might fall back to InputSignInMethod.KEYBOARD_DEFAULT if they do not support a particular keyboard type. If not provided, InputSignInMethod.KEYBOARD_DEFAULT will be used.

public InputSignInMethod.Builder setShowKeyboardByDefault(boolean showKeyboardByDefault)

Sets whether keyboard should be opened by default when this template is presented. By default, keyboard will only be opened if the user focuses on the input box.

public InputSignInMethod build()

Builds an InputSignInMethod instance.