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

Class TextInput

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

Compatible avec 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
`addEventAction(eventAction)`	`Widget`	Ajoute l'action d'événement qui peut être effectuée sur le widget.
`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'UI.
`setHint(hint)`	`TextInput`	Définit un indice pour la saisie de texte.
`setHostAppDataSource(hostAppDataSource)`	`TextInput`	Définit une source de données à partir des applications Google Workspace.
`setId(id)`	`Widget`	Définit l'ID unique attribué qui est utilisé pour identifier le widget à modifier.
`setInputMode(inputMode)`	`TextInput`	Indique si ce champ de saisie de texte accepte l'insertion de variables.
`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 récupérer les suggestions de saisie semi-automatique en fonction de la saisie de l'utilisateur.
`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.
`setVisibility(visibility)`	`Widget`	Définit la visibilité du widget.

Documentation détaillée

`addEventAction(eventAction)`

Ajoute l'action d'événement qui peut être effectuée sur le widget.

Paramètres

Nom	Type	Description
`eventAction`	`EventAction`	`EventAction` à ajouter.

Renvois

Widget : objet pour le chaînage.

`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'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 un indice pour la saisie de texte. Utilisé pour donner à l'utilisateur des conseils supplémentaires sur ce qu'il doit saisir. Par exemple, un indice 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`	Texte d'aide à afficher sous le champ de saisie. Ce texte est toujours visible.

Renvois

TextInput : cet objet, pour le chaînage.

`setHostAppDataSource(hostAppDataSource)`

Définit une source de données à partir des applications Google Workspace. Actuellement compatible avec les utilisateurs et les espaces Chat.

Uniquement disponible pour les modules complémentaires Google Workspace qui étendent Google Workspace Studio.

const workflowDataSource =
    CardService.newWorkflowDataSource().setIncludeVariables(true);

const hostAppDataSource =
    CardService.newHostAppDataSource().setWorkflowDataSource(workflowDataSource);

const textInput = CardService.newTextInput()
                      .setFieldName('text_input_form_input_key')
                      .setTitle('Text input title')
                      .setHint('Text input hint')
                      .setHostAppDataSource(hostAppDataSource);

Paramètres

Nom	Type	Description
`hostAppDataSource`	`HostAppDataSource`	Source de données.

Renvois

TextInput : cet objet, pour le chaînage.

`setId(id)`

Définit l'ID unique attribué qui est utilisé pour identifier le widget à modifier. La mutation de widget n'est disponible que dans les modules complémentaires.

Paramètres

Nom	Type	Description
`id`	`String`	ID du widget, limité à 64 caractères et au format `[a-zA-Z0-9-]+`.

Renvois

Widget : cet objet, pour le chaînage.

`setInputMode(inputMode)`

Indique si ce champ de saisie de texte accepte l'insertion de variables.

Uniquement disponible pour les modules complémentaires Google Workspace qui étendent Google Workspace Studio.

const textInput = CardService.newTextInput()
                      .setFieldName('text_input_form_input_key')
                      .setTitle('Text input title')
                      .setInputMode(CardService.TextInputMode.PLAIN_TEXT);

Paramètres

Nom	Type	Description
`inputMode`	`TextInputMode`	Type d'entrée autorisé pour ce champ de saisie de texte. Utilisez RICH_TEXT pour permettre l'insertion de variables.

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`	Ensemble de suggestions à utiliser.

Renvois

TextInput : cet objet, pour le chaînage.

`setSuggestionsAction(suggestionsAction)`

Définit l'action de rappel pour récupérer les suggestions en fonction de la saisie de l'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 récupère les 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 pour 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 l'entrée. 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.

`setVisibility(visibility)`

Définit la visibilité du widget. La valeur par défaut est "VISIBLE".

Paramètres

Nom	Type	Description
`visibility`	`Visibility`	Le `Visibility` du widget.

Renvois

Widget : objet pour le chaînage.

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

Méthodes

Documentation détaillée

addEventAction(eventAction)

Paramètres

Renvois

setFieldName(fieldName)

Paramètres

Renvois

setHint(hint)

Paramètres

Renvois

setHostAppDataSource(hostAppDataSource)

Paramètres

Renvois

setId(id)

Paramètres

Renvois

setInputMode(inputMode)

Paramètres

Renvois

setMultiline(multiline)

Paramètres

Renvois

setOnChangeAction(action)

Paramètres

Renvois

setSuggestions(suggestions)

Paramètres

Renvois

setSuggestionsAction(suggestionsAction)

Paramètres

Renvois

setTitle(title)

Paramètres

Renvois

setValidation(validation)

Paramètres

Renvois

setValue(value)

Paramètres

Renvois

setVisibility(visibility)

Paramètres

Renvois

Class TextInput

`addEventAction(eventAction)`

`setFieldName(fieldName)`

`setHint(hint)`

`setHostAppDataSource(hostAppDataSource)`

`setId(id)`

`setInputMode(inputMode)`

`setMultiline(multiline)`

`setOnChangeAction(action)`

`setSuggestions(suggestions)`

`setSuggestionsAction(suggestionsAction)`

`setTitle(title)`

`setValidation(validation)`

`setValue(value)`

`setVisibility(visibility)`