Class TextInput

Un widget campo di immissione che accetta l'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

Metodo	Tipo restituito	Breve descrizione
`addEventAction(eventAction)`	`Widget`	Aggiunge l'azione evento che può essere eseguita sul widget.
`setFieldName(fieldName)`	`TextInput`	Imposta la chiave che identifica questo input di testo nell'oggetto evento generato quando si verifica un'interazione con la UI.
`setHint(hint)`	`TextInput`	Imposta un suggerimento per l'input di testo.
`setHostAppDataSource(hostAppDataSource)`	`TextInput`	Imposta un'origine dati dalle applicazioni Google Workspace.
`setId(id)`	`Widget`	Imposta l'ID univoco assegnato utilizzato per identificare il widget da modificare.
`setInputMode(inputMode)`	`TextInput`	Specifica se questo campo di immissione di testo supporta l'inserimento di variabili.
`setMultiline(multiline)`	`TextInput`	Imposta se il testo di input viene 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 mostrare 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.
`setVisibility(visibility)`	`Widget`	Imposta la visibilità del widget.

Documentazione dettagliata

`addEventAction(eventAction)`

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

Parametri

Nome	Tipo	Descrizione
`eventAction`	`EventAction`	`EventAction` 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

Nome	Tipo	Descrizione
`fieldName`	`String`	La 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

Nome	Tipo	Descrizione
`hint`	`String`	Il suggerimento di testo da visualizzare sotto il campo di immissione. 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

Nome	Tipo	Descrizione
`hostAppDataSource`	`HostAppDataSource`	L'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

Nome	Tipo	Descrizione
`id`	`String`	L'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 immissione 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

Nome	Tipo	Descrizione
`inputMode`	`TextInputMode`	Il tipo di input consentito per questo campo di immissione 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

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

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

Indietro

TextInput: questo oggetto, per il concatenamento.

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

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

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

Parametri

Nome	Tipo	Descrizione
`title`	`String`	L'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

Nome	Tipo	Descrizione
`validation`	`Validation`	La regola di convalida per questo widget `TextInput`.

Indietro

TextInput: questo oggetto, per il concatenamento.

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

Indietro

TextInput: questo oggetto, per il concatenamento.

`setVisibility(visibility)`

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

Parametri

Nome	Tipo	Descrizione
`visibility`	`Visibility`	Il `Visibility` del widget.

Indietro

Widget: l'oggetto, per il concatenamento.

Class TextInput Mantieni tutto organizzato con le raccolte Salva e classifica i contenuti in base alle tue preferenze.

Metodi

Documentazione dettagliata

addEventAction(eventAction)

Parametri

Indietro

setFieldName(fieldName)

Parametri

Indietro

setHint(hint)

Parametri

Indietro

setHostAppDataSource(hostAppDataSource)

Parametri

Indietro

setId(id)

Parametri

Indietro

setInputMode(inputMode)

Parametri

Indietro

setMultiline(multiline)

Parametri

Indietro

setOnChangeAction(action)

Parametri

Indietro

setSuggestions(suggestions)

Parametri

Indietro

setSuggestionsAction(suggestionsAction)

Parametri

Indietro

setTitle(title)

Parametri

Indietro

setValidation(validation)

Parametri

Indietro

setValue(value)

Parametri

Indietro

setVisibility(visibility)

Parametri

Indietro

Class TextInput

`addEventAction(eventAction)`

`setFieldName(fieldName)`

`setHint(hint)`

`setHostAppDataSource(hostAppDataSource)`

`setId(id)`

`setInputMode(inputMode)`

`setMultiline(multiline)`

`setOnChangeAction(action)`

`setSuggestions(suggestions)`

`setSuggestionsAction(suggestionsAction)`

`setTitle(title)`

`setValidation(validation)`

`setValue(value)`

`setVisibility(visibility)`