Class TextInput

Input di testo

Un widget di campo di immissione che accetta input di testo.

Supporta la convalida dell'invio del modulo. Quando Action.setAllWidgetsAreRequired(allWidgetsAreRequired) è impostato su true o questo widget è specificato tramite Action.addRequiredWidget(requiredWidget), l'azione di invio viene bloccata a meno che non venga inserito un valore.

Disponibile per i componenti aggiuntivi di Google Workspace e le app Google Chat. 

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

Metodi

MetodoTipo restituitoBreve descrizione
setFieldName(fieldName)TextInputImposta la chiave che identifica questo input di testo nell'oggetto evento generato quando avviene un'interazione con l'interfaccia utente.
setHint(hint)TextInputImposta un suggerimento per l'input di testo.
setMultiline(multiline)TextInputImposta se il testo inserito deve essere visualizzato su una o più righe.
setOnChangeAction(action)TextInputImposta un'azione da eseguire ogni volta che l'input di testo cambia.
setSuggestions(suggestions)TextInputImposta i suggerimenti per il completamento automatico nel campo di testo.
setSuggestionsAction(suggestionsAction)TextInputImposta l'azione di callback per recuperare i suggerimenti in base all'input dell'utente per il completamento automatico.
setTitle(title)TextInputImposta il titolo da visualizzare sopra il campo di immissione.
setValidation(validation)TextInputImposta la regola di convalida per questo widget.
setValue(value)TextInputImposta il valore precompilato da impostare nel campo di immissione.

Documentazione dettagliata

setFieldName(fieldName)

Imposta la chiave che identifica questo input di testo nell'oggetto evento generato quando avviene un'interazione con l'interfaccia utente. Non visibile all'utente. Obbligatorio, deve essere univoco.

Parametri

NomeTipoDescrizione
fieldNameStringLa chiave utilizzata per identificare questo input.

Invio

TextInput: questo oggetto, per l'accodamento.

setHint(hint)

Imposta un suggerimento per l'input di testo. Viene utilizzato per fornire all'utente ulteriori indicazioni su cosa inserire. Ad esempio, un suggerimento potrebbe descrivere la formattazione ("xxx-xxx-xxxx") per un campo del numero di telefono.

Parametri

NomeTipoDescrizione
hintStringIl suggerimento di testo da visualizzare sotto il campo di immissione. Questo testo è sempre visibile.

Invio

TextInput: questo oggetto, per l'accodamento.

setMultiline(multiline)

Imposta se il testo inserito deve essere visualizzato su una o più righe.

Parametri

NomeTipoDescrizione
multilineBooleanL'impostazione multiriga.

Invio

TextInput: questo oggetto, per l'accodamento.

setOnChangeAction(action)

Imposta un'azione da eseguire ogni volta che l'input di testo cambia.

Parametri

NomeTipoDescrizione
actionActionL'azione da eseguire.

Invio

TextInput: questo oggetto, per l'accodamento.

setSuggestions(suggestions)

Imposta i suggerimenti per il completamento automatico nel campo di testo.

Parametri

NomeTipoDescrizione
suggestionsSuggestionsLa raccolta di suggerimenti da utilizzare.

Invio

TextInput: questo oggetto, per l'accodamento.

setSuggestionsAction(suggestionsAction)

Imposta l'azione di callback per recuperare i suggerimenti in base all'input dell'utente per il completamento automatico. Il parametro Action deve specificare una funzione di callback che restituisce un oggetto 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();
}

Parametri

NomeTipoDescrizione
suggestionsActionActionL'azione che recupera i suggerimenti per questo input.

Invio

TextInput: questo oggetto, per l'accodamento.

setTitle(title)

Imposta il titolo da visualizzare sopra il campo di immissione. Obbligatorio.

Parametri

NomeTipoDescrizione
titleStringL'etichetta di testo per questo input.

Invio

TextInput: questo oggetto, per l'accodamento.

setValidation(validation)

Imposta la regola di convalida per questo 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);

Parametri

NomeTipoDescrizione
validationValidationLa regola di convalida per questo widget TextInput.

Invio

TextInput: questo oggetto, per l'accodamento.

setValue(value)

Imposta il valore precompilato da impostare nel campo di immissione.

Parametri

NomeTipoDescrizione
valueStringIl valore predefinito inserito nell'input. Viene sempre rappresentato come stringa nei parametri di callback del modulo.

Invio

TextInput: questo oggetto, per l'accodamento.