Class CheckboxItem

CheckboxItem

Um item de pergunta que permite ao respondente marcar uma ou mais caixas de seleção, bem como uma "outro" opcional . Os itens podem ser acessados ou criados em um Form. Quando usada em um teste, esses itens recebem notas automáticas. 

// 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étodoTipo de retornoBreve descrição
clearValidation()CheckboxItemRemove qualquer validação de dados para este item da caixa de seleção.
createChoice(value)ChoiceCria uma nova opção.
createChoice(value, isCorrect)ChoiceCria uma nova opção.
createResponse(responses)ItemResponseCria um novo ItemResponse para esse item da caixa de seleção.
duplicate()CheckboxItemCria uma cópia desse item e a anexa ao final do formulário.
getChoices()Choice[]Recebe todas as opções de um item.
getFeedbackForCorrect()QuizFeedbackRetorna o feedback mostrado aos participantes quando eles respondem corretamente a uma pergunta.
getFeedbackForIncorrect()QuizFeedbackRetorna o feedback mostrado aos participantes quando eles respondem incorretamente a uma pergunta.
getHelpText()StringRecebe o texto de ajuda do item (às vezes chamado de texto de descrição para itens de layout, como ImageItems, PageBreakItems e SectionHeaderItems).
getId()IntegerExtrai o identificador exclusivo do item.
getIndex()IntegerRecebe o índice do item entre todos os itens do formulário.
getPoints()IntegerRetorna a pontuação de um item que pode ser avaliado.
getTitle()StringRecebe o título do item (às vezes chamado de texto de cabeçalho, no caso de uma SectionHeaderItem).
getType()ItemTypeRecebe o tipo do item, representado como ItemType.
hasOtherOption()BooleanDetermina se o item tem uma "outra" é a melhor opção.
isRequired()BooleanDetermina se o respondente precisa responder à pergunta.
setChoiceValues(values)CheckboxItemDefine as opções para um item a partir de uma matriz de strings.
setChoices(choices)CheckboxItemDefine uma matriz de opções para um item.
setFeedbackForCorrect(feedback)CheckboxItemDefine o feedback que será mostrado aos participantes quando eles responderem corretamente a uma pergunta.
setFeedbackForIncorrect(feedback)CheckboxItemDefine o feedback que será mostrado aos participantes quando eles responderem incorretamente a uma pergunta.
setHelpText(text)CheckboxItemDefine 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)CheckboxItemDefine o número de pontos de um item que pode ser avaliado.
setRequired(enabled)CheckboxItemDefine se o participante precisa responder à pergunta.
setTitle(title)CheckboxItemDefine o título do item, às vezes chamado de texto de cabeçalho, no caso de uma SectionHeaderItem.
setValidation(validation)CheckboxItemDefine a validação de dados para este item da caixa de seleção.
showOtherOption(enabled)CheckboxItemDefine se o item tem uma "outra" é a melhor opção.

Documentação detalhada

clearValidation()

Remove qualquer validação de dados para este item da caixa de seleção.

Retornar

CheckboxItem: este CheckboxItem, para encadeamento

Autorização

Os scripts que usam esse método precisam de 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

NomeTipoDescrição
valueStringo valor da opção, que os entrevistados veem como um marcador ao visualizar o formulário

Retornar

Choice: a nova opção

Autorização

Os scripts que usam esse método precisam de 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

NomeTipoDescrição
valueStringo valor da opção, que os entrevistados veem como um marcador ao visualizar o formulário
isCorrectBooleanse a opção é uma resposta correta

Retornar

Choice: a nova opção

Autorização

Os scripts que usam esse método precisam de 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 é um Matriz String[] contendo valores que precisam ser verificados. Gera uma exceção, se houver o valor não corresponde a uma escolha válida para este item, a menos que showOtherOption(enabled) seja definido como true.

Parâmetros

NomeTipoDescrição
responsesString[]uma matriz de respostas válidas para este item de múltipla escolha

Retornar

ItemResponse: a resposta do item.

Autorização

Os scripts que usam esse método precisam de 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.

Retornar

CheckboxItem: uma cópia deste CheckboxItem para encadeamento.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

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

getChoices()

Recebe todas as opções de um item.

Retornar

Choice[]: uma matriz de opções.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

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

getFeedbackForCorrect()

Retorna o feedback mostrado aos participantes quando eles respondem corretamente a uma pergunta.

Retornar

QuizFeedback: o feedback, se houver.

Autorização

Os scripts que usam esse método precisam de 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 mostrado aos participantes quando eles respondem incorretamente a uma pergunta.

Retornar

QuizFeedback: o feedback, se houver.

Autorização

Os scripts que usam esse método precisam de 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).

Retornar

String: o texto de ajuda ou de descrição do item.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

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

getId()

Extrai o identificador exclusivo do item.

Retornar

Integer: o código do item.

Autorização

Os scripts que usam esse método precisam de 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.

Retornar

Integer: o índice do item.

Autorização

Os scripts que usam esse método precisam de 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 que pode ser avaliado.

Retornar

Integer: o número de pontos de uma pergunta.

Autorização

Os scripts que usam esse método precisam de 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 de cabeçalho, no caso de uma SectionHeaderItem).

Retornar

String: o título ou texto do cabeçalho do item

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

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

getType()

Recebe o tipo do item, representado como ItemType.

Retornar

ItemType: o tipo do item.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

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

hasOtherOption()

Determina se o item tem uma "outra" é a melhor opção.

Retornar

Boolean — true se o item tiver um "outro" opção false se não for

Autorização

Os scripts que usam esse método precisam de 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 respondente precisa responder à pergunta.

Retornar

Boolean: se o participante precisa responder à pergunta.

Autorização

Os scripts que usam esse método precisam de 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 a partir de uma matriz de strings. Gera uma exceção se a matriz fornecida está vazio. 

// 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

NomeTipoDescrição
valuesString[]a matriz de valores de escolha, que os entrevistados veem como rótulos ao visualizar o formulário

Retornar

CheckboxItem: este CheckboxItem, para encadeamento

Autorização

Os scripts que usam esse método precisam de 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 está vazia ou contém 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

NomeTipoDescrição
choicesChoice[]uma matriz de opções

Retornar

CheckboxItem: este CheckboxItem, para encadeamento

Gera

Error: se a matriz fornecida for null, estiver vazia ou contiver um elemento null.

Autorização

Os scripts que usam esse método precisam de 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 participantes 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

NomeTipoDescrição
feedbackQuizFeedbacko novo feedback. Um valor nulo limpará o feedback.

Retornar

CheckboxItem: este CheckboxItem, para encadeamento

Autorização

Os scripts que usam esse método precisam de 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 que será mostrado aos participantes quando eles responderem incorretamente a uma pergunta.

Parâmetros

NomeTipoDescrição
feedbackQuizFeedbacko novo feedback

Retornar

CheckboxItem: este CheckboxItem, para encadeamento

Autorização

Os scripts que usam esse método precisam de 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

NomeTipoDescrição
textStringo novo texto de ajuda

Retornar

CheckboxItem: este CheckboxItem, para encadeamento

Autorização

Os scripts que usam esse método precisam de 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 de um item que pode ser avaliado. O padrão para novos itens é 0.

Parâmetros

NomeTipoDescrição
pointsIntegero número de pontos que um item de pergunta vale

Retornar

CheckboxItem: este CheckboxItem, para encadeamento

Autorização

Os scripts que usam esse método precisam de 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 participante precisa responder à pergunta.

Parâmetros

NomeTipoDescrição
enabledBooleanse o entrevistado deve responder à pergunta

Retornar

CheckboxItem: o item atual (para encadeamento).

Autorização

Os scripts que usam esse método precisam de 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 de cabeçalho, no caso de uma SectionHeaderItem.

Parâmetros

NomeTipoDescrição
titleStringo novo título ou texto do cabeçalho

Retornar

CheckboxItem: este CheckboxItem, para encadeamento

Autorização

Os scripts que usam esse método precisam de 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 um valor nulo ou uma validação sem exigem funções chamadas removem qualquer validação anterior.

Parâmetros

NomeTipoDescrição
validationCheckboxValidationuma CheckboxValidation para aplicar a esse item.

Retornar

CheckboxItem: este CheckboxItem, para encadeamento

Autorização

Os scripts que usam esse método precisam de 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 "outra" é a melhor opção. O padrão para uma nova CheckboxItem ou O valor da coluna MultipleChoiceItem é false.

Parâmetros

NomeTipoDescrição
enabledBooleantrue se o item tiver uma "outra" opção false caso contrário

Retornar

CheckboxItem: este CheckboxItem, para encadeamento

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

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