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 complementos de Google Workspace y 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 una interacción con 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`	Configura la acción de devolución de llamada para obtener sugerencias basadas en las entradas del usuario para el autocompletado.
`setTitle(title)`	`TextInput`	Establece el título que se mostrará sobre el campo de entrada.
`setValue(value)`	`TextInput`	Establece el valor precompletado 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 con la IU. No 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.

Devolvedor

TextInput: Este objeto se usa para encadenar.

`setHint(hint)`

Establece una sugerencia para la entrada de texto. Se usa para brindar 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`	La sugerencia de texto que se mostrará debajo del campo de entrada. Este texto es siempre visible.

Devolvedor

TextInput: Este objeto se usa 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.

Devolvedor

TextInput: Este objeto se usa 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.

Devolvedor

TextInput: Este objeto se usa 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 pueden usar.

Devolvedor

TextInput: Este objeto se usa para encadenar.

`setSuggestionsAction(suggestionsAction)`

Configura la acción de devolución de llamada para obtener sugerencias basadas en las entradas del usuario para el autocompletado. 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.

Devolvedor

TextInput: Este objeto se usa 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.

Devolvedor

TextInput: Este objeto se usa para encadenar.

`setValue(value)`

Establece el valor precompletado 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 de forma.

Devolvedor

TextInput: Este objeto se usa para encadenar.