Um item de pergunta que permite ao respondente marcar uma ou mais caixas de seleção, bem como um campo "outro" opcional. Os itens podem ser acessados ou criados em um Form
. Quando usados em um teste, esses itens são avaliados automaticamente.
// Open a form by ID and add a new checkbox item. var form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz'); var item = form.addCheckboxItem(); item.setTitle('What condiments would you like on your hot dog?') .setChoices([ item.createChoice('Ketchup'), item.createChoice('Mustard'), item.createChoice('Relish') ]) .showOtherOption(true);
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
clearValidation() | CheckboxItem | Remove todas as validações de dados deste item da caixa de seleção. |
createChoice(value) | Choice | Cria uma nova opção. |
createChoice(value, isCorrect) | Choice | Cria uma nova opção. |
createResponse(responses) | ItemResponse | Cria um novo ItemResponse para esse item da caixa de seleção. |
duplicate() | CheckboxItem | Cria uma cópia desse item e a anexa ao final do formulário. |
getChoices() | Choice[] | Mostra todas as opções de um item. |
getFeedbackForCorrect() | QuizFeedback | Retorna o feedback que é exibido aos entrevistados quando eles respondem corretamente a uma pergunta. |
getFeedbackForIncorrect() | QuizFeedback | Retorna o feedback que é exibido aos entrevistados quando eles respondem incorretamente a uma pergunta. |
getHelpText() | String | Recebe o texto de ajuda do item (às vezes chamado de texto de descrição para itens de layout, como ImageItems , PageBreakItems e SectionHeaderItems ). |
getId() | Integer | Recebe o identificador exclusivo do item. |
getIndex() | Integer | Recebe o índice do item entre todos os itens do formulário. |
getPoints() | Integer | Retorna a pontuação de um item com nota. |
getTitle() | String | Recebe o título do item (às vezes chamado de texto do cabeçalho, no caso de um SectionHeaderItem ). |
getType() | ItemType | Recebe o tipo do item, representado como um ItemType . |
hasOtherOption() | Boolean | Determina se o item tem uma opção "outro". |
isRequired() | Boolean | Determina se o entrevistado deve responder à pergunta. |
setChoiceValues(values) | CheckboxItem | Define as opções para um item de uma matriz de strings. |
setChoices(choices) | CheckboxItem | Define uma matriz de opções para um item. |
setFeedbackForCorrect(feedback) | CheckboxItem | Define o feedback que será mostrado aos entrevistados quando eles responderem corretamente a uma pergunta. |
setFeedbackForIncorrect(feedback) | CheckboxItem | Define o feedback a ser mostrado aos entrevistados quando eles responderem incorretamente a uma pergunta. |
setHelpText(text) | CheckboxItem | Define o texto de ajuda do item (às vezes chamado de texto de descrição para itens de layout, como ImageItems , PageBreakItems e SectionHeaderItems ). |
setPoints(points) | CheckboxItem | Define o número de pontos para um item classificável. |
setRequired(enabled) | CheckboxItem | Define se o respondente precisa responder à pergunta. |
setTitle(title) | CheckboxItem | Define o título do item (às vezes chamado de texto do cabeçalho, no caso de um SectionHeaderItem ). |
setValidation(validation) | CheckboxItem | Define a validação de dados para este item da caixa de seleção. |
showOtherOption(enabled) | CheckboxItem | Define se o item tem uma opção "outro". |
Documentação detalhada
clearValidation()
Remove todas as validações de dados deste item da caixa de seleção.
Retorno
CheckboxItem
: este CheckboxItem
, para encadeamento.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/forms.currentonly
-
https://www.googleapis.com/auth/forms
createChoice(value)
Cria uma nova opção.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
value | String | o valor da escolha, que os entrevistados veem como um rótulo ao visualizar o formulário |
Retorno
Choice
: a nova opção
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/forms.currentonly
-
https://www.googleapis.com/auth/forms
createChoice(value, isCorrect)
Cria uma nova opção.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
value | String | o valor da escolha, que os entrevistados veem como um rótulo ao visualizar o formulário |
isCorrect | Boolean | se a opção é uma resposta correta |
Retorno
Choice
: a nova opção
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/forms.currentonly
-
https://www.googleapis.com/auth/forms
createResponse(responses)
Cria um novo ItemResponse
para esse item da caixa de seleção. O argumento responses
é uma matriz String[]
que contém valores que precisam ser verificados. Uma exceção vai ser gerada se algum
valor não corresponder a uma escolha válida para esse item, a menos que showOtherOption(enabled)
esteja definido como true
.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
responses | String[] | uma matriz de respostas válidas para o item de múltipla escolha |
Retorno
ItemResponse
: a resposta do item
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/forms.currentonly
-
https://www.googleapis.com/auth/forms
duplicate()
Cria uma cópia desse item e a anexa ao final do formulário.
Retorno
CheckboxItem
: uma cópia deste CheckboxItem
, para encadeamento.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/forms.currentonly
-
https://www.googleapis.com/auth/forms
getChoices()
getFeedbackForCorrect()
Retorna o feedback que é exibido aos entrevistados quando eles respondem corretamente a uma pergunta.
Retorno
QuizFeedback
: o feedback, se houver.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/forms.currentonly
-
https://www.googleapis.com/auth/forms
getFeedbackForIncorrect()
Retorna o feedback que é exibido aos entrevistados quando eles respondem incorretamente a uma pergunta.
Retorno
QuizFeedback
: o feedback, se houver.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/forms.currentonly
-
https://www.googleapis.com/auth/forms
getHelpText()
Recebe o texto de ajuda do item (às vezes chamado de texto de descrição para itens de layout, como ImageItems
, PageBreakItems
e SectionHeaderItems
).
Retorno
String
: o texto de ajuda ou de descrição do item
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/forms.currentonly
-
https://www.googleapis.com/auth/forms
getId()
Recebe o identificador exclusivo do item.
Retorno
Integer
: ID do item
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/forms.currentonly
-
https://www.googleapis.com/auth/forms
getIndex()
Recebe o índice do item entre todos os itens do formulário.
Retorno
Integer
: o índice do item
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/forms.currentonly
-
https://www.googleapis.com/auth/forms
getPoints()
Retorna a pontuação de um item com nota.
Retorno
Integer
: o número de pontos de uma pergunta.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/forms.currentonly
-
https://www.googleapis.com/auth/forms
getTitle()
Recebe o título do item (às vezes chamado de texto do cabeçalho, no caso de um SectionHeaderItem
).
Retorno
String
: título ou texto do cabeçalho do item.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/forms.currentonly
-
https://www.googleapis.com/auth/forms
getType()
hasOtherOption()
Determina se o item tem uma opção "outro".
Retorno
Boolean
: true
se o item tiver uma opção "outro"; false
se não tiver
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/forms.currentonly
-
https://www.googleapis.com/auth/forms
isRequired()
Determina se o entrevistado deve responder à pergunta.
Retorno
Boolean
: se o participante precisa responder à pergunta.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/forms.currentonly
-
https://www.googleapis.com/auth/forms
setChoiceValues(values)
Define as opções para um item de uma matriz de strings. Lança uma exceção se a matriz fornecida estiver vazia.
// Open a form by ID and add a new list item. var form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz'); var item = form.addListItem(); item.setTitle('Do you prefer cats or dogs?'); item.setChoiceValues(['Dogs', 'Cats']);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
values | String[] | a matriz de valores de escolha, que os entrevistados veem como rótulos ao visualizar o formulário |
Retorno
CheckboxItem
: este CheckboxItem
, para encadeamento.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/forms.currentonly
-
https://www.googleapis.com/auth/forms
setChoices(choices)
Define uma matriz de opções para um item. Lança uma exceção se a matriz fornecida estiver vazia ou contiver um elemento null
.
// Open a form by ID and add a new list item. var form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz'); var item = form.addListItem(); item.setTitle('Do you prefer cats or dogs?') item.setChoices([ item.createChoice('Cats'), item.createChoice('Dogs') ]);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
choices | Choice[] | uma matriz de opções |
Retorno
CheckboxItem
: este CheckboxItem
, para encadeamento.
Gera
Error
: se a matriz fornecida for null
, vazia ou contiver um elemento null
.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/forms.currentonly
-
https://www.googleapis.com/auth/forms
setFeedbackForCorrect(feedback)
Define o feedback que será mostrado aos entrevistados quando eles responderem corretamente a uma pergunta.
// Open a form by ID and add a new list item. var form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz'); var item = form.addListItem(); item.setTitle('Do you prefer cats or dogs?'); // Set "Dogs" as the correct answer to this question. item.setChoices([ item.createChoice('Dogs', true), item.createChoice('Cats', false)]); // Add feedback which will be shown for correct responses; ie "Dogs". item.setFeedbackForCorrect( FormApp.createFeedback().setDisplayText("Dogs rule, cats drool.").build());
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
feedback | QuizFeedback | o novo feedback. Um valor nulo vai apagar o feedback. |
Retorno
CheckboxItem
: este CheckboxItem
, para encadeamento.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/forms.currentonly
-
https://www.googleapis.com/auth/forms
setFeedbackForIncorrect(feedback)
Define o feedback a ser mostrado aos entrevistados quando eles responderem incorretamente a uma pergunta.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
feedback | QuizFeedback | o novo feedback |
Retorno
CheckboxItem
: este CheckboxItem
, para encadeamento.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/forms.currentonly
-
https://www.googleapis.com/auth/forms
setHelpText(text)
Define o texto de ajuda do item (às vezes chamado de texto de descrição para itens de layout, como ImageItems
, PageBreakItems
e SectionHeaderItems
).
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
text | String | o novo texto de ajuda |
Retorno
CheckboxItem
: este CheckboxItem
, para encadeamento.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/forms.currentonly
-
https://www.googleapis.com/auth/forms
setPoints(points)
Define o número de pontos para um item classificável. O padrão para novos itens é 0.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
points | Integer | o número de pontos em que um item da pergunta vale |
Retorno
CheckboxItem
: este CheckboxItem
, para encadeamento.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/forms.currentonly
-
https://www.googleapis.com/auth/forms
setRequired(enabled)
Define se o respondente precisa responder à pergunta.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
enabled | Boolean | se o respondente deve responder à pergunta |
Retorno
CheckboxItem
: o item atual (para encadeamento).
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/forms.currentonly
-
https://www.googleapis.com/auth/forms
setTitle(title)
Define o título do item (às vezes chamado de texto do cabeçalho, no caso de um SectionHeaderItem
).
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
title | String | o novo título ou texto do cabeçalho |
Retorno
CheckboxItem
: este CheckboxItem
, para encadeamento.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/forms.currentonly
-
https://www.googleapis.com/auth/forms
setValidation(validation)
Define a validação de dados para este item da caixa de seleção. Transmitir "null" ou uma validação sem nenhuma função de exigência chamada vai remover qualquer validação anterior.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
validation | CheckboxValidation | uma CheckboxValidation para aplicar a este item. |
Retorno
CheckboxItem
: este CheckboxItem
, para encadeamento.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/forms.currentonly
-
https://www.googleapis.com/auth/forms
showOtherOption(enabled)
Define se o item tem uma opção "outro". O padrão para um novo CheckboxItem
ou
MultipleChoiceItem
é false
.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
enabled | Boolean | true se o item tiver uma opção "outro"; caso contrário, false |
Retorno
CheckboxItem
: este CheckboxItem
, para encadeamento.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/forms.currentonly
-
https://www.googleapis.com/auth/forms