Class TextInput

TextInput

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

Admite la validación del envío de formularios. Cuando Action.setAllWidgetsAreRequired(allWidgetsAreRequired) se establece en true o este widget se especifica a través de Action.addRequiredWidget(requiredWidget), se bloquea la acción de envío, a menos que se ingrese un valor.

Está 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étodoTipo de datos que se muestraDescripción breve
setFieldName(fieldName)TextInputEstablece 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)TextInputEstablece una sugerencia para la entrada de texto.
setHostAppDataSource(hostAppDataSource)TextInputEstablece una fuente de datos de las aplicaciones de Google Workspace.
setMultiline(multiline)TextInputEstablece si el texto de entrada se muestra en una o varias líneas.
setOnChangeAction(action)TextInputEstablece una acción que se realizará cada vez que cambie la entrada de texto.
setSuggestions(suggestions)TextInputEstablece las sugerencias para el autocompletado en el campo de texto.
setSuggestionsAction(suggestionsAction)TextInputEstablece la acción de devolución de llamada para recuperar sugerencias basadas en la entrada del usuario para el autocompletado.
setTitle(title)TextInputEstablece el título que se mostrará sobre el campo de entrada.
setValidation(validation)TextInputEstablece la regla de validación para este widget.
setValue(value)TextInputEstablece 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 de la IU. No es visible para el usuario. Es obligatorio y debe ser único.

Parámetros

NombreTipoDescripción
fieldNameStringEs 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 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

NombreTipoDescripción
hintStringEs la sugerencia de texto que se mostrará debajo del campo de entrada. Este texto siempre está visible.

Volver

TextInput: Este objeto, para encadenar.

setHostAppDataSource(hostAppDataSource)

Establece una fuente de datos de las aplicaciones de Google Workspace. Actualmente, admite usuarios y espacios de Chat.

Solo está disponible a través del programa Gemini Alpha para los complementos de Google Workspace que extienden los flujos de Google Workspace. 

const workflowDataSource =
    CardService.newWorkflowDataSource().setIncludeVariables(true);

const hostAppDataSource =
    CardService.newHostAppDataSource().setWorkflowDataSource(workflowDataSource);

const textInput = CardService.newTextInput()
                      .setFieldName('text_input_form_input_key')
                      .setTitle('Text input title')
                      .setHint('Text input hint')
                      .setHostAppDataSource(hostAppDataSource);

Parámetros

NombreTipoDescripción
hostAppDataSourceHostAppDataSourceEs la fuente de datos.

Volver

TextInput: Este objeto, para encadenar.

setMultiline(multiline)

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

Parámetros

NombreTipoDescripción
multilineBooleanEs 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

NombreTipoDescripción
actionActionLa acción por realizar.

Volver

TextInput: Este objeto, para encadenar.

setSuggestions(suggestions)

Establece las sugerencias para el autocompletado en el campo de texto.

Parámetros

NombreTipoDescripción
suggestionsSuggestionsEs la colección de sugerencias que se pueden usar.

Volver

TextInput: Este objeto, para encadenar.

setSuggestionsAction(suggestionsAction)

Establece la acción de devolución de llamada para recuperar sugerencias basadas en 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

NombreTipoDescripción
suggestionsActionActionEs 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

NombreTipoDescripción
titleStringEs 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

NombreTipoDescripción
validationValidationEs la regla de validación para este widget de TextInput.

Volver

TextInput: Este objeto, para encadenar.

setValue(value)

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

Parámetros

NombreTipoDescripción
valueStringEs 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.