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

Class TextInput

Un widget de champ de saisie qui accepte la saisie de texte.

Disponible pour les modules complémentaires Google Workspace et les applications Google Chat.

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 d'événement généré lorsqu'une est 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 fois que la saisie de texte est modifiée.
`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 des saisies de l'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 à spécifier 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 d'événement généré lorsqu'une est une interaction avec l'interface utilisateur. 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 : objet utilisé pour le chaînage.

`setHint(hint)`

Définit un indice pour la saisie de texte. Permet de donner à l'utilisateur des conseils supplémentaires sur ce qu'il doit saisir. Pour Par exemple, un indice pourrait décrire le format ("xxx-xxx-xxxx") d'un champ de numéro de téléphone.

Paramètres

Nom	Type	Description
`hint`	`String`	Indice à afficher sous le champ de saisie. Ce texte est toujours visible.

Renvois

TextInput : objet utilisé 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.

Renvois

TextInput : objet utilisé pour le chaînage.

`setOnChangeAction(action)`

Définit une action à effectuer chaque fois que la saisie de texte est modifiée.

Paramètres

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

Renvois

TextInput : objet utilisé 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`	Ensemble de suggestions à utiliser.

Renvois

TextInput : objet utilisé pour le chaînage.

`setSuggestionsAction(suggestionsAction)`

Définit l'action de rappel pour extraire des suggestions en fonction des saisies de l'utilisateur pour la saisie semi-automatique. La 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 extrait des suggestions pour cette entrée.

Renvois

TextInput : objet utilisé 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 : objet utilisé pour le chaînage.

`setValue(value)`

Définit la valeur préremplie à spécifier dans le champ de saisie.

Paramètres

Nom	Type	Description
`value`	`String`	Valeur par défaut placée dans l'entrée. Il est toujours représenté sous forme de chaîne dans le les paramètres de rappel de formulaire.

Renvois

TextInput : objet utilisé pour le chaînage.