Questa pagina è stata tradotta dall'API Cloud Translation.

Class TextInput

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

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

Metodo	Tipo restituito	Breve descrizione
`setFieldName(fieldName)`	`TextInput`	Imposta la chiave che identifica questo input di testo nell'oggetto evento generato in caso di interazione nell'interfaccia utente.
`setHint(hint)`	`TextInput`	Imposta un suggerimento per l'input di testo.
`setMultiline(multiline)`	`TextInput`	Imposta se il testo inserito deve essere visualizzato su una o più righe.
`setOnChangeAction(action)`	`TextInput`	Imposta un'azione da eseguire ogni volta che l'input di testo cambia.
`setSuggestions(suggestions)`	`TextInput`	Imposta i suggerimenti per il completamento automatico nel campo di testo.
`setSuggestionsAction(suggestionsAction)`	`TextInput`	Imposta l'azione di callback per recuperare i suggerimenti in base all'input dell'utente per il completamento automatico.
`setTitle(title)`	`TextInput`	Imposta il titolo da visualizzare sopra il campo di immissione.
`setValidation(validation)`	`TextInput`	Imposta la regola di convalida per questo widget.
`setValue(value)`	`TextInput`	Imposta 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 in caso di interazione nell'interfaccia utente. Non visibile all'utente. Obbligatorio, deve essere univoco.

Parametri

Nome	Tipo	Descrizione
`fieldName`	`String`	La chiave utilizzata per identificare questo input.

Invio

TextInput: questo oggetto, per l'accodamento.

`setHint(hint)`

Imposta un suggerimento per l'input di testo. Utilizzato per offrire 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

Nome	Tipo	Descrizione
`hint`	`String`	Il 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

Nome	Tipo	Descrizione
`multiline`	`Boolean`	L'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

Nome	Tipo	Descrizione
`action`	`Action`	L'azione da intraprendere.

Invio

TextInput: questo oggetto, per l'accodamento.

`setSuggestions(suggestions)`

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

Parametri

Nome	Tipo	Descrizione
`suggestions`	`Suggestions`	La 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 restituisca 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

Nome	Tipo	Descrizione
`suggestionsAction`	`Action`	L'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

Nome	Tipo	Descrizione
`title`	`String`	L'etichetta di testo per questo input.

Invio

TextInput: oggetto per il collegamento.

`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

Nome	Tipo	Descrizione
`validation`	`Validation`	La 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

Nome	Tipo	Descrizione
`value`	`String`	Il valore predefinito inserito nell'input. Viene sempre rappresentato come stringa nei parametri di callback del modulo.

Invio

TextInput: questo oggetto, per l'accodamento.