Class ListItem

ListItem

Élément de question qui permet au répondant de sélectionner un choix dans une liste déroulante. Les éléments peuvent être consultés ou créés à partir d'un Form. 

// Open a form by ID and add a new list item.
const form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz');
const item = form.addListItem();
item.setTitle('Do you prefer cats or dogs?').setChoices([
  item.createChoice('Cats'), item.createChoice('Dogs')
]);

Méthodes

MéthodeType renvoyéBrève description
createChoice(value)ChoiceCrée un choix.
createChoice(value, isCorrect)ChoiceCrée un choix.
createChoice(value, navigationItem)ChoiceCrée un choix avec une option de navigation sur les pages qui permet d'accéder à un élément de saut de page donné.
createChoice(value, navigationType)ChoiceCrée un choix avec une option de navigation sur les pages.
createResponse(response)ItemResponseCrée un ItemResponse pour cet élément de liste.
duplicate()ListItemCrée une copie de cet élément et l'ajoute à la fin du formulaire.
getChoices()Choice[]Récupère tous les choix pour un élément.
getFeedbackForCorrect()QuizFeedback|nullRenvoie les commentaires affichés aux participants lorsqu'ils répondent correctement à une question.
getFeedbackForIncorrect()QuizFeedback|nullRenvoie les commentaires affichés aux personnes interrogées lorsqu'elles répondent de manière incorrecte à une question.
getHelpText()StringObtient le texte d'aide de l'élément (parfois appelé texte de description pour les éléments de mise en page tels que ImageItems, PageBreakItems et SectionHeaderItems).
getId()IntegerObtient l'identifiant unique de l'élément.
getIndex()IntegerObtient l'index de l'élément parmi tous les éléments du formulaire.
getPoints()IntegerRenvoie la valeur en points d'un élément pouvant être noté.
getTitle()StringObtient le titre de l'élément (parfois appelé texte d'en-tête, dans le cas d'un SectionHeaderItem).
getType()ItemTypeObtient le type de l'élément, représenté sous la forme d'un ItemType.
isRequired()BooleanDétermine si la personne interrogée doit répondre à la question.
setChoiceValues(values)ListItemDéfinit les choix pour un élément à partir d'un tableau de chaînes.
setChoices(choices)ListItemDéfinit un tableau de choix pour un élément.
setFeedbackForCorrect(feedback)ListItemDéfinit les commentaires à afficher aux participants lorsqu'ils répondent correctement à une question.
setFeedbackForIncorrect(feedback)ListItemDéfinit les commentaires à afficher aux personnes interrogées lorsqu'elles répondent de manière incorrecte à une question.
setHelpText(text)ListItemDéfinit le texte d'aide de l'élément (parfois appelé texte de description pour les éléments de mise en page tels que ImageItems, PageBreakItems et SectionHeaderItems).
setPoints(points)ListItemDéfinit le nombre de points qu'un devoir peut rapporter.
setRequired(enabled)ListItemIndique si la personne interrogée doit répondre à la question.
setTitle(title)ListItemDéfinit le titre de l'élément (parfois appelé texte d'en-tête dans le cas d'un SectionHeaderItem).

Documentation détaillée

createChoice(value)

Crée un choix.

Paramètres

NomTypeDescription
valueStringla valeur du choix, que les répondants voient sous forme de libellé lorsqu'ils consultent le formulaire.

Renvois

Choice : le nouveau choix

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

createChoice(value, isCorrect)

Crée un choix.

Paramètres

NomTypeDescription
valueStringla valeur du choix, que les répondants voient sous forme de libellé lorsqu'ils consultent le formulaire.
isCorrectBooleansi le choix est une bonne réponse.

Renvois

Choice : le nouveau choix

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

createChoice(value, navigationItem)

Crée un choix avec une option de navigation sur les pages qui permet d'accéder à un élément de saut de page donné. Cela équivaut à createChoice(value, navigationType) avec navigationType défini sur FormApp.PageNavigationType.GO_TO_PAGE. Les choix qui utilisent la navigation sur les pages ne peuvent pas être combinés dans le même élément avec les choix qui n'utilisent pas la navigation sur les pages.

La navigation sur les pages a lieu une fois que le répondant a terminé une page contenant l'option, et uniquement s'il a choisi cette option. Si le répondant a choisi plusieurs options avec des instructions de navigation sur la même page, seule la dernière option de navigation a un effet. La navigation sur les pages n'a pas non plus d'effet sur la dernière page d'un formulaire.

Paramètres

NomTypeDescription
valueStringla valeur du choix, que les répondants voient sous forme de libellé lorsqu'ils consultent le formulaire.
navigationItemPageBreakIteml'élément vers lequel naviguer

Renvois

Choice : le nouveau choix

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

createChoice(value, navigationType)

Crée un choix avec une option de navigation sur les pages. Les choix qui utilisent la navigation sur les pages ne peuvent pas être combinés dans le même élément avec les choix qui n'utilisent pas la navigation sur les pages.

La navigation sur les pages a lieu une fois que le répondant a terminé une page contenant l'option, et uniquement s'il a choisi cette option. Si le répondant a choisi plusieurs options avec des instructions de navigation sur la même page, seule la dernière option de navigation a un effet. La navigation sur les pages n'a pas non plus d'effet sur la dernière page d'un formulaire.

Paramètres

NomTypeDescription
valueStringla valeur du choix, que les répondants voient sous forme de libellé lorsqu'ils consultent le formulaire.
navigationTypePageNavigationTypele type de navigation du choix ;

Renvois

Choice : le nouveau choix

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

createResponse(response)

Crée un ItemResponse pour cet élément de liste. Génère une exception si l'argument response ne correspond pas à un choix valide pour cet élément.

Paramètres

NomTypeDescription
responseStringune réponse valide pour cet élément de liste

Renvois

ItemResponse : réponse de l'élément

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

duplicate()

Crée une copie de cet élément et l'ajoute à la fin du formulaire.

Renvois

ListItem : double de ce ListItem, pour le chaînage

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

getChoices()

Récupère tous les choix pour un élément.

Renvois

Choice[] : un éventail de choix

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

getFeedbackForCorrect()

Renvoie les commentaires affichés aux participants lorsqu'ils répondent correctement à une question.

Renvois

QuizFeedback|null : commentaire, le cas échéant.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

getFeedbackForIncorrect()

Renvoie les commentaires affichés aux personnes interrogées lorsqu'elles répondent de manière incorrecte à une question.

Renvois

QuizFeedback|null : commentaire, le cas échéant.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

getHelpText()

Obtient le texte d'aide de l'élément (parfois appelé texte de description pour les éléments de mise en page tels que ImageItems, PageBreakItems et SectionHeaderItems).

Renvois

String : texte d'aide ou description de l'élément

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

getId()

Obtient l'identifiant unique de l'élément.

Renvois

Integer : ID de l'article

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

getIndex()

Obtient l'index de l'élément parmi tous les éléments du formulaire.

Renvois

Integer : index de l'élément

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

getPoints()

Renvoie la valeur en points d'un élément pouvant être noté.

Renvois

Integer : nombre de points attribués à une question.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

getTitle()

Obtient le titre de l'élément (parfois appelé texte d'en-tête, dans le cas d'un SectionHeaderItem).

Renvois

String : titre ou texte d'en-tête de l'élément

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

getType()

Obtient le type de l'élément, représenté sous la forme d'un ItemType.

Renvois

ItemType : type de l'élément

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

isRequired()

Détermine si la personne interrogée doit répondre à la question.

Renvois

Boolean : indique si le répondant doit répondre à la question.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

setChoiceValues(values)

Définit les choix pour un élément à partir d'un tableau de chaînes. Génère une exception si le tableau donné est vide. 

// Open a form by ID and add a new list item.
const form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz');
const item = form.addListItem();
item.setTitle('Do you prefer cats or dogs?');
item.setChoiceValues(['Dogs', 'Cats']);

Paramètres

NomTypeDescription
valuesString[]Tableau des valeurs de choix que les personnes interrogées voient sous forme de libellés lorsqu'elles consultent le formulaire

Renvois

ListItem : ListItem, pour le chaînage

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

setChoices(choices)

Définit un tableau de choix pour un élément. Génère une exception si le tableau donné est vide ou contient un élément null. 

// Open a form by ID and add a new list item.
const form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz');
const item = form.addListItem();
item.setTitle('Do you prefer cats or dogs?');
item.setChoices([item.createChoice('Cats'), item.createChoice('Dogs')]);

Paramètres

NomTypeDescription
choicesChoice[]un large éventail de choix

Renvois

ListItem : ListItem, pour le chaînage

Génère

Error : si le tableau donné est null, vide ou contient un élément null

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

setFeedbackForCorrect(feedback)

Définit les commentaires à afficher aux participants lorsqu'ils répondent correctement à une question. 

// Open a form by ID and add a new list item.
const form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz');
const item = form.addListItem();
item.setTitle('Do you prefer cats or dogs?');
// Set "Dogs" as the correct answer to this question.
item.setChoices([
  item.createChoice('Dogs', true),
  item.createChoice('Cats', false),
]);
// Add feedback which will be shown for correct responses; ie "Dogs".
item.setFeedbackForCorrect(
    FormApp.createFeedback().setDisplayText('Dogs rule, cats drool.').build(),
);

Paramètres

NomTypeDescription
feedbackQuizFeedbackles nouveaux commentaires. Une valeur nulle efface le commentaire.

Renvois

ListItem : ListItem, pour le chaînage

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

setFeedbackForIncorrect(feedback)

Définit les commentaires à afficher aux personnes interrogées lorsqu'elles répondent de manière incorrecte à une question.

Paramètres

NomTypeDescription
feedbackQuizFeedbackles nouveaux commentaires

Renvois

ListItem : ListItem, pour le chaînage

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

setHelpText(text)

Définit le texte d'aide de l'élément (parfois appelé texte de description pour les éléments de mise en page tels que ImageItems, PageBreakItems et SectionHeaderItems).

Paramètres

NomTypeDescription
textStringle nouveau texte d'aide ;

Renvois

ListItem : ListItem, pour le chaînage

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

setPoints(points)

Définit le nombre de points qu'un devoir peut rapporter. La valeur par défaut pour les nouveaux éléments est 0.

Paramètres

NomTypeDescription
pointsIntegerle nombre de points qu'un élément de question vaut ;

Renvois

ListItem : ListItem, pour le chaînage

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

setRequired(enabled)

Indique si la personne interrogée doit répondre à la question.

Paramètres

NomTypeDescription
enabledBooleansi la personne interrogée doit répondre à la question.

Renvois

ListItem : élément actuel (pour l'association en chaîne)

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

setTitle(title)

Définit le titre de l'élément (parfois appelé texte d'en-tête dans le cas d'un SectionHeaderItem).

Paramètres

NomTypeDescription
titleStringle nouveau titre ou le nouveau texte d'en-tête.

Renvois

ListItem : ListItem, pour le chaînage

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms