Forms Service

Forms

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

// Create a new unpublished form, then add a checkbox question, a multiple choice question,
// a page break, then a date question and a grid of questions, then publish the form and share
// with responders.
var form = FormApp.create('New Form', /* isPublished= */ false);
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']);

form.setPublished(true);
form.addPublishedReaders(['user@example.com', 'group@example.com']);

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.
CheckboxGridItemÉlément de question présenté sous forme de 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.
CheckboxGridValidationUn DataValidation pour un CheckboxGridItem.
CheckboxGridValidationBuilderDataValidationBuilder pour un CheckboxGridValidation.
CheckboxItemÉlément de question permettant au répondant de sélectionner une ou plusieurs cases à cocher, ainsi qu'un champ "Autre" facultatif.
CheckboxValidationUn DataValidation pour un CheckboxItem.
CheckboxValidationBuilderDataValidationBuilder pour un CheckboxValidation.
ChoiceChoix unique associé à un type Item qui accepte les choix, comme CheckboxItem, ListItem ou MultipleChoiceItem.
DateItemQuestion permettant au répondant d'indiquer une date.
DateTimeItemÉlément de question qui permet au répondant d'indiquer une date et une heure.
DestinationTypeÉnumération représentant les types de destinations de réponses de formulaire acceptés.
DurationItemÉlément de question qui permet au répondant d'indiquer une durée.
FeedbackTypeÉnumération représentant les types de commentaires acceptés.
FormFormulaire contenant les propriétés et les éléments généraux.
FormAppPermet à un script d'ouvrir un Form existant ou d'en créer un.
FormResponseRéponse au formulaire dans son ensemble.
GridItemÉ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.
GridValidationUn DataValidation pour un GridItem.
GridValidationBuilderDataValidationBuilder 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, telles que le titre et le texte d'aide.
ItemResponseRéponse à une question d'un formulaire.
ItemTypeÉnumération représentant les types d'éléments de formulaire acceptés.
ListItemÉlément de question qui permet au répondant de sélectionner un choix dans une liste déroulante.
MultipleChoiceItemÉlément de question permettant au répondant de sélectionner un choix dans une liste de cases d'option ou un champ "Autre" facultatif.
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 acceptés.
ParagraphTextItemÉlément de question qui permet au répondant de saisir un bloc de texte.
ParagraphTextValidationUn DataValidation pour un ParagraphTextItem.
ParagraphTextValidationBuilderDataValidationBuilder pour un ParagraphTextValidation.
QuizFeedbackImplémentation du bean d'un commentaire, qui contient des propriétés communes à tous les commentaires, telles que le texte à afficher ou les liens.
QuizFeedbackBuilderFeedbackBuilder de base qui contient des setters pour les propriétés communes à tous les commentaires, comme le texte à afficher.
RatingIconTypeÉnumération représentant les types d'icônes de classification acceptés.
RatingItemQuestion permettant au répondant de donner une note.
ScaleItemÉlément de question qui permet au répondant 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 permettant au répondant de saisir une seule ligne de texte.
TextValidationUn DataValidation pour un TextItem.
TextValidationBuilderDataValidationBuilder pour un TextValidation.
TimeItemÉlément de question qui permet au répondant 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 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 cases à 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()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.
getRows()String[]Récupère les valeurs de chaque ligne de la grille.
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.
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)CheckboxGridItemIndique 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'un SectionHeaderItem).
setValidation(validation)CheckboxGridItemDéfinit la validation des données pour cet élément de grille à cases à cocher.

CheckboxGridValidation

CheckboxGridValidationBuilder

Méthodes

MéthodeType renvoyéBrève description
requireLimitOneResponsePerColumn()CheckboxGridValidationBuilderNécessite de limiter à 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()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.
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 de choix pour un élément.
setFeedbackForCorrect(feedback)CheckboxItemDéfinit les commentaires à afficher aux participants lorsqu'ils répondent correctement à une question.
setFeedbackForIncorrect(feedback)CheckboxItemDéfinit les commentaires à afficher 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 qu'un devoir peut rapporter.
setRequired(enabled)CheckboxItemIndique 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'un SectionHeaderItem).
setValidation(validation)CheckboxItemDéfinit la validation des données pour cet élément de case à cocher.
showOtherOption(enabled)CheckboxItemIndique si l'élément comporte une option "Autre".

CheckboxValidation

CheckboxValidationBuilder

Méthodes

MéthodeType renvoyéBrève description
requireSelectAtLeast(number)CheckboxValidationBuilderExigez qu'au moins ce nombre de choix soit sélectionné.
requireSelectAtMost(number)CheckboxValidationBuilderIndiquez le nombre maximal de choix à sélectionner.
requireSelectExactly(number)CheckboxValidationBuilderLe nombre exact de choix à sélectionner.

Choice

Méthodes

MéthodeType renvoyéBrève description
getGotoPage()PageBreakItemObtient le PageBreakItem défini comme destination GO_TO_PAGE si le répondant sélectionne ce choix et termine la page actuelle.
getPageNavigationType()PageNavigationTypeObtient le PageNavigationType qui se produit si le répondant sélectionne ce choix et remplit la page actuelle.
getValue()StringObtient la valeur du choix, que les répondants voient comme un libellé lorsqu'ils consultent le formulaire.
isCorrectAnswer()BooleanIndique si le choix est une réponse correcte à 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()QuizFeedback|nullRenvoie les commentaires affichés aux participants lorsqu'ils répondent à une question pouvant être notée.
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.
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 le commentaire à afficher aux participants lorsqu'ils répondent à une question évaluable qui n'a pas de réponse correcte ou incorrecte (c'est-à-dire les questions qui nécessitent une évaluation 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éfinit si l'élément de date inclut un paramètre d'année.
setPoints(points)DateItemDéfinit le nombre de points qu'un devoir peut rapporter.
setRequired(enabled)DateItemIndique 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'un SectionHeaderItem).

DateTimeItem

Méthodes

MéthodeType renvoyéBrève description
createResponse(response)ItemResponseCrée un ItemResponse pour cet élément de date et heure.
duplicate()DateTimeItemCrée une copie de cet élément et l'ajoute à la fin du formulaire.
getGeneralFeedback()QuizFeedback|nullRenvoie les commentaires affichés aux participants lorsqu'ils répondent à une question pouvant être notée.
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.
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 le commentaire à afficher aux participants lorsqu'ils répondent à une question évaluable qui n'a pas de réponse correcte ou incorrecte (c'est-à-dire les questions qui nécessitent une évaluation 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éfinit si l'élément de date inclut un paramètre d'année.
setPoints(points)DateTimeItemDéfinit le nombre de points qu'un devoir peut rapporter.
setRequired(enabled)DateTimeItemIndique 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'un SectionHeaderItem).

DestinationType

Propriétés

PropriétéTypeDescription
SPREADSHEETEnumUne feuille de calcul Google Sheets comme destination des réponses au formulaire.

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()QuizFeedback|nullRenvoie les commentaires affichés aux participants lorsqu'ils répondent à une question pouvant être notée.
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.
setGeneralFeedback(feedback)DurationItemDéfinit le commentaire à afficher aux participants lorsqu'ils répondent à une question évaluable qui n'a pas de réponse correcte ou incorrecte (c'est-à-dire les questions qui nécessitent une évaluation 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 qu'un devoir peut rapporter.
setRequired(enabled)DurationItemIndique 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'un SectionHeaderItem).

FeedbackType

Propriétés

PropriétéTypeDescription
CORRECTEnumCommentaires qui s'affichent automatiquement pour les personnes interrogées lorsqu'elles répondent correctement à une question.
INCORRECTEnumCommentaires qui s'affichent automatiquement pour les personnes interrogées lorsqu'elles répondent incorrectement à une question.
GENERALEnumCommentaires qui s'affichent automatiquement pour les participants lorsqu'ils envoient leur réponse.

Form

Méthodes

MéthodeType renvoyéBrève description
addCheckboxGridItem()CheckboxGridItemAjoute un élément de question présenté sous forme de 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 un élément de question qui permet au répondant de sélectionner une ou plusieurs cases à cocher, ainsi qu'un champ "Autre" facultatif.
addDateItem()DateItemAjoute un élément de question permettant au répondant d'indiquer une date.
addDateTimeItem()DateTimeItemAjoute une question permettant au répondant d'indiquer une date et une heure.
addDurationItem()DurationItemAjoute une question permettant au répondant 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 donné à la liste des éditeurs de Form.
addGridItem()GridItemAjoute un é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 élément de mise en page qui affiche une image.
addListItem()ListItemAjoute un élément de question qui permet au répondant de sélectionner un choix dans une liste déroulante.
addMultipleChoiceItem()MultipleChoiceItemAjoute un élément de question permettant au répondant de sélectionner un choix dans une liste de cases d'option ou un champ "Autre" facultatif.
addPageBreakItem()PageBreakItemAjoute un élément de mise en page qui marque le début d'une page.
addParagraphTextItem()ParagraphTextItemAjoute une question permettant au répondant de saisir un bloc de texte.
addPublishedReader(emailAddress)FormAjoute l'utilisateur donné à la liste des répondants pour Form.
addPublishedReader(user)FormAjoute l'utilisateur donné à la liste des répondants pour Form.
addPublishedReaders(emailAddresses)FormAjoute le tableau d'utilisateurs donné à la liste des responsables de Form.
addRatingItem()RatingItemAjoute un élément de question qui permet au répondant de donner une note.
addScaleItem()ScaleItemAjoute un élément de question qui permet au répondant de choisir une option dans une séquence numérotée de cases d'option.
addSectionHeaderItem()SectionHeaderItemAjoute un élément de mise en page qui indique visuellement le début d'une section.
addTextItem()TextItemAjoute un élément de question qui permet au répondant de saisir une seule ligne de texte.
addTimeItem()TimeItemAjoute un élément de question permettant au répondant d'indiquer une heure de la journée.
addVideoItem()VideoItemAjoute un élément de mise en page qui affiche une vidéo.
canEditResponse()BooleanDétermine si le formulaire affiche un lien permettant de modifier une réponse après l'envoi.
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 à un index donné parmi tous les éléments du formulaire.
deleteItem(item)voidSupprime l'élément donné.
deleteResponse(responseId)FormSupprime une seule réponse de la base de données des réponses du formulaire.
getConfirmationMessage()StringRécupère le message de confirmation du formulaire.
getCustomClosedFormMessage()StringObtient le message personnalisé qui s'affiche si le formulaire n'accepte pas les réponses, ou une chaîne vide si aucun message personnalisé n'est défini.
getDescription()StringRécupère la description du formulaire.
getDestinationId()StringObtient l'ID de la destination des réponses du formulaire.
getDestinationType()DestinationTypeRécupère le type de destination des réponses du formulaire.
getEditUrl()StringRécupère l'URL permettant d'accéder au mode d'édition du formulaire.
getEditors()User[]Obtient la liste des éditeurs pour ce Form.
getId()StringObtient l'ID du formulaire.
getItemById(id)ItemRécupère l'élément avec un ID 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é.
getPublishedReaders()User[]Obtient la liste des personnes ayant répondu à cette Form.
getPublishedUrl()StringObtient l'URL qui peut être utilisée pour répondre au formulaire.
getResponse(responseId)FormResponseObtient une seule réponse à un formulaire en fonction de son ID de réponse.
getResponses()FormResponse[]Récupère un tableau de 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()StringObtient l'URL permettant d'afficher un récapitulatif 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 répondant.
hasProgressBar()BooleanDétermine si le formulaire affiche une barre de progression.
hasRespondAgainLink()BooleanDétermine si le formulaire affiche un lien permettant d'envoyer une autre réponse une fois qu'un répondant l'a rempli.
isAcceptingResponses()BooleanDétermine si le formulaire accepte actuellement les réponses.
isPublished()BooleanDétermine si le formulaire est publié.
isPublishingSummary()BooleanDétermine si le formulaire affiche un lien permettant de consulter un résumé des réponses une fois qu'un répondant l'a rempli.
isQuiz()BooleanDétermine si le formulaire est un quiz.
moveItem(from, to)ItemDéplace un élément à un index donné parmi tous les éléments du formulaire vers un autre index 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 actuelle pour les réponses.
removeEditor(emailAddress)FormSupprime l'utilisateur donné de la liste des éditeurs pour le Form.
removeEditor(user)FormSupprime l'utilisateur donné de la liste des éditeurs pour le Form.
removePublishedReader(emailAddress)FormSupprime l'utilisateur donné de la liste des personnes ayant répondu à Form.
removePublishedReader(user)FormSupprime l'utilisateur donné de la liste des personnes ayant répondu à Form.
setAcceptingResponses(enabled)FormIndique si le formulaire accepte actuellement les réponses.
setAllowResponseEdits(enabled)FormIndique si le formulaire affiche un lien permettant de modifier une réponse après l'envoi.
setCollectEmail(collect)FormIndique 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)FormIndique si le formulaire est un questionnaire.
setLimitOneResponsePerUser(enabled)FormIndique si le formulaire n'autorise qu'une seule réponse par répondant.
setProgressBar(enabled)FormIndique si le formulaire comporte une barre de progression.
setPublished(enabled)FormIndique si le formulaire est publié.
setPublishingSummary(enabled)FormIndique si le formulaire affiche un lien permettant de consulter un résumé des réponses après l'envoi du formulaire par une personne interrogée.
setShowLinkToRespondAgain(enabled)FormIndique si le formulaire affiche un lien permettant aux répondants d'envoyer une autre réponse une fois le formulaire rempli.
setShuffleQuestions(shuffle)FormIndique 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 de formulaire en URL courte.
submitGrades(responses)FormEnvoie les notes pour les FormResponses données.
supportsAdvancedResponderPermissions()BooleanDétermine si le formulaire est compatible avec la publication.

FormApp

Propriétés

PropriétéTypeDescription
AlignmentAlignmentÉnumération des types d'alignement d'images.
DestinationTypeDestinationTypeÉnumération des types de destinations pouvant stocker les réponses du formulaire.
FeedbackTypeFeedbackTypeÉnumération des types de formulaire Feedbacks.
ItemTypeItemTypeÉnumération des types de formulaire Items.
PageNavigationTypePageNavigationTypeÉnumération des comportements possibles pour la navigation dans les pages.
RatingIconTypeRatingIconTypeÉnumération des types d'icônes de notation RatingIcons

Méthodes

MéthodeType renvoyéBrève description
create(title)FormCrée et renvoie un Form.
create(title, isPublished)FormCrée et renvoie un Form dans l'état de publication demandé.
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 qui peut ê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 qui peut être utilisée 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 auquel le script est lié au conteneur.
getUi()UiRenvoie une instance de l'environnement d'interface utilisateur de l'éditeur de formulaires 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 l'Form avec l'ID spécifié.
openByUrl(url)FormRenvoie l'Form avec l'URL spécifiée.

FormResponse

Méthodes

MéthodeType renvoyéBrève description
getEditResponseUrl()StringGénère une URL permettant de modifier une réponse déjà envoyée.
getGradableItemResponses()ItemResponse[]Obtient toutes les réponses aux questions contenues dans une réponse de formulaire, dans le même ordre que les questions apparaissent dans le formulaire.
getGradableResponseForItem(item)ItemResponseRécupère la réponse à un élément contenue dans une réponse à un formulaire pour un élément donné.
getId()String|nullRécupère l'ID de la réponse au formulaire.
getItemResponses()ItemResponse[]Obtient toutes les réponses aux questions contenues dans une réponse de formulaire, dans le même ordre que les questions apparaissent dans le formulaire.
getRespondentEmail()StringRécupère l'adresse e-mail de la personne qui a envoyé une réponse, si le paramètre Form.setCollectEmail(collect) est activé.
getResponseForItem(item)ItemResponseRécupère la réponse à l'élément contenue dans cette réponse au formulaire pour un élément donné.
getTimestamp()DateRécupère le code temporel de 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 au formulaire.
withItemGrade(gradedResponse)FormResponseAjoute les notes de la réponse à l'élément donné à une réponse de formulaire.
withItemResponse(response)FormResponseAjoute la réponse à l'élément donné à 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()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.
getRows()String[]Récupère les valeurs de chaque ligne de la grille.
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.
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)GridItemIndique 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'un 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 de limiter à 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()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.
getImage()BlobRécupère l'image actuellement attribuée à l'élément.
getIndex()IntegerObtient l'index de l'élément parmi tous les éléments du formulaire.
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.
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'un 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 forme d'élément de grille à cases à cocher.
asCheckboxItem()CheckboxItemRenvoie l'élément sous forme 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 de date et heure.
asDurationItem()DurationItemRenvoie l'élément en tant qu'é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 forme d'élément de liste.
asMultipleChoiceItem()MultipleChoiceItemRenvoie l'élément sous forme d'é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.
asRatingItem()RatingItemRenvoie l'élément en tant qu'élément de notation.
asScaleItem()ScaleItemRenvoie l'élément en tant qu'élément d'échelle.
asSectionHeaderItem()SectionHeaderItemRenvoie l'élément en tant qu'élément d'en-tête de section.
asTextItem()TextItemRenvoie l'élément sous forme d'élément de texte.
asTimeItem()TimeItemRenvoie l'élément en tant qu'élément temporel.
asVideoItem()VideoItemRenvoie l'élément sous forme d'élément vidéo.
duplicate()ItemCrée une copie de cet élément et l'ajoute à la fin du formulaire.
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.
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.
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'un SectionHeaderItem).

ItemResponse

Méthodes

MéthodeType renvoyéBrève description
getFeedback()ObjectRécupère les commentaires qui ont été fournis pour la réponse envoyée par le répondant.
getItem()ItemRécupère l'élément de question auquel cette réponse répond.
getResponse()ObjectObtient la réponse envoyée par le répondant.
getScore()ObjectObtient le score de la réponse envoyée par le répondant.
setFeedback(feedback)ItemResponseDéfinit les commentaires qui doivent s'afficher pour la réponse envoyée par le répondant.
setScore(score)ItemResponseDéfinit le score de la réponse envoyée par le répondant.

ItemType

Propriétés

PropriétéTypeDescription
CHECKBOXEnumÉlément de question permettant au répondant de sélectionner une ou plusieurs cases à cocher, ainsi qu'un champ "Autre" facultatif.
CHECKBOX_GRIDEnumÉlément de question présenté sous forme de 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.
DATEEnumQuestion permettant au répondant d'indiquer une date.
DATETIMEEnumÉlément de question qui permet au répondant d'indiquer une date et une heure.
DURATIONEnumÉlément de question qui permet au répondant d'indiquer une durée.
GRIDEnumÉ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.
IMAGEEnumÉlément de mise en page qui affiche une image.
LISTEnumÉlément de question qui permet au répondant de sélectionner un choix dans une liste déroulante.
MULTIPLE_CHOICEEnumÉlément de question permettant au répondant de sélectionner un choix dans une liste de cases d'option ou un champ "Autre" facultatif.
PAGE_BREAKEnumÉlément de mise en page qui marque le début d'une page.
PARAGRAPH_TEXTEnumÉlément de question qui permet au répondant de saisir un bloc de texte.
RATINGEnumQuestion permettant au répondant de donner une note.
SCALEEnumÉlément de question qui permet au répondant 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 permettant au répondant de saisir une seule ligne de texte.
TIMEEnumÉlément de question qui permet au répondant d'indiquer une heure de la journée.
VIDEOEnumÉlément de mise en page qui affiche une vidéo YouTube.
FILE_UPLOADEnumÉlément de question qui permet au répondant d'importer un fichier.
UNSUPPORTEDEnumUn élément qui n'est actuellement pas compatible avec les API.

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 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).

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 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 à 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()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.
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 de choix pour un élément.
setFeedbackForCorrect(feedback)MultipleChoiceItemDéfinit les commentaires à afficher aux participants lorsqu'ils répondent correctement à une question.
setFeedbackForIncorrect(feedback)MultipleChoiceItemDéfinit les commentaires à afficher 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 qu'un devoir peut rapporter.
setRequired(enabled)MultipleChoiceItemIndique 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'un SectionHeaderItem).
showOtherOption(enabled)MultipleChoiceItemIndique 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()PageBreakItemObtient le PageBreakItem vers lequel le formulaire passera après avoir terminé la page avant ce saut de page (c'est-à-dire en atteignant ce saut de page par progression linéaire normale dans le formulaire).
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.
getPageNavigationType()PageNavigationTypeObtient le type de navigation sur la page qui se produit après avoir terminé la page avant ce saut de page (c'est-à-dire en atteignant ce saut de page par progression linéaire normale dans le formulaire).
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.
setGoToPage(goToPageItem)PageBreakItemDéfinit la page à laquelle accéder après avoir terminé la page précédant ce saut de page (c'est-à-dire lorsque ce saut de page est atteint par progression linéaire normale dans le formulaire).
setGoToPage(navigationType)PageBreakItemDéfinit le type de navigation sur la page qui se produit après avoir terminé la page avant ce saut de page (c'est-à-dire lorsque ce saut de page est atteint par 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'un SectionHeaderItem).

Propriétés

PropriétéTypeDescription
CONTINUEEnumPassez à la page suivante du formulaire une fois la page actuelle remplie.
GO_TO_PAGEEnumAccédez à une page spécifique du formulaire après avoir terminé la page actuelle.
RESTARTEnumRedémarrez le formulaire depuis le début, sans effacer les réponses saisies jusqu'à présent, après avoir terminé la page actuelle.
SUBMITEnumEnvoyez la réponse au formulaire après avoir terminé la page actuelle.

ParagraphTextItem

Méthodes

MéthodeType renvoyéBrève description
clearValidation()ParagraphTextItemSupprime toute validation de 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()QuizFeedback|nullRenvoie les commentaires affichés aux participants lorsqu'ils répondent à une question pouvant être notée.
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.
setGeneralFeedback(feedback)ParagraphTextItemDéfinit le commentaire à afficher aux participants lorsqu'ils répondent à une question évaluable qui n'a pas de réponse correcte ou incorrecte (c'est-à-dire les questions qui nécessitent une évaluation 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 qu'un devoir peut rapporter.
setRequired(enabled)ParagraphTextItemIndique 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'un 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)ParagraphTextValidationBuilderExige que la réponse contienne un motif.
requireTextDoesNotContainPattern(pattern)ParagraphTextValidationBuilderLa réponse ne doit pas contenir de modèle.
requireTextDoesNotMatchPattern(pattern)ParagraphTextValidationBuilderLa réponse ne doit pas correspondre au modèle.
requireTextLengthGreaterThanOrEqualTo(number)ParagraphTextValidationBuilderExige que la longueur de la réponse soit supérieure ou égale à la valeur.
requireTextLengthLessThanOrEqualTo(number)ParagraphTextValidationBuilderLa longueur de la réponse doit être inférieure à la valeur.
requireTextMatchesPattern(pattern)ParagraphTextValidationBuilderLa réponse doit correspondre au modèle.

QuizFeedback

Méthodes

MéthodeType renvoyéBrève description
getLinkUrls()String[]Obtient la liste des URL associées au commentaire.
getText()StringObtient le texte à afficher pour le commentaire.

QuizFeedbackBuilder

Méthodes

MéthodeType renvoyéBrève description
addLink(url)QuizFeedbackBuilderAjoute un lien vers les ressources complémentaires du commentaire.
addLink(url, displayText)QuizFeedbackBuilderAjoute un lien vers les ressources complémentaires du commentaire.
build()QuizFeedbackCrée un commentaire du type correspondant pour ce générateur.
copy()QuizFeedbackBuilderRenvoie une copie de ce générateur.
setText(text)QuizFeedbackBuilderDéfinit le texte du commentaire.

RatingIconType

Propriétés

PropriétéTypeDescription
STAREnumIcône en forme d'étoile.
HEARTEnumIcône en forme de cœur.
THUMB_UPEnumIcône J'aime

RatingItem

Méthodes

MéthodeType renvoyéBrève description
createResponse(response)ItemResponseCrée un ItemResponse pour cet élément de notation.
duplicate()RatingItemCrée une copie de cet élément et l'ajoute à la fin du formulaire.
getGeneralFeedback()QuizFeedback|nullRenvoie les commentaires affichés aux participants lorsqu'ils répondent à une question pouvant être notée.
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é.
getRatingIcon()RatingIconTypeRécupère l'icône choisie pour la note.
getRatingScaleLevel()IntegerRécupère le niveau de l'échelle de notation.
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.
setGeneralFeedback(feedback)RatingItemDéfinit le commentaire à afficher aux participants lorsqu'ils répondent à une question évaluable qui n'a pas de réponse correcte ou incorrecte (c'est-à-dire les questions qui nécessitent une évaluation manuelle).
setHelpText(text)RatingItemDé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)RatingItemDéfinit le nombre de points qu'un devoir peut rapporter.
setRatingIcon(ratingIcon)RatingItemDéfinit l'icône de la note.
setRatingScaleLevel(ratingScaleLevel)RatingItemDéfinit le niveau maximal de l'échelle de notation.
setRequired(enabled)RatingItemIndique si la personne interrogée doit répondre à la question.
setTitle(title)RatingItemDéfinit le titre de l'élément (parfois appelé texte d'en-tête dans le cas d'un SectionHeaderItem).

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()QuizFeedback|nullRenvoie les commentaires affichés aux participants lorsqu'ils répondent à une question pouvant être notée.
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.
getLeftLabel()StringObtient le libellé de la limite inférieure de l'échelle, le cas échéant.
getLowerBound()IntegerObtient la limite inférieure de l'échelle.
getPoints()IntegerRenvoie la valeur en points d'un élément pouvant être noté.
getRightLabel()StringObtient le libellé de la limite supérieure de l'échelle, le cas échéant.
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.
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 le commentaire à afficher aux participants lorsqu'ils répondent à une question évaluable qui n'a pas de réponse correcte ou incorrecte (c'est-à-dire les questions qui nécessitent une évaluation 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 qu'un devoir peut rapporter.
setRequired(enabled)ScaleItemIndique 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'un 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()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.
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.
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'un 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()QuizFeedback|nullRenvoie les commentaires affichés aux participants lorsqu'ils répondent à une question pouvant être notée.
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.
setGeneralFeedback(feedback)TextItemDéfinit le commentaire à afficher aux participants lorsqu'ils répondent à une question évaluable qui n'a pas de réponse correcte ou incorrecte (c'est-à-dire les questions qui nécessitent une évaluation 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 qu'un devoir peut rapporter.
setRequired(enabled)TextItemIndique 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'un 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 de texte doit être un nombre.
requireNumberBetween(start, end)TextValidationBuilderL'élément de texte doit être un nombre compris entre la valeur de début et la valeur de fin (incluses).
requireNumberEqualTo(number)TextValidationBuilderL'élément de texte doit être un nombre égal à la valeur spécifiée.
requireNumberGreaterThan(number)TextValidationBuilderExige que l'élément de texte soit un nombre supérieur à la valeur spécifiée.
requireNumberGreaterThanOrEqualTo(number)TextValidationBuilderExige que l'élément de texte soit un nombre supérieur ou égal à la valeur spécifiée.
requireNumberLessThan(number)TextValidationBuilderExige que l'élément de texte soit un nombre inférieur à la valeur spécifiée.
requireNumberLessThanOrEqualTo(number)TextValidationBuilderExige que l'élément de texte soit un nombre inférieur ou égal à la valeur spécifiée.
requireNumberNotBetween(start, end)TextValidationBuilderExige que l'élément de texte soit un nombre qui n'est pas compris entre la valeur de début et la valeur de fin (incluses).
requireNumberNotEqualTo(number)TextValidationBuilderExige que l'élément de texte soit un nombre différent de la valeur spécifiée.
requireTextContainsPattern(pattern)TextValidationBuilderExige que la réponse contienne un motif.
requireTextDoesNotContainPattern(pattern)TextValidationBuilderLa réponse ne doit pas contenir de modèle.
requireTextDoesNotMatchPattern(pattern)TextValidationBuilderLa réponse ne doit pas correspondre au modèle.
requireTextIsEmail()TextValidationBuilderNécessite que l'élément de texte soit une adresse e-mail.
requireTextIsUrl()TextValidationBuilderL'élément de texte doit être une URL.
requireTextLengthGreaterThanOrEqualTo(number)TextValidationBuilderExige que la longueur de la réponse soit supérieure ou égale à la valeur.
requireTextLengthLessThanOrEqualTo(number)TextValidationBuilderLa longueur de la réponse doit être inférieure à la valeur.
requireTextMatchesPattern(pattern)TextValidationBuilderLa réponse doit correspondre au modèle.
requireWholeNumber()TextValidationBuilderNécessite que l'élément de texte soit un nombre entier.

TimeItem

Méthodes

MéthodeType renvoyéBrève description
createResponse(hour, minute)ItemResponseCrée un ItemResponse pour cet élément temporel.
duplicate()TimeItemCrée une copie de cet élément et l'ajoute à la fin du formulaire.
getGeneralFeedback()QuizFeedback|nullRenvoie les commentaires affichés aux participants lorsqu'ils répondent à une question pouvant être notée.
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.
setGeneralFeedback(feedback)TimeItemDéfinit le commentaire à afficher aux participants lorsqu'ils répondent à une question évaluable qui n'a pas de réponse correcte ou incorrecte (c'est-à-dire les questions qui nécessitent une évaluation 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 qu'un devoir peut rapporter.
setRequired(enabled)TimeItemIndique 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'un 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()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.
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.
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'un SectionHeaderItem).
setVideoUrl(youtubeUrl)VideoItemDéfinit la vidéo à partir d'une URL ou d'un ID vidéo YouTube donnés.
setWidth(width)VideoItemDéfinit la largeur de la vidéo en pixels.