Se usó la API de Cloud Translation para traducir esta página.

Class TextInput

Un widget de campo de entrada que acepta entradas de texto.

var textInput = CardService.newTextInput()
    .setFieldName("text_input_form_input_key")
    .setTitle("Text input title")
    .setHint("Text input hint");

Métodos

Método	Tipo de datos que se muestra	Descripción breve
`setFieldName(fieldName)`	`TextInput`	Configura la clave que identifica esta entrada de texto en el objeto de evento que se genera cuando se produce una interacción de la IU.
`setHint(hint)`	`TextInput`	Establece una sugerencia para la entrada de texto.
`setMultiline(multiline)`	`TextInput`	Establece si el texto de entrada se muestra en una o varias líneas.
`setOnChangeAction(action)`	`TextInput`	Establece la acción que se debe realizar cada vez que cambia la entrada de texto.
`setSuggestions(suggestions)`	`TextInput`	Establece las sugerencias de autocompletado en el campo de texto.
`setSuggestionsAction(suggestionsAction)`	`TextInput`	Configura la acción de devolución de llamada para recuperar sugerencias basadas en entradas del usuario para autocompletar.
`setTitle(title)`	`TextInput`	Establece el título que se mostrará sobre el campo de entrada.
`setValue(value)`	`TextInput`	Establece el valor completado previamente que se establece en el campo de entrada.

Documentación detallada

`setFieldName(fieldName)`

Configura la clave que identifica esta entrada de texto en el objeto de evento que se genera cuando se produce una interacción de la IU. No es visible para el usuario. Obligatorio, debe ser único.

Parámetros

Nombre	Tipo	Descripción
`fieldName`	`String`	La clave que se usa para identificar esta entrada.

Volver

TextInput: Este objeto, para encadenar.

`setHint(hint)`

Establece una sugerencia para la entrada de texto. Se usa para brindar orientación adicional al usuario sobre qué entradas. Por ejemplo, una sugerencia podría describir el formato (&xxx-xxx-xxxx") para un campo de número de teléfono.

Parámetros

Nombre	Tipo	Descripción
`hint`	`String`	La sugerencia de texto que se mostrará cuando la entrada esté vacía.

Volver

TextInput: Este objeto, para encadenar.

`setMultiline(multiline)`

Establece si el texto de entrada se muestra en una o varias líneas.

Parámetros

Nombre	Tipo	Descripción
`multiline`	`Boolean`	La configuración de varias líneas.

Volver

TextInput: Este objeto, para encadenar.

`setOnChangeAction(action)`

Establece la acción que se debe realizar cada vez que cambia la entrada de texto.

Parámetros

Nombre	Tipo	Descripción
`action`	`Action`	La acción por realizar.

Volver

TextInput: Este objeto, para encadenar.

`setSuggestions(suggestions)`

Establece las sugerencias de autocompletado en el campo de texto.

Parámetros

Nombre	Tipo	Descripción
`suggestions`	`Suggestions`	El conjunto de sugerencias para usar.

Volver

TextInput: Este objeto, para encadenar.

`setSuggestionsAction(suggestionsAction)`

Configura la acción de devolución de llamada para recuperar sugerencias basadas en entradas del usuario para autocompletar. El parámetro Action debe especificar una función de devolución de llamada que muestre un objeto SuggestionsResponse.

var action = CardService.newAction()
    .setFunctionName('suggestionCallback')
    .setParameters({'numSuggestions': 3});

CardService.newTextInput()
    .setFieldName('option-field')
    .setTitle('Option Selected')
    .setSuggestionsAction(action);

// ...

function suggestionCallback(e) {
  var suggestions = CardService.newSuggestions();
  var numSuggestions = parseInt(e.parameter['numSuggestions']);
  for(var i = 1; i <= numSuggestions; i++) {
    suggestions.addSuggestion('Suggestion ' + i);
  }
  return CardService.newSuggestionsResponseBuilder()
      .setSuggestions(suggestions)
      .build();
}

Parámetros

Nombre	Tipo	Descripción
`suggestionsAction`	`Action`	La acción que recupera sugerencias para esta entrada.

Volver

TextInput: Este objeto, para encadenar.

`setTitle(title)`

Establece el título que se mostrará sobre el campo de entrada. Obligatorio.

Parámetros

Nombre	Tipo	Descripción
`title`	`String`	La etiqueta de texto para esta entrada.

Volver

TextInput: Este objeto, para encadenar.

`setValue(value)`

Establece el valor completado previamente que se establece en el campo de entrada.

Parámetros

Nombre	Tipo	Descripción
`value`	`String`	El valor predeterminado colocado en la entrada. Siempre se representa como una string en los parámetros de devolución de llamada del formulario.

Volver

TextInput: Este objeto, para encadenar.