Cette page a été traduite par l'API Cloud Translation.

Class TextInput

Widget de champ de saisie qui accepte la saisie de texte.

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
`setFieldName(fieldName)`	`TextInput`	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.
`setHint(hint)`	`TextInput`	Définit une suggestion pour la saisie de texte.
`setMultiline(multiline)`	`TextInput`	Indique si le texte saisi s'affiche sur une ou plusieurs lignes.
`setOnChangeAction(action)`	`TextInput`	Définit une action à effectuer chaque fois que le texte saisi change.
`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 des suggestions en fonction de la saisie utilisateur pour la saisie semi-automatique.
`setTitle(title)`	`TextInput`	Définit le titre à afficher au-dessus du champ de saisie.
`setValidation(validation)`	`TextInput`	Définit la règle de validation pour ce widget.
`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 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
`fieldName`	`String`	Clé utilisée pour identifier cette entrée.

Renvois

TextInput : cet objet, pour le chaînage.

`setHint(hint)`

Définit une suggestion 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

TextInput : cet objet, pour le chaînage.

`setMultiline(multiline)`

Indique si le texte saisi s'affiche sur une ou plusieurs lignes.

Paramètres

Nom	Type	Description
`multiline`	`Boolean`	Paramètre multiligne.

Renvois

TextInput : cet objet, pour le chaînage.

`setOnChangeAction(action)`

Définit une action à effectuer chaque fois que le texte saisi change.

Paramètres

Nom	Type	Description
`action`	`Action`	Action à effectuer.

Renvois

TextInput : cet objet, pour le chaînage.

`setSuggestions(suggestions)`

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

TextInput : cet objet, pour le chaînage.

`setSuggestionsAction(suggestionsAction)`

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 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();
}

Paramètres

Nom	Type	Description
`suggestionsAction`	`Action`	Action qui extrait des suggestions pour cette entrée.

Renvois

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é textuel de cette entrée.

Renvois

TextInput : cet objet, pour le chaînage.

`setValidation(validation)`

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

Renvois

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 la saisie. Il est toujours représenté sous forme de chaîne dans les paramètres de rappel du formulaire.

Renvois

TextInput : cet objet, pour le chaînage.