InputSignInMethod

@RequiresCarApi(value = 2)
class InputSignInMethod : SignInTemplate.SignInMethod


A SignInTemplate.SignInMethod that presents an input box for the user to enter their credentials.

For example, this can be used to request a username, a password or an activation code.

Summary

Nested types

A builder of InputSignInMethod.

Constants

const Int

Default input where the text is shown as it is typed.

const Int

Input where the text is hidden as it is typed.

const Int

Default (full) keyboard.

const Int

Keyboard optimized for typing an email address.

const Int

Keyboard optimized for typing numbers.

const Int

Keyboard optimized for typing a phone number.

Public functions

Boolean
equals(other: Any!)
CarText?

Returns the default value for this input box or null if no value is provided.

CarText?

Returns an error message associated with the user input.

CarText?

Returns the text explaining to the user what should be entered in this input box or null if no hint is provided.

InputCallbackDelegate

Returns the InputCallbackDelegate for input callbacks.

Int

Returns the input type, one of INPUT_TYPE_DEFAULT or INPUT_TYPE_PASSWORD

Int

Returns the type of keyboard to be displayed when this input gets focused.

Int
Boolean

Returns whether to show the keyboard by default or not.

String

Constants

INPUT_TYPE_DEFAULT

Added in 1.0.0
const val INPUT_TYPE_DEFAULT = 1: Int

Default input where the text is shown as it is typed.

INPUT_TYPE_PASSWORD

Added in 1.0.0
const val INPUT_TYPE_PASSWORD = 2: Int

Input where the text is hidden as it is typed.

KEYBOARD_DEFAULT

Added in 1.0.0
const val KEYBOARD_DEFAULT = 1: Int

Default (full) keyboard.

KEYBOARD_EMAIL

Added in 1.0.0
const val KEYBOARD_EMAIL = 2: Int

Keyboard optimized for typing an email address.

KEYBOARD_NUMBER

Added in 1.0.0
const val KEYBOARD_NUMBER = 4: Int

Keyboard optimized for typing numbers.

KEYBOARD_PHONE

Added in 1.0.0
const val KEYBOARD_PHONE = 3: Int

Keyboard optimized for typing a phone number.

Public functions

equals

Added in 1.4.0-rc02
fun equals(other: Any!): Boolean

getDefaultValue

Added in 1.0.0
fun getDefaultValue(): CarText?

Returns the default value for this input box or null if no value is provided.

For the INPUT_TYPE_PASSWORD input type, this value will formatted to be hidden to the user as well.

See also
setDefaultValue

getErrorMessage

Added in 1.1.0
fun getErrorMessage(): CarText?

Returns an error message associated with the user input.

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

See also
setErrorMessage

getHint

Added in 1.1.0
fun getHint(): CarText?

Returns the text explaining to the user what should be entered in this input box or null if no hint is provided.

See also
setHint

getInputCallbackDelegate

Added in 1.1.0
fun getInputCallbackDelegate(): InputCallbackDelegate

Returns the InputCallbackDelegate for input callbacks.

See also
Builder

getInputType

Added in 1.0.0
fun getInputType(): Int

Returns the input type, one of INPUT_TYPE_DEFAULT or INPUT_TYPE_PASSWORD

getKeyboardType

Added in 1.0.0
fun getKeyboardType(): Int

Returns the type of keyboard to be displayed when this input gets focused.

See also
setKeyboardType

hashCode

Added in 1.4.0-rc02
fun hashCode(): Int

isShowKeyboardByDefault

Added in 1.0.0
fun isShowKeyboardByDefault(): Boolean

Returns whether to show the keyboard by default or not.

toString

Added in 1.4.0-rc02
fun toString(): String