Widget de champ de saisie qui accepte la saisie de texte.
Prend en charge la validation de l'envoi de formulaires. Lorsque Action.setAllWidgetsAreRequired(allWidgetsAreRequired) est défini sur true ou que ce widget est spécifié via Action.addRequiredWidget(requiredWidget), l'action d'envoi est bloquée, sauf si une valeur est saisie.
Disponible pour les modules complémentaires Google Workspace et les applications Google Chat.
const textInput = CardService.newTextInput() .setFieldName('text_input_form_input_key') .setTitle('Text input title') .setHint('Text input hint');
Méthodes
| Méthode | Type renvoyé | Brève description |
|---|---|---|
set | Text | Définit la clé qui identifie cette saisie de texte dans l'objet d'événement généré en cas d'interaction avec l'UI. |
set | Text | Définit un indice pour la saisie de texte. |
set | Text | Indique si le texte saisi s'affiche sur une ou plusieurs lignes. |
set | Text | Définit une action à effectuer chaque fois que le texte saisi change. |
set | Text | Définit les suggestions de saisie semi-automatique dans le champ de texte. |
set | Text | Définit l'action de rappel pour extraire des suggestions en fonction de la saisie utilisateur pour la saisie semi-automatique. |
set | Text | Définit le titre à afficher au-dessus du champ de saisie. |
set | Text | Définit la règle de validation pour ce widget. |
set | Text | Définit la valeur préremplie à définir dans le champ de saisie. |
Documentation détaillée
set
Définit la clé qui identifie cette saisie de texte dans l'objet d'événement généré en cas d'interaction avec l'UI. Non visible par l'utilisateur. Obligatoire, doit être unique.
Paramètres
| Nom | Type | Description |
|---|---|---|
field | String | Clé utilisée pour identifier cette entrée. |
Renvois
Text : cet objet, pour le chaînage.
set
Définit un indice pour la saisie de texte. Permet d'indiquer à l'utilisateur ce qu'il doit saisir. Par exemple, une indication peut décrire la mise en forme ("xxx-xxx-xxxx") d'un champ de numéro de téléphone.
Paramètres
| Nom | Type | Description |
|---|---|---|
hint | String | Indice textuel à afficher sous le champ de saisie. Ce texte est toujours visible. |
Renvois
Text : cet objet, pour le chaînage.
set
Indique si le texte saisi s'affiche sur une ou plusieurs lignes.
Paramètres
| Nom | Type | Description |
|---|---|---|
multiline | Boolean | Paramètre multiligne. |
Renvois
Text : cet objet, pour le chaînage.
set
set
Définit les suggestions de saisie semi-automatique dans le champ de texte.
Paramètres
| Nom | Type | Description |
|---|---|---|
suggestions | Suggestions | Collection de suggestions à utiliser. |
Renvois
Text : cet objet, pour le chaînage.
set
Définit l'action de rappel pour extraire des suggestions en fonction de la saisie utilisateur pour la saisie semi-automatique. Le paramètre Action doit spécifier une fonction de rappel qui renvoie un objet 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(); }
Paramètres
| Nom | Type | Description |
|---|---|---|
suggestions | Action | Action qui extrait des suggestions pour cette entrée. |
Renvois
Text : cet objet, pour le chaînage.
set
Définit le titre à afficher au-dessus du champ de saisie. Obligatoire.
Paramètres
| Nom | Type | Description |
|---|---|---|
title | String | Libellé textuel de cette entrée. |
Renvois
Text : cet objet, pour le chaînage.
set
Définit la règle de validation pour ce 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);
Paramètres
| Nom | Type | Description |
|---|---|---|
validation | Validation | Règle de validation de ce widget Text. |
Renvois
Text : cet objet, pour le chaînage.
set
Définit la valeur préremplie à définir dans le champ de saisie.
Paramètres
| Nom | Type | Description |
|---|---|---|
value | String | Valeur par défaut placée dans la zone de saisie. Il est toujours représenté sous forme de chaîne dans les paramètres de rappel du formulaire. |
Renvois
Text : cet objet, pour le chaînage.