Widget de saisie qui accepte le texte.
var 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 |
---|---|---|
setFieldName(fieldName) | TextInput | Définit la clé qui identifie cette entrée de texte dans l'objet événement généré lors d'une interaction avec l'interface utilisateur. |
setHint(hint) | TextInput | Définit un indice pour la saisie de texte. |
setMultiline(multiline) | TextInput | Détermine si le texte d'entrée s'affiche sur une ou plusieurs lignes. |
setOnChangeAction(action) | TextInput | Définit une action à effectuer à chaque modification du texte saisi. |
setSuggestions(suggestions) | TextInput | Définit les suggestions de saisie semi-automatique dans le champ de texte. |
setSuggestionsAction(suggestionsAction) | TextInput | Définit l'action de rappel pour extraire les suggestions en fonction de l'entrée utilisateur pour la saisie semi-automatique. |
setTitle(title) | TextInput | Définit le titre à afficher au-dessus du champ de saisie. |
setValue(value) | TextInput | Définit la valeur préremplie à définir dans le champ de saisie. |
Documentation détaillée
setFieldName(fieldName)
Définit la clé qui identifie cette entrée de texte dans l'objet événement généré lors d'une interaction avec l'interface utilisateur. Non visible par l'utilisateur. Obligatoire, il doit être unique.
Paramètres
Nom | Type | Description |
---|---|---|
fieldName | String | Clé utilisée pour identifier cette entrée. |
Aller-retour
TextInput
: cet objet, pour le chaînage
setHint(hint)
Définit un indice pour la saisie de texte. Permet de fournir à l'utilisateur des conseils supplémentaires sur les données à saisir. Par exemple, un indice pourrait 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 | Indication du texte à afficher lorsque l'entrée est vide. |
Aller-retour
TextInput
: cet objet, pour le chaînage
setMultiline(multiline)
Détermine si le texte d'entrée s'affiche sur une ou plusieurs lignes.
Paramètres
Nom | Type | Description |
---|---|---|
multiline | Boolean | Paramètre multiligne. |
Aller-retour
TextInput
: cet objet, pour le chaînage
setOnChangeAction(action)
setSuggestions(suggestions)
Définit les suggestions de saisie semi-automatique dans le champ de texte.
Paramètres
Nom | Type | Description |
---|---|---|
suggestions | Suggestions | Ensemble de suggestions à utiliser. |
Aller-retour
TextInput
: cet objet, pour le chaînage
setSuggestionsAction(suggestionsAction)
Définit l'action de rappel pour extraire les suggestions en fonction de l'entrée utilisateur pour la saisie semi-automatique. Le paramètre Action
doit spécifier une fonction de rappel qui renvoie un objet SuggestionsResponse
.
var action = CardService.newAction() .setFunctionName('suggestionCallback') .setParameters({'numSuggestions': 3}); CardService.newTextInput() .setFieldName('option-field') .setTitle('Option Selected') .setSuggestionsAction(action); // ... function suggestionCallback(e) { var suggestions = CardService.newSuggestions(); var numSuggestions = parseInt(e.parameter['numSuggestions']); for(var i = 1; i <= numSuggestions; i++) { suggestions.addSuggestion('Suggestion ' + i); } return CardService.newSuggestionsResponseBuilder() .setSuggestions(suggestions) .build(); }
Paramètres
Nom | Type | Description |
---|---|---|
suggestionsAction | Action | Action qui récupère les suggestions pour cette entrée. |
Aller-retour
TextInput
: cet objet, pour le chaînage
setTitle(title)
Définit le titre à afficher au-dessus du champ de saisie. Obligatoire.
Paramètres
Nom | Type | Description |
---|---|---|
title | String | Libellé du texte pour cette entrée. |
Aller-retour
TextInput
: cet objet, pour le chaînage
setValue(value)
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 l'entrée. Elle est toujours représentée par une chaîne dans les paramètres de rappel du formulaire. |
Aller-retour
TextInput
: cet objet, pour le chaînage