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

Está disponible para los complementos de Google Workspace y las apps de Google Chat.

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`	Establece la clave que identifica esta entrada de texto en el objeto de evento que se genera cuando hay es 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 en función de las entradas del usuario para el autocompletado.
`setTitle(title)`	`TextInput`	Configura el título que se mostrará sobre el campo de entrada.
`setValue(value)`	`TextInput`	Establece el valor completado previamente que se debe 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 es 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 el encadenamiento.

`setHint(hint)`

Establece una sugerencia para la entrada de texto. Se usa para brindar al usuario orientación adicional sobre qué ingresar. Para 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á debajo del campo de entrada. Este texto siempre está visible.

Volver

TextInput: Este objeto para el encadenamiento.

`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`	La configuración de varias líneas.

Volver

TextInput: Este objeto para el encadenamiento.

`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 el encadenamiento.

`setSuggestions(suggestions)`

Establece las sugerencias de autocompletado en el campo de texto.

Parámetros

Nombre	Tipo	Descripción
`suggestions`	`Suggestions`	La colección de sugerencias que se usarán.

Volver

TextInput: Este objeto para el encadenamiento.

`setSuggestionsAction(suggestionsAction)`

Establece la acción de devolución de llamada para recuperar sugerencias en función de las entradas del usuario para el autocompletado. El 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 el encadenamiento.

`setTitle(title)`

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

Parámetros

Nombre	Tipo	Descripción
`title`	`String`	Es la etiqueta de texto de esta entrada.

Volver

TextInput: Este objeto para el encadenamiento.

`setValue(value)`

Establece el valor completado previamente que se debe 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 el parámetros de devolución de llamada de formulario.

Volver

TextInput: Este objeto para el encadenamiento.