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

Class TextInput

Es un widget de campo de entrada que acepta entradas de texto.

Disponible para los complementos de Google Workspace y las apps de Google Chat.

const 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`	Establece la clave que identifica esta entrada de texto en el objeto de evento que se genera cuando hay 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 línea o en varias.
`setOnChangeAction(action)`	`TextInput`	Establece una acción que se realizará cada vez que cambie la entrada de texto.
`setSuggestions(suggestions)`	`TextInput`	Establece las sugerencias de autocompletado en el campo de texto.
`setSuggestionsAction(suggestionsAction)`	`TextInput`	Establece la acción de devolución de llamada para recuperar sugerencias según la entrada del usuario para el autocompletado.
`setTitle(title)`	`TextInput`	Establece el título que se mostrará sobre el campo de entrada.
`setValidation(validation)`	`TextInput`	Establece la regla de validación para este widget.
`setValue(value)`	`TextInput`	Establece el valor prepropagado que se establecerá en el campo de entrada.

Documentación detallada

`setFieldName(fieldName)`

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

Parámetros

Nombre	Tipo	Descripción
`fieldName`	`String`	Es 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 brindarle al usuario orientación adicional sobre qué ingresar. 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`	Es la sugerencia de texto que se mostrará debajo del campo de entrada. Este texto siempre está visible.

Volver

TextInput: Este objeto, para encadenar.

`setMultiline(multiline)`

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

Parámetros

Nombre	Tipo	Descripción
`multiline`	`Boolean`	El parámetro de configuración de varias líneas.

Volver

TextInput: Este objeto, para encadenar.

`setOnChangeAction(action)`

Establece una acción que se realizará cada vez que cambie 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`	Es la colección de sugerencias que se usarán.

Volver

TextInput: Este objeto, para encadenar.

`setSuggestionsAction(suggestionsAction)`

Establece la acción de devolución de llamada para recuperar sugerencias según la entrada del usuario para el autocompletado. El parámetro Action debe especificar una función de devolución de llamada que muestre un objeto SuggestionsResponse.

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

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

// ...

function suggestionCallback(e) {
  const suggestions = CardService.newSuggestions();
  const numSuggestions = Number.parseInt(e.parameter.numSuggestions);
  for (let i = 1; i <= numSuggestions; i++) {
    suggestions.addSuggestion(`Suggestion ${i}`);
  }
  return CardService.newSuggestionsResponseBuilder()
      .setSuggestions(suggestions)
      .build();
}

Parámetros

Nombre	Tipo	Descripción
`suggestionsAction`	`Action`	Es 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.

`setValidation(validation)`

Establece la regla de validación para este widget.

const validation = CardService.newValidation().setCharacterLimit('10').setType(
    CardService.InputType.TEXT);

const input = CardService.newTextInput()
                  .setFieldName('text_name_xxx1')
                  .setTitle('Max 10 characters')
                  .setValidation(validation);

Parámetros

Nombre	Tipo	Descripción
`validation`	`Validation`	Es la regla de validación de este widget `TextInput`.

Volver

TextInput: Este objeto, para encadenar.

`setValue(value)`

Establece el valor prepropagado que se establecerá en el campo de entrada.

Parámetros

Nombre	Tipo	Descripción
`value`	`String`	Es el valor predeterminado que se coloca en la entrada. Siempre se representa como una cadena en los parámetros de devolución de llamada del formulario.

Volver

TextInput: Este objeto, para encadenar.