Class TextInput

Input Testo

Un widget campo di input che accetta input di testo.

Supporta la convalida dell'invio di moduli. 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
addEventAction(eventAction)WidgetAggiunge l'azione evento che può essere eseguita sul widget.
setFieldName(fieldName)TextInputImposta la chiave che identifica questo input di testo nell'oggetto evento generato quando si verifica un'interazione con la UI.
setHint(hint)TextInputImposta un suggerimento per l'input di testo.
setHostAppDataSource(hostAppDataSource)TextInputImposta un'origine dati dalle applicazioni Google Workspace.
setId(id)WidgetImposta l'ID univoco assegnato utilizzato per identificare il widget da modificare.
setInputMode(inputMode)TextInputSpecifica se questo campo di input di testo supporta l'inserimento di variabili.
setMultiline(multiline)TextInputImposta 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)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 mostrare sopra il campo di input.
setValidation(validation)TextInputImposta la regola di convalida per questo widget.
setValue(value)TextInputImposta il valore precompilato da inserire nel campo di immissione.
setVisibility(visibility)WidgetImposta la visibilità del widget.

Documentazione dettagliata

addEventAction(eventAction)

Aggiunge l'azione evento che può essere eseguita sul widget.

Parametri

NomeTipoDescrizione
eventActionEventActionEventAction da aggiungere.

Indietro

Widget: l'oggetto, per il concatenamento.


setFieldName(fieldName)

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

Parametri

NomeTipoDescrizione
fieldNameStringLa chiave utilizzata per identificare questo input.

Indietro

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") per un campo del numero di telefono.

Parametri

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

Indietro

TextInput: questo oggetto, per il concatenamento.


setHostAppDataSource(hostAppDataSource)

Imposta un'origine dati dalle applicazioni Google Workspace. Al momento supporta utenti e spazi di Chat.

Disponibile solo per i componenti aggiuntivi di Google Workspace che estendono Google Workspace Studio.

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

Parametri

NomeTipoDescrizione
hostAppDataSourceHostAppDataSourceL'origine dati.

Indietro

TextInput: questo oggetto, per il concatenamento.


setId(id)

Imposta l'ID univoco assegnato utilizzato per identificare il widget da modificare. La mutazione dei widget è supportata solo nei componenti aggiuntivi.

Parametri

NomeTipoDescrizione
idStringL'ID del widget, con un limite di 64 caratteri e nel formato `[a-zA-Z0-9-]+`.

Indietro

Widget: questo oggetto, per il concatenamento.


setInputMode(inputMode)

Specifica se questo campo di input di testo supporta l'inserimento di variabili.

Disponibile solo per i componenti aggiuntivi di Google Workspace che estendono Google Workspace Studio.

const textInput = CardService.newTextInput()
                      .setFieldName('text_input_form_input_key')
                      .setTitle('Text input title')
                      .setInputMode(CardService.TextInputMode.PLAIN_TEXT);

Parametri

NomeTipoDescrizione
inputModeTextInputModeIl tipo di input consentito per questo campo di input di testo. Utilizza RICH_TEXT per supportare l'inserimento di variabili.

Indietro

TextInput: questo oggetto, per il concatenamento.


setMultiline(multiline)

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

Parametri

NomeTipoDescrizione
multilineBooleanL'impostazione multiriga.

Indietro

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 intraprendere.

Indietro

TextInput: questo oggetto, per il concatenamento.


setSuggestions(suggestions)

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

Parametri

NomeTipoDescrizione
suggestionsSuggestionsLa raccolta di suggerimenti da utilizzare.

Indietro

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.

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.

Indietro

TextInput: questo oggetto, per il concatenamento.


setTitle(title)

Imposta il titolo da mostrare sopra il campo di input. Obbligatorio.

Parametri

NomeTipoDescrizione
titleStringL'etichetta di testo per questo input.

Indietro

TextInput: questo oggetto, per il concatenamento.


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.

Indietro

TextInput: questo oggetto, per il concatenamento.


setValue(value)

Imposta il valore precompilato da inserire nel campo di immissione.

Parametri

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

Indietro

TextInput: questo oggetto, per il concatenamento.


setVisibility(visibility)

Imposta la visibilità del widget. Il valore predefinito è "VISIBLE".

Parametri

NomeTipoDescrizione
visibilityVisibilityIl Visibility del widget.

Indietro

Widget: l'oggetto, per il concatenamento.