com.google.api.services.forms.v1.model

Class Form

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.forms.v1.model.Form

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class Form
extends com.google.api.client.json.GenericJson

A Google Forms document. A form is created in Drive, and deleting a form or changing its access protections is done via the [Drive API](https://developers.google.com/drive/api/v3/about-sdk).

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Google Forms API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
Form()

Method Summary

Modifier and Type	Method and Description
Form	clone()
String	getFormId() Output only.
Info	getInfo() Required.
List<Item>	getItems() Required.
String	getLinkedSheetId() Output only.
PublishSettings	getPublishSettings() Output only.
String	getResponderUri() Output only.
String	getRevisionId() Output only.
FormSettings	getSettings() The form's settings.
Form	set(String fieldName, Object value)
Form	setFormId(String formId) Output only.
Form	setInfo(Info info) Required.
Form	setItems(List<Item> items) Required.
Form	setLinkedSheetId(String linkedSheetId) Output only.
Form	setPublishSettings(PublishSettings publishSettings) Output only.
Form	setResponderUri(String responderUri) Output only.
Form	setRevisionId(String revisionId) Output only.
Form	setSettings(FormSettings settings) The form's settings.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

Form

public Form()

Method Detail

getFormId

public String getFormId()

Output only. The form ID.

Returns:

value or null for none

setFormId

public Form setFormId(String formId)

Output only. The form ID.

Parameters:

formId - formId or null for none

getInfo

public Info getInfo()

Required. The title and description of the form.

Returns:

value or null for none

setInfo

public Form setInfo(Info info)

Required. The title and description of the form.

Parameters:

info - info or null for none

getItems

public List<Item> getItems()

Required. A list of the form's items, which can include section headers, questions, embedded media, etc.

Returns:

value or null for none

setItems

public Form setItems(List<Item> items)

Required. A list of the form's items, which can include section headers, questions, embedded media, etc.

Parameters:

items - items or null for none

getLinkedSheetId

public String getLinkedSheetId()

Output only. The ID of the linked Google Sheet which is accumulating responses from this Form (if such a Sheet exists).

Returns:

value or null for none

setLinkedSheetId

public Form setLinkedSheetId(String linkedSheetId)

Output only. The ID of the linked Google Sheet which is accumulating responses from this Form (if such a Sheet exists).

Parameters:

linkedSheetId - linkedSheetId or null for none

getPublishSettings

public PublishSettings getPublishSettings()

Output only. The publishing settings for a form. This field isn't set for legacy forms because they don't have the publish_settings field. All newly created forms support publish settings. Forms with publish_settings value set can call SetPublishSettings API to publish or unpublish the form.

Returns:

value or null for none

setPublishSettings

public Form setPublishSettings(PublishSettings publishSettings)

Output only. The publishing settings for a form. This field isn't set for legacy forms because they don't have the publish_settings field. All newly created forms support publish settings. Forms with publish_settings value set can call SetPublishSettings API to publish or unpublish the form.

Parameters:

publishSettings - publishSettings or null for none

getResponderUri

public String getResponderUri()

Output only. The form URI to share with responders. This opens a page that allows the user to submit responses but not edit the questions. For forms that have publish_settings value set, this is the published form URI.

Returns:

value or null for none

setResponderUri

public Form setResponderUri(String responderUri)

Output only. The form URI to share with responders. This opens a page that allows the user to submit responses but not edit the questions. For forms that have publish_settings value set, this is the published form URI.

Parameters:

responderUri - responderUri or null for none

getRevisionId

public String getRevisionId()

Output only. The revision ID of the form. Used in the WriteControl in update requests to identify the revision on which the changes are based. The format of the revision ID may change over time, so it should be treated opaquely. A returned revision ID is only guaranteed to be valid for 24 hours after it has been returned and cannot be shared across users. If the revision ID is unchanged between calls, then the form *content* has not changed. Conversely, a changed ID (for the same form and user) usually means the form *content* has been updated; however, a changed ID can also be due to internal factors such as ID format changes. Form content excludes form metadata, including: * sharing settings (who has access to the form) * publish_settings (if the form supports publishing and if it is published)

Returns:

value or null for none

setRevisionId

public Form setRevisionId(String revisionId)

Output only. The revision ID of the form. Used in the WriteControl in update requests to identify the revision on which the changes are based. The format of the revision ID may change over time, so it should be treated opaquely. A returned revision ID is only guaranteed to be valid for 24 hours after it has been returned and cannot be shared across users. If the revision ID is unchanged between calls, then the form *content* has not changed. Conversely, a changed ID (for the same form and user) usually means the form *content* has been updated; however, a changed ID can also be due to internal factors such as ID format changes. Form content excludes form metadata, including: * sharing settings (who has access to the form) * publish_settings (if the form supports publishing and if it is published)

Parameters:

revisionId - revisionId or null for none

getSettings

public FormSettings getSettings()

The form's settings. This must be updated with UpdateSettingsRequest; it is ignored during CreateForm and UpdateFormInfoRequest.

Returns:

value or null for none

setSettings

public Form setSettings(FormSettings settings)

The form's settings. This must be updated with UpdateSettingsRequest; it is ignored during CreateForm and UpdateFormInfoRequest.

Parameters:

settings - settings or null for none

set

public Form set(String fieldName,
                Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public Form clone()

Overrides:

clone in class com.google.api.client.json.GenericJson