Forms Service

Forms

Ce service permet aux scripts de créer des formulaires Google Forms, d'y accéder et de les modifier.

// Create a new form, then add a checkbox question, a multiple choice question,
// a page break, then a date question and a grid of questions.
var form = FormApp.create('New Form');
var item = form.addCheckboxItem();
item.setTitle('What condiments would you like on your hot dog?');
item.setChoices([
        item.createChoice('Ketchup'),
        item.createChoice('Mustard'),
        item.createChoice('Relish')
    ]);
form.addMultipleChoiceItem()
    .setTitle('Do you prefer cats or dogs?')
    .setChoiceValues(['Cats','Dogs'])
    .showOtherOption(true);
form.addPageBreakItem()
    .setTitle('Getting to know you');
form.addDateItem()
    .setTitle('When were you born?');
form.addGridItem()
    .setTitle('Rate your interests')
    .setRows(['Cars', 'Computers', 'Celebrities'])
    .setColumns(['Boring', 'So-so', 'Interesting']);
Logger.log('Published URL: ' + form.getPublishedUrl());
Logger.log('Editor URL: ' + form.getEditUrl());

Classes

NomBrève description
AlignmentÉnumération représentant les types d'alignement d'image acceptés.
CheckboxGridItemQuestion, présentée sous la forme d'une grille de colonnes et de lignes, qui permet à la personne interrogée de sélectionner plusieurs choix par ligne à partir d'une séquence de cases à cocher.
CheckboxGridValidationUne DataValidation pour un CheckboxGridItem.
CheckboxGridValidationBuilderUn DataValidationBuilder pour un CheckboxGridValidation.
CheckboxItemQuestion permettant à la personne interrogée de cocher une ou plusieurs cases, ainsi qu'un champ "Autre" facultatif.
CheckboxValidationUne DataValidation pour un CheckboxItem.
CheckboxValidationBuilderUn DataValidationBuilder pour un CheckboxValidation.
ChoiceChoix unique associé à un type de Item acceptant des options telles que CheckboxItem, ListItem ou MultipleChoiceItem.
DateItemQuestion qui permet à la personne interrogée d'indiquer une date.
DateTimeItemQuestion qui permet à la personne interrogée d'indiquer une date et une heure.
DestinationTypeÉnumération représentant les types de destinations de formulaire-réponse acceptés.
DurationItemQuestion qui permet à la personne interrogée d’indiquer un certain temps.
FeedbackTypeÉnumération représentant les types de commentaires acceptés.
FormFormulaire contenant les propriétés et éléments généraux.
FormAppAutorise un script à ouvrir un Form existant ou à en créer un.
FormResponseRéponse au formulaire dans son ensemble.
GridItemQuestion, présentée sous la forme d'une grille de colonnes et de lignes, qui permet à la personne interrogée de sélectionner un choix par ligne à partir d'une séquence de cases d'option.
GridValidationUne DataValidation pour un GridItem.
GridValidationBuilderUn DataValidationBuilder pour un GridValidation.
ImageItemÉlément de mise en page qui affiche une image.
ItemÉlément de formulaire générique contenant des propriétés communes à tous les éléments, comme le titre et le texte d'aide.
ItemResponseRéponse à une question dans un formulaire.
ItemTypeÉnumération représentant les types d'éléments de formulaire acceptés.
ListItemQuestion qui permet à la personne interrogée de sélectionner une réponse dans une liste déroulante.
MultipleChoiceItemQuestion qui permet à la personne interrogée de sélectionner une option parmi une liste de cases d'option ou un champ facultatif "Autre".
PageBreakItemÉlément de mise en page qui marque le début d'une page.
PageNavigationTypeÉnumération représentant les types de navigation sur les pages compatibles.
ParagraphTextItemQuestion qui permet à la personne interrogée de saisir un bloc de texte.
ParagraphTextValidationUne DataValidation pour un ParagraphTextItem.
ParagraphTextValidationBuilderUn DataValidationBuilder pour un ParagraphTextValidation.
QuizFeedbackL'implémentation en bean d'un commentaire, qui contient des propriétés communes à tous les commentaires, telles que l'affichage de texte ou de liens.
QuizFeedbackBuilderLe FeedbackBuilder de base qui contient des setters pour les propriétés communes à tous les commentaires, comme le texte d'affichage.
ScaleItemQuestion qui permet à la personne interrogée de choisir une option parmi une séquence numérotée de cases d'option
SectionHeaderItemÉlément de mise en page qui indique visuellement le début d'une section.
TextItemQuestion qui permet à la personne interrogée de saisir une seule ligne de texte.
TextValidationUne DataValidation pour un TextItem.
TextValidationBuilderUn DataValidationBuilder pour un TextValidation.
TimeItemQuestion qui permet à la personne interrogée d'indiquer une heure de la journée.
VideoItemÉlément de mise en page qui affiche une vidéo.

Alignment

Propriétés

PropriétéTypeDescription
LEFTEnumAlignez l'image sur le côté gauche du formulaire.
CENTEREnumAlignez l'image par rapport au centre du formulaire.
RIGHTEnumAlignez l'image sur le côté droit du formulaire.

CheckboxGridItem

Méthodes

MéthodeType renvoyéBrève description
clearValidation()CheckboxGridItemSupprime toute validation des données pour cet élément de grille.
createResponse(responses)ItemResponseCrée un ItemResponse pour cet élément de grille de type case à cocher.
duplicate()CheckboxGridItemCrée une copie de cet élément et l'ajoute à la fin du formulaire.
getColumns()String[]Récupère les valeurs de chaque colonne de la grille.
getHelpText()StringRécupère 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()IntegerRécupère l'identifiant unique de l'article.
getIndex()IntegerRécupère l'index de l'élément parmi tous les éléments du formulaire.
getRows()String[]Récupère les valeurs de chaque ligne de la grille.
getTitle()StringRécupère le titre de l'élément (parfois appelé texte d'en-tête, dans le cas d'une SectionHeaderItem).
getType()ItemTypeRécupère le type de l'élément, représenté par ItemType.
isRequired()BooleanDétermine si la personne interrogée doit répondre à la question.
setColumns(columns)CheckboxGridItemDéfinit les colonnes de la grille en fonction d'un tableau de valeurs.
setHelpText(text)CheckboxGridItemDé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).
setRequired(enabled)CheckboxGridItemDétermine si la personne interrogée doit répondre à la question.
setRows(rows)CheckboxGridItemDéfinit les lignes de la grille en fonction d'un tableau de valeurs.
setTitle(title)CheckboxGridItemDéfinit le titre de l'élément (parfois appelé texte d'en-tête, dans le cas d'une SectionHeaderItem).
setValidation(validation)CheckboxGridItemDéfinit la validation des données pour cet élément de grille de type case à cocher.

CheckboxGridValidation

CheckboxGridValidationBuilder

Méthodes

MéthodeType renvoyéBrève description
requireLimitOneResponsePerColumn()CheckboxGridValidationBuilderNécessite une seule réponse par colonne pour un élément de grille.

CheckboxItem

Méthodes

MéthodeType renvoyéBrève description
clearValidation()CheckboxItemSupprime toute validation des données pour cet élément de case à cocher.
createChoice(value)ChoiceCrée un choix.
createChoice(value, isCorrect)ChoiceCrée un choix.
createResponse(responses)ItemResponseCrée un ItemResponse pour cet élément de case à cocher.
duplicate()CheckboxItemCré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()QuizFeedbackRenvoie les commentaires qui sont présentés aux personnes interrogées lorsqu'elles répondent correctement à une question.
getFeedbackForIncorrect()QuizFeedbackRenvoie les commentaires qui sont présentés aux personnes interrogées lorsqu'elles répondent de manière incorrecte à une question.
getHelpText()StringRécupère 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()IntegerRécupère l'identifiant unique de l'article.
getIndex()IntegerRécupère l'index de l'élément parmi tous les éléments du formulaire.
getPoints()IntegerRenvoie le barème de notation d'un élément pouvant être noté.
getTitle()StringRécupère le titre de l'élément (parfois appelé texte d'en-tête, dans le cas d'une SectionHeaderItem).
getType()ItemTypeRécupère le type de l'élément, représenté par ItemType.
hasOtherOption()BooleanDétermine si l'élément comporte une option "autre".
isRequired()BooleanDétermine si la personne interrogée doit répondre à la question.
setChoiceValues(values)CheckboxItemDéfinit les choix pour un élément à partir d'un tableau de chaînes.
setChoices(choices)CheckboxItemDéfinit un tableau d'options pour un article.
setFeedbackForCorrect(feedback)CheckboxItemDéfinit les commentaires à présenter aux personnes interrogées lorsqu'elles répondent correctement à une question.
setFeedbackForIncorrect(feedback)CheckboxItemDéfinit les commentaires à présenter aux personnes interrogées lorsqu'elles répondent de manière incorrecte à une question.
setHelpText(text)CheckboxItemDé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)CheckboxItemDéfinit le nombre de points attribués à un élément pouvant être noté.
setRequired(enabled)CheckboxItemDétermine si la personne interrogée doit répondre à la question.
setTitle(title)CheckboxItemDéfinit le titre de l'élément (parfois appelé texte d'en-tête, dans le cas d'une SectionHeaderItem).
setValidation(validation)CheckboxItemDéfinit la validation des données pour cet élément de case à cocher.
showOtherOption(enabled)CheckboxItemDétermine si l'élément comporte une option "Autre".

CheckboxValidation

CheckboxValidationBuilder

Méthodes

MéthodeType renvoyéBrève description
requireSelectAtLeast(number)CheckboxValidationBuilderVous devez sélectionner au moins autant de choix.
requireSelectAtMost(number)CheckboxValidationBuilderNombre maximal de choix requis pour la sélection.
requireSelectExactly(number)CheckboxValidationBuilderExiger exactement ce nombre de choix pour être sélectionné.

Choice

Méthodes

MéthodeType renvoyéBrève description
getGotoPage()PageBreakItemRécupère la PageBreakItem définie comme destination GO_TO_PAGE si le répondant sélectionne ce choix et termine la page actuelle.
getPageNavigationType()PageNavigationTypeRécupère la PageNavigationType qui se produit si la personne interrogée sélectionne cette option et termine la page actuelle.
getValue()StringRécupère la valeur du choix, que les répondants voient sous forme de libellé lorsqu'ils consultent le formulaire.
isCorrectAnswer()BooleanDétermine si le choix est une bonne réponse à la question.

DateItem

Méthodes

MéthodeType renvoyéBrève description
createResponse(response)ItemResponseCrée un ItemResponse pour cet élément de date.
duplicate()DateItemCrée une copie de cet élément et l'ajoute à la fin du formulaire.
getGeneralFeedback()QuizFeedbackRenvoie le feedback qui est présenté aux répondants lorsqu'ils répondent à une question pouvant être notée.
getHelpText()StringRécupère 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()IntegerRécupère l'identifiant unique de l'article.
getIndex()IntegerRécupère l'index de l'élément parmi tous les éléments du formulaire.
getPoints()IntegerRenvoie le barème de notation d'un élément pouvant être noté.
getTitle()StringRécupère le titre de l'élément (parfois appelé texte d'en-tête, dans le cas d'une SectionHeaderItem).
getType()ItemTypeRécupère le type de l'élément, représenté par ItemType.
includesYear()BooleanDétermine si l'élément de date inclut une option d'année.
isRequired()BooleanDétermine si la personne interrogée doit répondre à la question.
setGeneralFeedback(feedback)DateItemDéfinit les commentaires à présenter aux personnes interrogées lorsqu'elles répondent à une question notable qui n'a pas de réponse correcte ou incorrecte (c'est-à-dire les questions nécessitant une notation manuelle).
setHelpText(text)DateItemDé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).
setIncludesYear(enableYear)DateItemDétermine si l'élément de date inclut un paramètre d'année.
setPoints(points)DateItemDéfinit le nombre de points attribués à un élément pouvant être noté.
setRequired(enabled)DateItemDétermine si la personne interrogée doit répondre à la question.
setTitle(title)DateItemDéfinit le titre de l'élément (parfois appelé texte d'en-tête, dans le cas d'une SectionHeaderItem).

DateTimeItem

Méthodes

MéthodeType renvoyéBrève description
createResponse(response)ItemResponseCrée un ItemResponse pour cet élément de date et d'heure.
duplicate()DateTimeItemCrée une copie de cet élément et l'ajoute à la fin du formulaire.
getGeneralFeedback()QuizFeedbackRenvoie le feedback qui est présenté aux répondants lorsqu'ils répondent à une question pouvant être notée.
getHelpText()StringRécupère 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()IntegerRécupère l'identifiant unique de l'article.
getIndex()IntegerRécupère l'index de l'élément parmi tous les éléments du formulaire.
getPoints()IntegerRenvoie le barème de notation d'un élément pouvant être noté.
getTitle()StringRécupère le titre de l'élément (parfois appelé texte d'en-tête, dans le cas d'une SectionHeaderItem).
getType()ItemTypeRécupère le type de l'élément, représenté par ItemType.
includesYear()BooleanDétermine si l'élément de date inclut une option d'année.
isRequired()BooleanDétermine si la personne interrogée doit répondre à la question.
setGeneralFeedback(feedback)DateTimeItemDéfinit les commentaires à présenter aux personnes interrogées lorsqu'elles répondent à une question notable qui n'a pas de réponse correcte ou incorrecte (c'est-à-dire les questions nécessitant une notation manuelle).
setHelpText(text)DateTimeItemDé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).
setIncludesYear(enableYear)DateTimeItemDétermine si l'élément de date inclut un paramètre d'année.
setPoints(points)DateTimeItemDéfinit le nombre de points attribués à un élément pouvant être noté.
setRequired(enabled)DateTimeItemDétermine si la personne interrogée doit répondre à la question.
setTitle(title)DateTimeItemDéfinit le titre de l'élément (parfois appelé texte d'en-tête, dans le cas d'une SectionHeaderItem).

DestinationType

Propriétés

PropriétéTypeDescription
SPREADSHEETEnumFeuille de calcul Google Sheets servant de destination pour les réponses aux formulaires.

DurationItem

Méthodes

MéthodeType renvoyéBrève description
createResponse(hours, minutes, seconds)ItemResponseCrée un ItemResponse pour cet élément de date.
duplicate()DurationItemCrée une copie de cet élément et l'ajoute à la fin du formulaire.
getGeneralFeedback()QuizFeedbackRenvoie le feedback qui est présenté aux répondants lorsqu'ils répondent à une question pouvant être notée.
getHelpText()StringRécupère 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()IntegerRécupère l'identifiant unique de l'article.
getIndex()IntegerRécupère l'index de l'élément parmi tous les éléments du formulaire.
getPoints()IntegerRenvoie le barème de notation d'un élément pouvant être noté.
getTitle()StringRécupère le titre de l'élément (parfois appelé texte d'en-tête, dans le cas d'une SectionHeaderItem).
getType()ItemTypeRécupère le type de l'élément, représenté par ItemType.
isRequired()BooleanDétermine si la personne interrogée doit répondre à la question.
setGeneralFeedback(feedback)DurationItemDéfinit les commentaires à présenter aux personnes interrogées lorsqu'elles répondent à une question notable qui n'a pas de réponse correcte ou incorrecte (c'est-à-dire les questions nécessitant une notation manuelle).
setHelpText(text)DurationItemDé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)DurationItemDéfinit le nombre de points attribués à un élément pouvant être noté.
setRequired(enabled)DurationItemDétermine si la personne interrogée doit répondre à la question.
setTitle(title)DurationItemDéfinit le titre de l'élément (parfois appelé texte d'en-tête, dans le cas d'une SectionHeaderItem).

FeedbackType

Propriétés

PropriétéTypeDescription
CORRECTEnumCommentaires affichés automatiquement pour les personnes interrogées lorsqu'une réponse à une question est correcte.
INCORRECTEnumCommentaires affichés automatiquement pour les personnes interrogées lorsqu'une réponse à une question est incorrecte.
GENERALEnumCommentaires affichés automatiquement auprès des personnes interrogées lorsqu'elles envoient leur réponse.

Form

Méthodes

MéthodeType renvoyéBrève description
addCheckboxGridItem()CheckboxGridItemAjoute un nouvel élément de question, présenté sous la forme d'une grille de colonnes et de lignes, qui permet au répondant de sélectionner plusieurs choix par ligne à partir d'une séquence de cases à cocher.
addCheckboxItem()CheckboxItemAjoute une nouvelle question permettant à la personne interrogée de cocher une ou plusieurs cases, ainsi qu'un champ facultatif "Autre".
addDateItem()DateItemAjoute une nouvelle question qui permet au répondant d'indiquer une date.
addDateTimeItem()DateTimeItemAjoute une nouvelle question qui permet au répondant d'indiquer une date et une heure.
addDurationItem()DurationItemAjoute une nouvelle question qui permet à la personne interrogée d'indiquer une durée.
addEditor(emailAddress)FormAjoute l'utilisateur donné à la liste des éditeurs pour Form.
addEditor(user)FormAjoute l'utilisateur donné à la liste des éditeurs pour Form.
addEditors(emailAddresses)FormAjoute le tableau d'utilisateurs indiqué à la liste des éditeurs pour Form.
addGridItem()GridItemAjoute un nouvel élément de question, présenté sous la forme d'une grille de colonnes et de lignes, qui permet au répondant de sélectionner un choix par ligne à partir d'une séquence de cases d'option.
addImageItem()ImageItemAjoute un nouvel élément de mise en page qui affiche une image.
addListItem()ListItemAjoute une nouvelle question qui permet à la personne interrogée de sélectionner une réponse dans une liste déroulante.
addMultipleChoiceItem()MultipleChoiceItemAjoute une nouvelle question qui permet à la personne interrogée de sélectionner un choix dans une liste de cases d'option ou un champ facultatif "Autre".
addPageBreakItem()PageBreakItemAjoute un nouvel élément de mise en page qui marque le début d'une page.
addParagraphTextItem()ParagraphTextItemAjoute une nouvelle question qui permet à la personne interrogée de saisir un bloc de texte.
addScaleItem()ScaleItemAjoute une nouvelle question qui permet au répondant de choisir une option dans une séquence numérotée de cases d'option.
addSectionHeaderItem()SectionHeaderItemAjoute un nouvel élément de mise en page qui indique visuellement le début d'une section.
addTextItem()TextItemAjoute une nouvelle question, qui permet à la personne interrogée de saisir une seule ligne de texte.
addTimeItem()TimeItemAjoute une nouvelle question qui permet au répondant d'indiquer une heure de la journée.
addVideoItem()VideoItemAjoute un nouvel élément de mise en page qui affiche une vidéo.
canEditResponse()BooleanDétermine si le formulaire doit afficher un lien permettant de modifier une réponse après l'avoir envoyée.
collectsEmail()BooleanDétermine si le formulaire collecte les adresses e-mail des personnes interrogées.
createResponse()FormResponseCrée une réponse au formulaire.
deleteAllResponses()FormSupprime toutes les réponses envoyées du magasin de réponses du formulaire.
deleteItem(index)voidSupprime l'élément avec un indice donné parmi tous les éléments du formulaire.
deleteItem(item)voidSupprime l'élément donné.
deleteResponse(responseId)FormSupprime une seule réponse du magasin de réponses du formulaire.
getConfirmationMessage()StringRécupère le message de confirmation du formulaire.
getCustomClosedFormMessage()StringRécupère le message personnalisé qui s'affiche si le formulaire n'accepte pas de réponses, ou une chaîne vide si aucun message personnalisé n'est défini.
getDescription()StringRécupère la description du formulaire.
getDestinationId()StringRécupère l'ID de destination de la réponse du formulaire.
getDestinationType()DestinationTypeRécupère le type de destination de la réponse du formulaire.
getEditUrl()StringRécupère l'URL permettant d'accéder au mode Édition du formulaire.
getEditors()User[]Récupère la liste des éditeurs pour ce Form.
getId()StringRécupère l'ID du formulaire.
getItemById(id)ItemRécupère l'élément ayant un identifiant donné.
getItems()Item[]Récupère un tableau de tous les éléments du formulaire.
getItems(itemType)Item[]Récupère un tableau de tous les éléments d'un type donné.
getPublishedUrl()StringRécupère l'URL qui peut être utilisée pour répondre au formulaire.
getResponse(responseId)FormResponseRécupère une seule réponse de formulaire en fonction de son ID de réponse.
getResponses()FormResponse[]Récupère un tableau contenant toutes les réponses du formulaire.
getResponses(timestamp)FormResponse[]Récupère un tableau de toutes les réponses du formulaire après une date et une heure données.
getShuffleQuestions()BooleanDétermine si l'ordre des questions sur chaque page du formulaire est aléatoire.
getSummaryUrl()StringRécupère l'URL permettant d'afficher un résumé des réponses du formulaire.
getTitle()StringRécupère le titre du formulaire.
hasLimitOneResponsePerUser()BooleanDétermine si le formulaire n'autorise qu'une seule réponse par personne interrogée.
hasProgressBar()BooleanDétermine si le formulaire doit afficher une barre de progression.
hasRespondAgainLink()BooleanDétermine si le formulaire affiche un lien permettant d'envoyer une autre réponse une fois que la personne interrogée a rempli le formulaire.
isAcceptingResponses()BooleanDétermine si le formulaire accepte actuellement des réponses.
isPublishingSummary()BooleanDétermine si le formulaire doit afficher un lien permettant d'afficher un résumé des réponses une fois que la personne interrogée l'a rempli.
isQuiz()BooleanDétermine si le formulaire est un questionnaire.
moveItem(from, to)ItemDéplace un élément d'un indice donné entre tous les éléments du formulaire vers un autre indice donné.
moveItem(item, toIndex)ItemDéplace un élément donné vers un index donné parmi tous les éléments du formulaire.
removeDestination()FormDissocie le formulaire de sa destination de réponse actuelle.
removeEditor(emailAddress)FormSupprime l'utilisateur indiqué de la liste des éditeurs pour Form.
removeEditor(user)FormSupprime l'utilisateur indiqué de la liste des éditeurs pour Form.
requiresLogin()BooleanDétermine si le formulaire oblige les personnes interrogées à se connecter à un compte du même domaine ou à un sous-domaine pour pouvoir répondre.
setAcceptingResponses(enabled)FormDétermine si le formulaire accepte actuellement des réponses.
setAllowResponseEdits(enabled)FormDétermine si le formulaire affiche un lien permettant de modifier la réponse après l'avoir envoyée.
setCollectEmail(collect)FormDétermine si le formulaire collecte les adresses e-mail des personnes interrogées.
setConfirmationMessage(message)FormDéfinit le message de confirmation du formulaire.
setCustomClosedFormMessage(message)FormDéfinit le message à afficher si le formulaire n'accepte pas de réponses.
setDescription(description)FormDéfinit la description du formulaire.
setDestination(type, id)FormDéfinit la destination où les réponses au formulaire sont enregistrées.
setIsQuiz(enabled)FormDétermine si le formulaire est un questionnaire.
setLimitOneResponsePerUser(enabled)FormDétermine si le formulaire n'autorise qu'une seule réponse par personne interrogée.
setProgressBar(enabled)FormDétermine si le formulaire comporte une barre de progression.
setPublishingSummary(enabled)FormDétermine si le formulaire affiche un lien permettant d'afficher un résumé des réponses une fois qu'une personne interrogée l'a envoyé.
setRequireLogin(requireLogin)FormDétermine si les personnes interrogées doivent se connecter à un compte du même domaine ou à un sous-domaine pour pouvoir répondre.
setShowLinkToRespondAgain(enabled)FormDétermine si le formulaire affiche un lien permettant d'envoyer une autre réponse lorsqu'une personne interrogée a rempli le formulaire.
setShuffleQuestions(shuffle)FormDétermine si l'ordre des questions sur chaque page du formulaire est aléatoire.
setTitle(title)FormDéfinit le titre du formulaire.
shortenFormUrl(url)StringConvertit une URL longue d'un formulaire en URL courte.
submitGrades(responses)FormEnvoie les notes pour les réponses FormResponse données.

FormApp

Propriétés

PropriétéTypeDescription
AlignmentAlignmentÉnumération des types d'alignement d'image.
DestinationTypeDestinationTypeÉnumération des types de destinations pouvant stocker des réponses de formulaire.
FeedbackTypeFeedbackTypeÉnumération au format Feedbacks.
ItemTypeItemTypeÉnumération au format Items.
PageNavigationTypePageNavigationTypeÉnumération des comportements possibles pour la navigation sur les pages.

Méthodes

MéthodeType renvoyéBrève description
create(title)FormCrée et renvoie un Form.
createCheckboxGridValidation()CheckboxGridValidationBuilderRenvoie une instance de CheckboxGridValidationBuilder qui peut être utilisée pour définir la validation sur un CheckboxGridItem.
createCheckboxValidation()CheckboxValidationBuilderRenvoie une instance de CheckboxValidationBuilder qui peut être utilisée pour définir la validation sur un CheckboxItem.
createFeedback()QuizFeedbackBuilderRenvoie une instance de QuizFeedbackBuilder pouvant être utilisée pour définir des commentaires sur un Item pouvant être noté.
createGridValidation()GridValidationBuilderRenvoie une instance de GridValidationBuilder qui peut être utilisée pour définir la validation sur un GridItem.
createParagraphTextValidation()ParagraphTextValidationBuilderRenvoie une instance de ParagraphTextValidationBuilder pouvant être utilisé pour définir la validation sur un ParagraphTextItem.
createTextValidation()TextValidationBuilderRenvoie une instance de TextValidationBuilder qui peut être utilisée pour définir la validation sur un TextItem.
getActiveForm()FormRenvoie le formulaire dans lequel le script est lié au conteneur.
getUi()UiRenvoie une instance de l'environnement d'interface utilisateur de l'éditeur de formulaire qui permet au script d'ajouter des fonctionnalités telles que des menus, des boîtes de dialogue et des barres latérales.
openById(id)FormRenvoie la Form avec l'ID spécifié.
openByUrl(url)FormRenvoie la Form avec l'URL spécifiée.

FormResponse

Méthodes

MéthodeType renvoyéBrève description
getEditResponseUrl()StringGénère une URL qui peut être utilisée pour modifier une réponse déjà envoyée.
getGradableItemResponses()ItemResponse[]Récupère toutes les réponses aux éléments contenues dans une réponse de formulaire, dans le même ordre que celui dans lequel les éléments apparaissent dans le formulaire.
getGradableResponseForItem(item)ItemResponseRécupère la réponse à un élément contenue dans une réponse de formulaire pour un élément donné.
getId()StringRécupère l'ID de la réponse au formulaire.
getItemResponses()ItemResponse[]Récupère toutes les réponses aux éléments contenues dans une réponse de formulaire, dans le même ordre que celui dans lequel les éléments apparaissent dans le formulaire.
getRespondentEmail()StringRécupère l'adresse e-mail de la personne qui a envoyé la réponse, si le paramètre Form.setCollectEmail(collect) est activé.
getResponseForItem(item)ItemResponseRécupère la réponse à un élément contenu dans cette réponse de formulaire pour un élément donné.
getTimestamp()DateRécupère le code temporel correspondant à l'envoi d'une réponse à un formulaire.
submit()FormResponseEnvoie la réponse.
toPrefilledUrl()StringGénère une URL pour le formulaire dans lequel les réponses sont préremplies en fonction des réponses de cette réponse.
withItemGrade(gradedResponse)FormResponseAjoute les notes d'une réponse à un élément donné à une réponse au formulaire.
withItemResponse(response)FormResponseAjoute la réponse à un élément donnée à une réponse de formulaire.

GridItem

Méthodes

MéthodeType renvoyéBrève description
clearValidation()GridItemSupprime toute validation des données pour cet élément de grille.
createResponse(responses)ItemResponseCrée un ItemResponse pour cet élément de grille.
duplicate()GridItemCrée une copie de cet élément et l'ajoute à la fin du formulaire.
getColumns()String[]Récupère les valeurs de chaque colonne de la grille.
getHelpText()StringRécupère 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()IntegerRécupère l'identifiant unique de l'article.
getIndex()IntegerRécupère l'index de l'élément parmi tous les éléments du formulaire.
getRows()String[]Récupère les valeurs de chaque ligne de la grille.
getTitle()StringRécupère le titre de l'élément (parfois appelé texte d'en-tête, dans le cas d'une SectionHeaderItem).
getType()ItemTypeRécupère le type de l'élément, représenté par ItemType.
isRequired()BooleanDétermine si la personne interrogée doit répondre à la question.
setColumns(columns)GridItemDéfinit les colonnes de la grille en fonction d'un tableau de valeurs.
setHelpText(text)GridItemDé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).
setRequired(enabled)GridItemDétermine si la personne interrogée doit répondre à la question.
setRows(rows)GridItemDéfinit les lignes de la grille en fonction d'un tableau de valeurs.
setTitle(title)GridItemDéfinit le titre de l'élément (parfois appelé texte d'en-tête, dans le cas d'une SectionHeaderItem).
setValidation(validation)GridItemDéfinit la validation des données pour cet élément de grille.

GridValidation

GridValidationBuilder

Méthodes

MéthodeType renvoyéBrève description
requireLimitOneResponsePerColumn()GridValidationBuilderNécessite une seule réponse par colonne pour un élément de grille.

ImageItem

Méthodes

MéthodeType renvoyéBrève description
duplicate()ImageItemCrée une copie de cet élément et l'ajoute à la fin du formulaire.
getAlignment()AlignmentRécupère l'alignement horizontal de l'image.
getHelpText()StringRécupère 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()IntegerRécupère l'identifiant unique de l'article.
getImage()BlobRécupère l'image actuellement attribuée à l'élément.
getIndex()IntegerRécupère l'index de l'élément parmi tous les éléments du formulaire.
getTitle()StringRécupère le titre de l'élément (parfois appelé texte d'en-tête, dans le cas d'une SectionHeaderItem).
getType()ItemTypeRécupère le type de l'élément, représenté par ItemType.
getWidth()IntegerRécupère la largeur de l'image en pixels.
setAlignment(alignment)ImageItemDéfinit l'alignement horizontal de l'image.
setHelpText(text)ImageItemDé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).
setImage(image)ImageItemDéfinit l'image elle-même.
setTitle(title)ImageItemDéfinit le titre de l'élément (parfois appelé texte d'en-tête, dans le cas d'une SectionHeaderItem).
setWidth(width)ImageItemDéfinit la largeur de l'image en pixels.

Item

Méthodes

MéthodeType renvoyéBrève description
asCheckboxGridItem()CheckboxGridItemRenvoie l'élément sous la forme d'un élément de grille de type case à cocher.
asCheckboxItem()CheckboxItemRenvoie l'élément en tant qu'élément de case à cocher.
asDateItem()DateItemRenvoie l'élément sous forme d'élément de date.
asDateTimeItem()DateTimeItemRenvoie l'élément en tant qu'élément date/heure.
asDurationItem()DurationItemRenvoie l'élément sous forme d'élément de durée.
asGridItem()GridItemRenvoie l'élément sous forme d'élément de grille.
asImageItem()ImageItemRenvoie l'élément en tant qu'élément image.
asListItem()ListItemRenvoie l'élément sous la forme d'un élément de liste.
asMultipleChoiceItem()MultipleChoiceItemRenvoie l'élément en tant qu'élément à choix multiples.
asPageBreakItem()PageBreakItemRenvoie l'élément en tant qu'élément de saut de page.
asParagraphTextItem()ParagraphTextItemRenvoie l'élément sous forme d'élément de texte de paragraphe.
asScaleItem()ScaleItemRenvoie l'élément en tant qu'élément de scaling.
asSectionHeaderItem()SectionHeaderItemRenvoie l'élément sous la forme d'un élément d'en-tête de section.
asTextItem()TextItemRenvoie l'élément sous forme d'élément textuel.
asTimeItem()TimeItemRenvoie l'élément en tant qu'élément temporel.
asVideoItem()VideoItemRenvoie l'élément en tant qu'élément vidéo.
duplicate()ItemCrée une copie de cet élément et l'ajoute à la fin du formulaire.
getHelpText()StringRécupère 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()IntegerRécupère l'identifiant unique de l'article.
getIndex()IntegerRécupère l'index de l'élément parmi tous les éléments du formulaire.
getTitle()StringRécupère le titre de l'élément (parfois appelé texte d'en-tête, dans le cas d'une SectionHeaderItem).
getType()ItemTypeRécupère le type de l'élément, représenté par ItemType.
setHelpText(text)ItemDé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).
setTitle(title)ItemDéfinit le titre de l'élément (parfois appelé texte d'en-tête, dans le cas d'une SectionHeaderItem).

ItemResponse

Méthodes

MéthodeType renvoyéBrève description
getFeedback()ObjectRécupère les informations fournies pour la réponse envoyée par la personne interrogée.
getItem()ItemRécupère l'élément de la question auquel cette réponse répond.
getResponse()ObjectRécupère la réponse envoyée par la personne interrogée.
getScore()ObjectRécupère le score de la réponse envoyée par la personne interrogée.
setFeedback(feedback)ItemResponseDéfinit les commentaires à afficher pour la réponse envoyée par la personne interrogée.
setScore(score)ItemResponseDéfinit le score de la réponse envoyée par la personne interrogée.

ItemType

Propriétés

PropriétéTypeDescription
CHECKBOXEnumQuestion permettant à la personne interrogée de cocher une ou plusieurs cases, ainsi qu'un champ "Autre" facultatif.
CHECKBOX_GRIDEnumQuestion, présentée sous la forme d'une grille de colonnes et de lignes, qui permet à la personne interrogée de sélectionner plusieurs choix par ligne à partir d'une séquence de cases à cocher.
DATEEnumQuestion qui permet à la personne interrogée d'indiquer une date.
DATETIMEEnumQuestion qui permet à la personne interrogée d'indiquer une date et une heure.
DURATIONEnumQuestion qui permet à la personne interrogée d’indiquer un certain temps.
GRIDEnumQuestion, présentée sous la forme d'une grille de colonnes et de lignes, qui permet à la personne interrogée de sélectionner un choix par ligne à partir d'une séquence de cases d'option.
IMAGEEnumÉlément de mise en page qui affiche une image.
LISTEnumQuestion qui permet à la personne interrogée de sélectionner une réponse dans une liste déroulante.
MULTIPLE_CHOICEEnumQuestion qui permet à la personne interrogée de sélectionner une option parmi une liste de cases d'option ou un champ facultatif "Autre".
PAGE_BREAKEnumÉlément de mise en page qui marque le début d'une page.
PARAGRAPH_TEXTEnumQuestion qui permet à la personne interrogée de saisir un bloc de texte.
SCALEEnumÉlément de question qui permet à la personne interrogée de choisir une option parmi une séquence numérotée de cases d'option.
SECTION_HEADEREnumÉlément de mise en page qui indique visuellement le début d'une section.
TEXTEnumQuestion qui permet à la personne interrogée de saisir une seule ligne de texte.
TIMEEnumQuestion qui permet à la personne interrogée d'indiquer une heure de la journée.
VIDEOEnumÉlément de mise en page qui affiche une vidéo YouTube.
FILE_UPLOADEnumQuestion permettant à la personne interrogée d'importer un fichier.

ListItem

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 accède à 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()QuizFeedbackRenvoie les commentaires qui sont présentés aux personnes interrogées lorsqu'elles répondent correctement à une question.
getFeedbackForIncorrect()QuizFeedbackRenvoie les commentaires qui sont présentés aux personnes interrogées lorsqu'elles répondent de manière incorrecte à une question.
getHelpText()StringRécupère 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()IntegerRécupère l'identifiant unique de l'article.
getIndex()IntegerRécupère l'index de l'élément parmi tous les éléments du formulaire.
getPoints()IntegerRenvoie le barème de notation d'un élément pouvant être noté.
getTitle()StringRécupère le titre de l'élément (parfois appelé texte d'en-tête, dans le cas d'une SectionHeaderItem).
getType()ItemTypeRécupère le type de l'élément, représenté par 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 d'options pour un article.
setFeedbackForCorrect(feedback)ListItemDéfinit les commentaires à présenter aux personnes interrogées lorsqu'elles répondent correctement à une question.
setFeedbackForIncorrect(feedback)ListItemDéfinit les commentaires à présenter 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 attribués à un élément pouvant être noté.
setRequired(enabled)ListItemDétermine 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'une SectionHeaderItem).

MultipleChoiceItem

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 accède à 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 à choix multiples.
duplicate()MultipleChoiceItemCré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()QuizFeedbackRenvoie les commentaires qui sont présentés aux personnes interrogées lorsqu'elles répondent correctement à une question.
getFeedbackForIncorrect()QuizFeedbackRenvoie les commentaires qui sont présentés aux personnes interrogées lorsqu'elles répondent de manière incorrecte à une question.
getHelpText()StringRécupère 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()IntegerRécupère l'identifiant unique de l'article.
getIndex()IntegerRécupère l'index de l'élément parmi tous les éléments du formulaire.
getPoints()IntegerRenvoie le barème de notation d'un élément pouvant être noté.
getTitle()StringRécupère le titre de l'élément (parfois appelé texte d'en-tête, dans le cas d'une SectionHeaderItem).
getType()ItemTypeRécupère le type de l'élément, représenté par ItemType.
hasOtherOption()BooleanDétermine si l'élément comporte une option "autre".
isRequired()BooleanDétermine si la personne interrogée doit répondre à la question.
setChoiceValues(values)MultipleChoiceItemDéfinit les choix pour un élément à partir d'un tableau de chaînes.
setChoices(choices)MultipleChoiceItemDéfinit un tableau d'options pour un article.
setFeedbackForCorrect(feedback)MultipleChoiceItemDéfinit les commentaires à présenter aux personnes interrogées lorsqu'elles répondent correctement à une question.
setFeedbackForIncorrect(feedback)MultipleChoiceItemDéfinit les commentaires à présenter aux personnes interrogées lorsqu'elles répondent de manière incorrecte à une question.
setHelpText(text)MultipleChoiceItemDé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)MultipleChoiceItemDéfinit le nombre de points attribués à un élément pouvant être noté.
setRequired(enabled)MultipleChoiceItemDétermine si la personne interrogée doit répondre à la question.
setTitle(title)MultipleChoiceItemDéfinit le titre de l'élément (parfois appelé texte d'en-tête, dans le cas d'une SectionHeaderItem).
showOtherOption(enabled)MultipleChoiceItemDétermine si l'élément comporte une option "Autre".

PageBreakItem

Méthodes

MéthodeType renvoyéBrève description
duplicate()PageBreakItemCrée une copie de cet élément et l'ajoute à la fin du formulaire.
getGoToPage()PageBreakItemRécupère la PageBreakItem vers laquelle le formulaire va accéder après avoir terminé la page avant ce saut de page (c'est-à-dire lorsqu'il atteint ce saut de page par une progression linéaire normale dans le formulaire).
getHelpText()StringRécupère 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()IntegerRécupère l'identifiant unique de l'article.
getIndex()IntegerRécupère l'index de l'élément parmi tous les éléments du formulaire.
getPageNavigationType()PageNavigationTypeRécupère le type de navigation sur les pages qui se produit une fois la page terminée avant ce saut de page (c'est-à-dire, lorsqu'il atteint ce saut de page par une progression linéaire normale dans le formulaire).
getTitle()StringRécupère le titre de l'élément (parfois appelé texte d'en-tête, dans le cas d'une SectionHeaderItem).
getType()ItemTypeRécupère le type de l'élément, représenté par ItemType.
setGoToPage(goToPageItem)PageBreakItemDéfinit la page à laquelle accéder une fois la page terminée avant ce saut de page (c'est-à-dire, lorsque ce saut de page est atteint par une progression linéaire normale dans le formulaire).
setGoToPage(navigationType)PageBreakItemDéfinit le type de navigation sur les pages qui se produit une fois la page terminée avant ce saut de page (c'est-à-dire lorsqu'il atteint ce saut de page par une progression linéaire normale dans le formulaire).
setHelpText(text)PageBreakItemDé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).
setTitle(title)PageBreakItemDéfinit le titre de l'élément (parfois appelé texte d'en-tête, dans le cas d'une SectionHeaderItem).

Propriétés

PropriétéTypeDescription
CONTINUEEnumPassez à la page suivante du formulaire après avoir renseigné la page active.
GO_TO_PAGEEnumAprès avoir rempli la page active, vous pouvez accéder à une page spécifique du formulaire.
RESTARTEnumRecommencer le formulaire depuis le début sans effacer les réponses saisies jusqu'à présent, après avoir rempli la page actuelle.
SUBMITEnumEnvoyez la réponse au formulaire après avoir rempli la page actuelle.

ParagraphTextItem

Méthodes

MéthodeType renvoyéBrève description
clearValidation()ParagraphTextItemSupprime toute validation des données pour cet élément de texte de paragraphe.
createResponse(response)ItemResponseCrée un ItemResponse pour cet élément de texte de paragraphe.
duplicate()ParagraphTextItemCrée une copie de cet élément et l'ajoute à la fin du formulaire.
getGeneralFeedback()QuizFeedbackRenvoie le feedback qui est présenté aux répondants lorsqu'ils répondent à une question pouvant être notée.
getHelpText()StringRécupère 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()IntegerRécupère l'identifiant unique de l'article.
getIndex()IntegerRécupère l'index de l'élément parmi tous les éléments du formulaire.
getPoints()IntegerRenvoie le barème de notation d'un élément pouvant être noté.
getTitle()StringRécupère le titre de l'élément (parfois appelé texte d'en-tête, dans le cas d'une SectionHeaderItem).
getType()ItemTypeRécupère le type de l'élément, représenté par ItemType.
isRequired()BooleanDétermine si la personne interrogée doit répondre à la question.
setGeneralFeedback(feedback)ParagraphTextItemDéfinit les commentaires à présenter aux personnes interrogées lorsqu'elles répondent à une question notable qui n'a pas de réponse correcte ou incorrecte (c'est-à-dire les questions nécessitant une notation manuelle).
setHelpText(text)ParagraphTextItemDé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)ParagraphTextItemDéfinit le nombre de points attribués à un élément pouvant être noté.
setRequired(enabled)ParagraphTextItemDétermine si la personne interrogée doit répondre à la question.
setTitle(title)ParagraphTextItemDéfinit le titre de l'élément (parfois appelé texte d'en-tête, dans le cas d'une SectionHeaderItem).
setValidation(validation)ParagraphTextItemDéfinit la validation des données pour cet élément de texte de paragraphe.

ParagraphTextValidation

ParagraphTextValidationBuilder

Méthodes

MéthodeType renvoyéBrève description
requireTextContainsPattern(pattern)ParagraphTextValidationBuilderLa réponse doit contenir le format.
requireTextDoesNotContainPattern(pattern)ParagraphTextValidationBuilderNécessite que la réponse ne contienne pas de modèle.
requireTextDoesNotMatchPattern(pattern)ParagraphTextValidationBuilderNécessite une réponse pour ne pas correspondre au modèle.
requireTextLengthGreaterThanOrEqualTo(number)ParagraphTextValidationBuilderLa longueur de la réponse doit être supérieure ou égale à la valeur.
requireTextLengthLessThanOrEqualTo(number)ParagraphTextValidationBuilderLa longueur de la réponse doit être inférieure à la valeur.
requireTextMatchesPattern(pattern)ParagraphTextValidationBuilderNécessite une réponse pour correspondre au format.

QuizFeedback

Méthodes

MéthodeType renvoyéBrève description
getLinkUrls()String[]Récupère la liste des URL associées aux commentaires.
getText()StringRécupère le texte à afficher des commentaires.

QuizFeedbackBuilder

Méthodes

MéthodeType renvoyéBrève description
addLink(url)QuizFeedbackBuilderAjoute un lien vers le matériel supplémentaire du feedback.
addLink(url, displayText)QuizFeedbackBuilderAjoute un lien vers le matériel supplémentaire du feedback.
build()QuizFeedbackGénère un commentaire du type correspondant pour ce compilateur.
copy()QuizFeedbackBuilderRenvoie une copie de ce compilateur.
setText(text)QuizFeedbackBuilderDéfinit le texte du commentaire.

ScaleItem

Méthodes

MéthodeType renvoyéBrève description
createResponse(response)ItemResponseCrée un ItemResponse pour cet élément d'échelle.
duplicate()ScaleItemCrée une copie de cet élément et l'ajoute à la fin du formulaire.
getGeneralFeedback()QuizFeedbackRenvoie le feedback qui est présenté aux répondants lorsqu'ils répondent à une question pouvant être notée.
getHelpText()StringRécupère 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()IntegerRécupère l'identifiant unique de l'article.
getIndex()IntegerRécupère l'index de l'élément parmi tous les éléments du formulaire.
getLeftLabel()StringRécupère l'étiquette de la limite inférieure de l'échelle, le cas échéant.
getLowerBound()IntegerRécupère la limite inférieure de l'échelle.
getPoints()IntegerRenvoie le barème de notation d'un élément pouvant être noté.
getRightLabel()StringRécupère l'étiquette de la limite supérieure de l'échelle, le cas échéant.
getTitle()StringRécupère le titre de l'élément (parfois appelé texte d'en-tête, dans le cas d'une SectionHeaderItem).
getType()ItemTypeRécupère le type de l'élément, représenté par ItemType.
getUpperBound()IntegerRécupère la limite supérieure de l'échelle.
isRequired()BooleanDétermine si la personne interrogée doit répondre à la question.
setBounds(lower, upper)ScaleItemDéfinit les limites inférieure et supérieure de l'échelle.
setGeneralFeedback(feedback)ScaleItemDéfinit les commentaires à présenter aux personnes interrogées lorsqu'elles répondent à une question notable qui n'a pas de réponse correcte ou incorrecte (c'est-à-dire les questions nécessitant une notation manuelle).
setHelpText(text)ScaleItemDé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).
setLabels(lower, upper)ScaleItemDéfinit les libellés des limites inférieure et supérieure de l'échelle.
setPoints(points)ScaleItemDéfinit le nombre de points attribués à un élément pouvant être noté.
setRequired(enabled)ScaleItemDétermine si la personne interrogée doit répondre à la question.
setTitle(title)ScaleItemDéfinit le titre de l'élément (parfois appelé texte d'en-tête, dans le cas d'une SectionHeaderItem).

SectionHeaderItem

Méthodes

MéthodeType renvoyéBrève description
duplicate()SectionHeaderItemCrée une copie de cet élément et l'ajoute à la fin du formulaire.
getHelpText()StringRécupère 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()IntegerRécupère l'identifiant unique de l'article.
getIndex()IntegerRécupère l'index de l'élément parmi tous les éléments du formulaire.
getTitle()StringRécupère le titre de l'élément (parfois appelé texte d'en-tête, dans le cas d'une SectionHeaderItem).
getType()ItemTypeRécupère le type de l'élément, représenté par ItemType.
setHelpText(text)SectionHeaderItemDé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).
setTitle(title)SectionHeaderItemDéfinit le titre de l'élément (parfois appelé texte d'en-tête, dans le cas d'une SectionHeaderItem).

TextItem

Méthodes

MéthodeType renvoyéBrève description
clearValidation()TextItemSupprime toute validation des données pour cet élément de texte.
createResponse(response)ItemResponseCrée un ItemResponse pour cet élément de texte.
duplicate()TextItemCrée une copie de cet élément et l'ajoute à la fin du formulaire.
getGeneralFeedback()QuizFeedbackRenvoie le feedback qui est présenté aux répondants lorsqu'ils répondent à une question pouvant être notée.
getHelpText()StringRécupère 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()IntegerRécupère l'identifiant unique de l'article.
getIndex()IntegerRécupère l'index de l'élément parmi tous les éléments du formulaire.
getPoints()IntegerRenvoie le barème de notation d'un élément pouvant être noté.
getTitle()StringRécupère le titre de l'élément (parfois appelé texte d'en-tête, dans le cas d'une SectionHeaderItem).
getType()ItemTypeRécupère le type de l'élément, représenté par ItemType.
isRequired()BooleanDétermine si la personne interrogée doit répondre à la question.
setGeneralFeedback(feedback)TextItemDéfinit les commentaires à présenter aux personnes interrogées lorsqu'elles répondent à une question notable qui n'a pas de réponse correcte ou incorrecte (c'est-à-dire les questions nécessitant une notation manuelle).
setHelpText(text)TextItemDé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)TextItemDéfinit le nombre de points attribués à un élément pouvant être noté.
setRequired(enabled)TextItemDétermine si la personne interrogée doit répondre à la question.
setTitle(title)TextItemDéfinit le titre de l'élément (parfois appelé texte d'en-tête, dans le cas d'une SectionHeaderItem).
setValidation(validation)TextItemDéfinit la validation des données pour cet élément de texte.

TextValidation

TextValidationBuilder

Méthodes

MéthodeType renvoyéBrève description
requireNumber()TextValidationBuilderL'élément textuel doit être un nombre.
requireNumberBetween(start, end)TextValidationBuilderL'élément textuel doit être un nombre compris entre début et fin inclus.
requireNumberEqualTo(number)TextValidationBuilderL'élément textuel doit être un nombre égal à la valeur spécifiée.
requireNumberGreaterThan(number)TextValidationBuilderNécessite que l'élément textuel soit un nombre supérieur à la valeur spécifiée.
requireNumberGreaterThanOrEqualTo(number)TextValidationBuilderNécessite que l'élément textuel soit un nombre supérieur ou égal à la valeur spécifiée.
requireNumberLessThan(number)TextValidationBuilderNécessite que l'élément textuel soit un nombre inférieur à la valeur spécifiée.
requireNumberLessThanOrEqualTo(number)TextValidationBuilderNécessite que l'élément textuel soit un nombre inférieur ou égal à la valeur spécifiée.
requireNumberNotBetween(start, end)TextValidationBuilderL'élément textuel doit être un nombre qui n'est pas compris entre le début et la fin (inclus).
requireNumberNotEqualTo(number)TextValidationBuilderL'élément textuel doit être un nombre différent de la valeur spécifiée.
requireTextContainsPattern(pattern)TextValidationBuilderLa réponse doit contenir le format.
requireTextDoesNotContainPattern(pattern)TextValidationBuilderNécessite que la réponse ne contienne pas de modèle.
requireTextDoesNotMatchPattern(pattern)TextValidationBuilderNécessite une réponse pour ne pas correspondre au modèle.
requireTextIsEmail()TextValidationBuilderL'élément textuel doit être une adresse e-mail.
requireTextIsUrl()TextValidationBuilderL'élément textuel doit être une URL.
requireTextLengthGreaterThanOrEqualTo(number)TextValidationBuilderLa longueur de la réponse doit être supérieure ou égale à la valeur.
requireTextLengthLessThanOrEqualTo(number)TextValidationBuilderLa longueur de la réponse doit être inférieure à la valeur.
requireTextMatchesPattern(pattern)TextValidationBuilderNécessite une réponse pour correspondre au format.
requireWholeNumber()TextValidationBuilderL'élément textuel doit être un nombre entier.

TimeItem

Méthodes

MéthodeType renvoyéBrève description
createResponse(hour, minute)ItemResponseCrée un ItemResponse pour cet élément de temps.
duplicate()TimeItemCrée une copie de cet élément et l'ajoute à la fin du formulaire.
getGeneralFeedback()QuizFeedbackRenvoie le feedback qui est présenté aux répondants lorsqu'ils répondent à une question pouvant être notée.
getHelpText()StringRécupère 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()IntegerRécupère l'identifiant unique de l'article.
getIndex()IntegerRécupère l'index de l'élément parmi tous les éléments du formulaire.
getPoints()IntegerRenvoie le barème de notation d'un élément pouvant être noté.
getTitle()StringRécupère le titre de l'élément (parfois appelé texte d'en-tête, dans le cas d'une SectionHeaderItem).
getType()ItemTypeRécupère le type de l'élément, représenté par ItemType.
isRequired()BooleanDétermine si la personne interrogée doit répondre à la question.
setGeneralFeedback(feedback)TimeItemDéfinit les commentaires à présenter aux personnes interrogées lorsqu'elles répondent à une question notable qui n'a pas de réponse correcte ou incorrecte (c'est-à-dire les questions nécessitant une notation manuelle).
setHelpText(text)TimeItemDé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)TimeItemDéfinit le nombre de points attribués à un élément pouvant être noté.
setRequired(enabled)TimeItemDétermine si la personne interrogée doit répondre à la question.
setTitle(title)TimeItemDéfinit le titre de l'élément (parfois appelé texte d'en-tête, dans le cas d'une SectionHeaderItem).

VideoItem

Méthodes

MéthodeType renvoyéBrève description
duplicate()VideoItemCrée une copie de cet élément et l'ajoute à la fin du formulaire.
getAlignment()AlignmentRécupère l'alignement horizontal de la vidéo.
getHelpText()StringRécupère 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()IntegerRécupère l'identifiant unique de l'article.
getIndex()IntegerRécupère l'index de l'élément parmi tous les éléments du formulaire.
getTitle()StringRécupère le titre de l'élément (parfois appelé texte d'en-tête, dans le cas d'une SectionHeaderItem).
getType()ItemTypeRécupère le type de l'élément, représenté par ItemType.
getWidth()IntegerRécupère la largeur de la vidéo en pixels.
setAlignment(alignment)VideoItemDéfinit l'alignement horizontal de la vidéo.
setHelpText(text)VideoItemDé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).
setTitle(title)VideoItemDéfinit le titre de l'élément (parfois appelé texte d'en-tête, dans le cas d'une SectionHeaderItem).
setVideoUrl(youtubeUrl)VideoItemDéfinit la vidéo elle-même à partir d'une URL YouTube ou d'un ID vidéo YouTube donné.
setWidth(width)VideoItemDéfinit la largeur de la vidéo en pixels.