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
| Metodo | Tipo restituito | Breve descrizione |
|---|---|---|
add | Widget | Aggiunge l'azione evento che può essere eseguita sul widget. |
set | Text | Imposta la chiave che identifica questo input di testo nell'oggetto evento generato quando si verifica un'interazione con la UI. |
set | Text | Imposta un suggerimento per l'input di testo. |
set | Text | Imposta un'origine dati dalle applicazioni Google Workspace. |
set | Widget | Imposta l'ID univoco assegnato utilizzato per identificare il widget da modificare. |
set | Text | Specifica se questo campo di input di testo supporta l'inserimento di variabili. |
set | Text | Imposta se il testo di input viene visualizzato su una o più righe. |
set | Text | Imposta un'azione da eseguire ogni volta che l'input di testo cambia. |
set | Text | Imposta i suggerimenti per il completamento automatico nel campo di testo. |
set | Text | Imposta l'azione di callback per recuperare i suggerimenti in base all'input dell'utente per il completamento automatico. |
set | Text | Imposta il titolo da mostrare sopra il campo di input. |
set | Text | Imposta la regola di convalida per questo widget. |
set | Text | Imposta il valore precompilato da inserire nel campo di immissione. |
set | Widget | Imposta la visibilità del widget. |
Documentazione dettagliata
add Event Action(eventAction)
Aggiunge l'azione evento che può essere eseguita sul widget.
Parametri
| Nome | Tipo | Descrizione |
|---|---|---|
event | Event | Event da aggiungere. |
Indietro
Widget: l'oggetto, per il concatenamento.
set Field Name(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 |
|---|---|---|
field | String | La chiave utilizzata per identificare questo input. |
Indietro
Text: questo oggetto, per il concatenamento.
set Hint(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 input. Questo testo è sempre visibile. |
Indietro
Text: questo oggetto, per il concatenamento.
set Host App Data Source(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 |
|---|---|---|
host | Host | L'origine dati. |
Indietro
Text: questo oggetto, per il concatenamento.
set Id(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.
set Input Mode(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
| Nome | Tipo | Descrizione |
|---|---|---|
input | Text | Il tipo di input consentito per questo campo di input di testo. Utilizza RICH_TEXT per supportare l'inserimento di variabili. |
Indietro
Text: questo oggetto, per il concatenamento.
set Multiline(multiline)
Imposta se il testo di input viene visualizzato su una o più righe.
Parametri
| Nome | Tipo | Descrizione |
|---|---|---|
multiline | Boolean | L'impostazione multiriga. |
Indietro
Text: questo oggetto, per il concatenamento.
set On Change Action(action)
set Suggestions(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
Text: questo oggetto, per il concatenamento.
set Suggestions Action(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 Suggestions.
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 |
|---|---|---|
suggestions | Action | L'azione che recupera i suggerimenti per questo input. |
Indietro
Text: questo oggetto, per il concatenamento.
set Title(title)
Imposta il titolo da mostrare sopra il campo di input. Obbligatorio.
Parametri
| Nome | Tipo | Descrizione |
|---|---|---|
title | String | L'etichetta di testo per questo input. |
Indietro
Text: questo oggetto, per il concatenamento.
set Validation(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 Text. |
Indietro
Text: questo oggetto, per il concatenamento.
set Value(value)
Imposta il valore precompilato da inserire nel campo di immissione.
Parametri
| Nome | Tipo | Descrizione |
|---|---|---|
value | String | Il valore predefinito inserito nell'input. È sempre rappresentato come stringa nei parametri di callback del modulo. |
Indietro
Text: questo oggetto, per il concatenamento.
set Visibility(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.