Class TextInput

TextInput

Un widget del campo di immissione che accetta l'inserimento di testo.

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

var 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 si verifica un'interazione nell'interfaccia utente.
setHint(hint)TextInputImposta un suggerimento per l'input di testo.
setMultiline(multiline)TextInputConsente di impostare se il testo di input viene visualizzato su una o più righe.
setOnChangeAction(action)TextInputImposta un'azione da eseguire ogni volta che l'input di testo cambia.
setSuggestions(suggestions)TextInputConsente di impostare 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.
setValue(value)TextInputConsente di impostare 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 si verifica un'interazione nell'interfaccia utente. Non visibile all'utente. Obbligatorio, deve essere univoco.

Parametri

NomeTipoDescrizione
fieldNameStringLa chiave utilizzata per identificare questo input.

Ritorni

TextInput: questo oggetto per il concatenamento.


setHint(hint)

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

Parametri

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

Ritorni

TextInput: questo oggetto per il concatenamento.


setMultiline(multiline)

Consente di impostare se il testo di input viene visualizzato su una o più righe.

Parametri

NomeTipoDescrizione
multilineBooleanImpostazione multilinea.

Ritorni

TextInput: questo oggetto per il concatenamento.


setOnChangeAction(action)

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

Parametri

NomeTipoDescrizione
actionActionL'azione da eseguire.

Ritorni

TextInput: questo oggetto per il concatenamento.


setSuggestions(suggestions)

Consente di impostare i suggerimenti per il completamento automatico nel campo di testo.

Parametri

NomeTipoDescrizione
suggestionsSuggestionsLa raccolta di suggerimenti da utilizzare.

Ritorni

TextInput: questo oggetto per il concatenamento.


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.

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();
}

Parametri

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

Ritorni

TextInput: questo oggetto per il concatenamento.


setTitle(title)

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

Parametri

NomeTipoDescrizione
titleStringL'etichetta di testo per questo input.

Ritorni

TextInput: questo oggetto per il concatenamento.


setValue(value)

Consente di impostare il valore precompilato da impostare nel campo di immissione.

Parametri

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

Ritorni

TextInput: questo oggetto per il concatenamento.