Class CheckboxItem

ФлажокЭлемент

Элемент вопроса, который позволяет респонденту выбрать один или несколько флажков, а также необязательное поле «другое». К элементам можно получить доступ или создать их из Form . При использовании в тесте эти элементы оцениваются автоматически.

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

Методы

Метод Тип возврата Краткое описание
clearValidation() CheckboxItem Удаляет любую проверку данных для этого элемента флажка.
createChoice(value) Choice Создает новый выбор.
createChoice(value, isCorrect) Choice Создает новый выбор.
createResponse(responses) ItemResponse Создает новый ItemResponse для этого элемента флажка.
duplicate() CheckboxItem Создает копию этого элемента и добавляет ее в конец формы.
getChoices() Choice[] Получает все варианты выбора для элемента.
getFeedbackForCorrect() QuizFeedback Возвращает обратную связь, которая отображается респондентам, когда они правильно отвечают на вопрос.
getFeedbackForIncorrect() QuizFeedback Возвращает обратную связь, которая отображается респондентам, когда они неправильно отвечают на вопрос.
getHelpText() String Получает текст справки по элементу (иногда называемый текстом описания для таких элементов макета, как ImageItems , PageBreakItems SectionHeaderItems ).
getId() Integer Получает уникальный идентификатор элемента.
getIndex() Integer Получает индекс элемента среди всех элементов формы.
getPoints() Integer Возвращает количество баллов оцениваемого элемента.
getTitle() String Получает заголовок элемента (иногда называемый текстом заголовка, в случае с SectionHeaderItem ).
getType() ItemType Получает тип элемента, представленный как ItemType .
hasOtherOption() Boolean Определяет, есть ли у элемента опция «другое».
isRequired() Boolean Определяет, должен ли респондент отвечать на вопрос.
setChoiceValues(values) CheckboxItem Устанавливает варианты выбора для элемента из массива строк.
setChoices(choices) CheckboxItem Устанавливает массив вариантов для элемента.
setFeedbackForCorrect(feedback) CheckboxItem Устанавливает обратную связь, которая будет отображаться респондентам, когда они правильно ответят на вопрос.
setFeedbackForIncorrect(feedback) CheckboxItem Устанавливает обратную связь, которая будет отображаться респондентам, когда они неправильно отвечают на вопрос.
setHelpText(text) CheckboxItem Устанавливает текст справки для элемента (иногда называемый текстом описания для таких элементов макета, как ImageItems , PageBreakItems SectionHeaderItems ).
setPoints(points) CheckboxItem Устанавливает количество баллов, которое дает оцениваемый предмет.
setRequired(enabled) CheckboxItem Устанавливает, должен ли респондент отвечать на вопрос.
setTitle(title) CheckboxItem Устанавливает заголовок элемента (иногда называемый текстом заголовка, в случае SectionHeaderItem ).
setValidation(validation) CheckboxItem Устанавливает проверку данных для этого элемента флажка.
showOtherOption(enabled) CheckboxItem Устанавливает, имеет ли элемент опцию «другое».

Подробная документация

clearValidation()

Удаляет любую проверку данных для этого элемента флажка.

Возвращаться

CheckboxItem — этот CheckboxItem для цепочки

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

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

createChoice(value)

Создает новый выбор.

Параметры

Имя Тип Описание
value String ценность выбора, которую респонденты видят в виде ярлыка при просмотре формы

Возвращаться

Choice — новый выбор

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

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

createChoice(value, isCorrect)

Создает новый выбор.

Параметры

Имя Тип Описание
value String ценность выбора, которую респонденты видят в виде ярлыка при просмотре формы
isCorrect Boolean является ли выбор правильным ответом

Возвращаться

Choice — новый выбор

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

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

createResponse(responses)

Создает новый ItemResponse для этого элемента флажка. responses на аргументы представляют собой массив String[] , содержащий значения, которые необходимо проверить. Выдает исключение, если какое-либо значение не соответствует допустимому выбору для этого элемента, если только для showOtherOption(enabled) не установлено true .

Параметры

Имя Тип Описание
responses String[] массив допустимых ответов для этого элемента с множественным выбором

Возвращаться

ItemResponse — ответ элемента

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

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

duplicate()

Создает копию этого элемента и добавляет ее в конец формы.

Возвращаться

CheckboxItem — дубликат этого CheckboxItem для цепочки

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

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

getChoices()

Получает все варианты выбора для элемента.

Возвращаться

Choice[] — массив вариантов

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

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

getFeedbackForCorrect()

Возвращает обратную связь, которая отображается респондентам, когда они правильно отвечают на вопрос.

Возвращаться

QuizFeedback — обратная связь, если она есть.

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

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

getFeedbackForIncorrect()

Возвращает обратную связь, которая отображается респондентам, когда они неправильно отвечают на вопрос.

Возвращаться

QuizFeedback — обратная связь, если она есть.

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

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

getHelpText()

Получает текст справки по элементу (иногда называемый текстом описания для таких элементов макета, как ImageItems , PageBreakItems SectionHeaderItems ).

Возвращаться

String — текст справки или текст описания элемента.

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

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

getId()

Получает уникальный идентификатор элемента.

Возвращаться

Integer — идентификатор предмета

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

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

getIndex()

Получает индекс элемента среди всех элементов формы.

Возвращаться

Integer — индекс элемента

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

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

getPoints()

Возвращает количество баллов оцениваемого элемента.

Возвращаться

Integer — количество баллов, которое приносит вопрос.

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

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

getTitle()

Получает заголовок элемента (иногда называемый текстом заголовка, в случае с SectionHeaderItem ).

Возвращаться

String — заголовок или текст заголовка элемента.

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

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

getType()

Получает тип элемента, представленный как ItemType .

Возвращаться

ItemType — тип элемента

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

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

hasOtherOption()

Определяет, есть ли у элемента опция «другое».

Возвращаться

Boolean — true , если у элемента есть опция «другой»; false , если нет

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

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

isRequired()

Определяет, должен ли респондент отвечать на вопрос.

Возвращаться

Boolean — должен ли респондент отвечать на вопрос

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

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

setChoiceValues(values)

Устанавливает варианты выбора для элемента из массива строк. Выдает исключение, если данный массив пуст.

// 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']);

Параметры

Имя Тип Описание
values String[] массив значений выбора, которые респонденты видят в виде меток при просмотре формы

Возвращаться

CheckboxItem — этот CheckboxItem для цепочки

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

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

setChoices(choices)

Устанавливает массив вариантов для элемента. Выдает исключение, если данный массив пуст или содержит 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')
]);

Параметры

Имя Тип Описание
choices Choice[] множество вариантов

Возвращаться

CheckboxItem — этот CheckboxItem для цепочки

Броски

Error — если данный массив имеет null , пуст или содержит null элемент.

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

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

setFeedbackForCorrect(feedback)

Устанавливает обратную связь, которая будет отображаться респондентам, когда они правильно ответят на вопрос.

// 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());

Параметры

Имя Тип Описание
feedback QuizFeedback новый отзыв. Нулевое значение очистит обратную связь.

Возвращаться

CheckboxItem — этот CheckboxItem для цепочки

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

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

setFeedbackForIncorrect(feedback)

Устанавливает обратную связь, которая будет отображаться респондентам, когда они неправильно отвечают на вопрос.

Параметры

Имя Тип Описание
feedback QuizFeedback новый отзыв

Возвращаться

CheckboxItem — этот CheckboxItem для цепочки

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

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

setHelpText(text)

Устанавливает текст справки для элемента (иногда называемый текстом описания для таких элементов макета, как ImageItems , PageBreakItems SectionHeaderItems ).

Параметры

Имя Тип Описание
text String новый текст справки

Возвращаться

CheckboxItem — этот CheckboxItem для цепочки

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

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

setPoints(points)

Устанавливает количество баллов, которое дает оцениваемый предмет. По умолчанию для новых элементов установлено значение 0.

Параметры

Имя Тип Описание
points Integer количество баллов, которое приносит вопрос

Возвращаться

CheckboxItem — этот CheckboxItem для цепочки

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

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

setRequired(enabled)

Устанавливает, должен ли респондент отвечать на вопрос.

Параметры

Имя Тип Описание
enabled Boolean должен ли респондент отвечать на вопрос

Возвращаться

CheckboxItem — текущий элемент (для цепочки)

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

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

setTitle(title)

Устанавливает заголовок элемента (иногда называемый текстом заголовка, в случае SectionHeaderItem ).

Параметры

Имя Тип Описание
title String новый заголовок или текст заголовка

Возвращаться

CheckboxItem — этот CheckboxItem для цепочки

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

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

setValidation(validation)

Устанавливает проверку данных для этого элемента флажка. Передача значения null или проверки без вызова требуемых функций приведет к удалению любой предыдущей проверки.

Параметры

Имя Тип Описание
validation CheckboxValidation CheckboxValidation для применения к этому элементу.

Возвращаться

CheckboxItem — этот CheckboxItem для цепочки

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

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

showOtherOption(enabled)

Устанавливает, имеет ли элемент опцию «другое». По умолчанию для нового CheckboxItem или MultipleChoiceItem установлено false .

Параметры

Имя Тип Описание
enabled Boolean true , если у элемента есть опция «другой»; false , если нет

Возвращаться

CheckboxItem — этот CheckboxItem для цепочки

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

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