Class TimeItem | Apps Script | Google for Developers (original) (raw)
Class TimeItem
Stay organized with collections Save and categorize content based on your preferences.
TimeItem
A question item that allows the respondent to indicate a time of day. Items can be accessed or created from a [Form](/apps-script/reference/forms/form). When used in a quiz, these items are graded.
// Open a form by ID and add a new time item. const form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz'); const item = form.addTimeItem(); item.setTitle('What time do you usually wake up in the morning?');
Methods
| Method | Return type | Brief description |
|---|---|---|
| createResponse(hour, minute) | ItemResponse | Creates a new ItemResponse for this time item. |
| duplicate() | TimeItem | Creates a copy of this item and appends it to the end of the form. |
| getGeneralFeedback() | QuizFeedback | Returns the feedback that is shown to respondents when they respond to a gradeable question. |
| getHelpText() | String | Gets the item's help text (sometimes called description text for layout items like ImageItems, PageBreakItems, and SectionHeaderItems). |
| getId() | Integer | Gets the item's unique identifier. |
| getIndex() | Integer | Gets the index of the item among all the items in the form. |
| getPoints() | Integer | Returns the point value of a gradeable item. |
| getTitle() | String | Gets the item's title (sometimes called header text, in the case of a SectionHeaderItem). |
| getType() | ItemType | Gets the item's type, represented as an ItemType. |
| isRequired() | Boolean | Determines whether the respondent must answer the question. |
| setGeneralFeedback(feedback) | TimeItem | Sets the feedback to be shown to respondents when they respond to a gradeable question that doesn't have a correct or incorrect answer (ie questions that require manual grading). |
| setHelpText(text) | TimeItem | Sets the item's help text (sometimes called description text for layout items like ImageItems, PageBreakItems, and SectionHeaderItems). |
| setPoints(points) | TimeItem | Sets the number of points a gradeable item is worth. |
| setRequired(enabled) | TimeItem | Sets whether the respondent must answer the question. |
| setTitle(title) | TimeItem | Sets the item's title (sometimes called header text, in the case of a SectionHeaderItem). |
Detailed documentation
createResponse(hour, minute)
Creates a new [ItemResponse](/apps-script/reference/forms/item-response) for this time item. The arguments hour and minute are best represented as integers from 0 to 23 and from 0 to59, respectively. If they exceed those bounds, they behave as a clock would: for example, 10, 90 is interpreted as 11:30, and -1, 60 is interpreted as 00:00.
Parameters
| Name | Type | Description |
|---|---|---|
| hour | Integer | the hour, represented as an integer from 0 to 23 |
| minute | Integer | the minute of the hour, represented as an integer from 0 to 59 |
Return
[ItemResponse](/apps-script/reference/forms/item-response) — the item response
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/forms.currentonlyhttps://www.googleapis.com/auth/forms
duplicate()
Creates a copy of this item and appends it to the end of the form.
Return
[TimeItem](#) — a duplicate of this [TimeItem](#), for chaining
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/forms.currentonlyhttps://www.googleapis.com/auth/forms
getGeneralFeedback()
Returns the feedback that is shown to respondents when they respond to a gradeable question.
Return
[QuizFeedback](/apps-script/reference/forms/quiz-feedback) — the feedback, if any.
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/forms.currentonlyhttps://www.googleapis.com/auth/forms
getHelpText()
Gets the item's help text (sometimes called description text for layout items like [ImageItems](/apps-script/reference/forms/image-item), [PageBreakItems](/apps-script/reference/forms/page-break-item), and [SectionHeaderItems](/apps-script/reference/forms/section-header-item)).
Return
String — the item's help text or description text
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/forms.currentonlyhttps://www.googleapis.com/auth/forms
getId()
Gets the item's unique identifier.
Return
Integer — the item's ID
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/forms.currentonlyhttps://www.googleapis.com/auth/forms
getIndex()
Gets the index of the item among all the items in the form.
Return
Integer — the index of the item
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/forms.currentonlyhttps://www.googleapis.com/auth/forms
getPoints()
Returns the point value of a gradeable item.
Return
Integer — the number of points a question is worth.
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/forms.currentonlyhttps://www.googleapis.com/auth/forms
getTitle()
Gets the item's title (sometimes called header text, in the case of a [SectionHeaderItem](/apps-script/reference/forms/section-header-item)).
Return
String — the item's title or header text
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/forms.currentonlyhttps://www.googleapis.com/auth/forms
getType()
Gets the item's type, represented as an [ItemType](/apps-script/reference/forms/item-type).
Return
[ItemType](/apps-script/reference/forms/item-type) — the item's type
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/forms.currentonlyhttps://www.googleapis.com/auth/forms
isRequired()
Determines whether the respondent must answer the question.
Return
Boolean — whether the respondent must answer the question
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/forms.currentonlyhttps://www.googleapis.com/auth/forms
setGeneralFeedback(feedback)
Sets the feedback to be shown to respondents when they respond to a gradeable question that doesn't have a correct or incorrect answer (ie questions that require manual grading).
Parameters
| Name | Type | Description |
|---|---|---|
| feedback | QuizFeedback | the new feedback |
Return
[TimeItem](#) — this [TimeItem](#), for chaining
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/forms.currentonlyhttps://www.googleapis.com/auth/forms
setHelpText(text)
Sets the item's help text (sometimes called description text for layout items like [ImageItems](/apps-script/reference/forms/image-item), [PageBreakItems](/apps-script/reference/forms/page-break-item), and [SectionHeaderItems](/apps-script/reference/forms/section-header-item)).
Parameters
| Name | Type | Description |
|---|---|---|
| text | String | the new help text |
Return
[TimeItem](#) — this [TimeItem](#), for chaining
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/forms.currentonlyhttps://www.googleapis.com/auth/forms
setPoints(points)
Sets the number of points a gradeable item is worth. The default for new items is 0.
Parameters
| Name | Type | Description |
|---|---|---|
| points | Integer | the number of a points a question item is worth |
Return
[TimeItem](#) — this [TimeItem](#), for chaining
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/forms.currentonlyhttps://www.googleapis.com/auth/forms
setRequired(enabled)
Sets whether the respondent must answer the question.
Parameters
| Name | Type | Description |
|---|---|---|
| enabled | Boolean | whether the respondent must answer the question |
Return
[TimeItem](#) — the current item (for chaining)
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/forms.currentonlyhttps://www.googleapis.com/auth/forms
setTitle(title)
Sets the item's title (sometimes called header text, in the case of a [SectionHeaderItem](/apps-script/reference/forms/section-header-item)).
Parameters
| Name | Type | Description |
|---|---|---|
| title | String | the new title or header text |
Return
[TimeItem](#) — this [TimeItem](#), for chaining
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/forms.currentonlyhttps://www.googleapis.com/auth/forms
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-12-02 UTC.