Class TextInput

Restez organisé à l'aide des collections Enregistrez et classez les contenus selon vos préférences.
Saisie de texte

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éthodeType renvoyéBrève description
setFieldName(fieldName)TextInputDé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)TextInputDéfinit un indice pour la saisie de texte.
setMultiline(multiline)TextInputDétermine si le texte d'entrée s'affiche sur une ou plusieurs lignes.
setOnChangeAction(action)TextInputDéfinit une action à effectuer à chaque modification du texte saisi.
setSuggestions(suggestions)TextInputDéfinit les suggestions de saisie semi-automatique dans le champ de texte.
setSuggestionsAction(suggestionsAction)TextInputDéfinit l'action de rappel pour extraire les suggestions en fonction de l'entrée utilisateur pour la saisie semi-automatique.
setTitle(title)TextInputDéfinit le titre à afficher au-dessus du champ de saisie.
setValue(value)TextInputDé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

NomTypeDescription
fieldNameStringClé 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

NomTypeDescription
hintStringIndication 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

NomTypeDescription
multilineBooleanParamètre multiligne.

Aller-retour

TextInput : cet objet, pour le chaînage


setOnChangeAction(action)

Définit une action à effectuer à chaque modification du texte saisi.

Paramètres

NomTypeDescription
actionActionAction à effectuer.

Aller-retour

TextInput : cet objet, pour le chaînage


setSuggestions(suggestions)

Définit les suggestions de saisie semi-automatique dans le champ de texte.

Paramètres

NomTypeDescription
suggestionsSuggestionsEnsemble 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

NomTypeDescription
suggestionsActionActionAction 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

NomTypeDescription
titleStringLibellé 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

NomTypeDescription
valueStringValeur 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