com.google.api.services.docs.v1.model

Class Post

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.docs.v1.model.Post

All Implemented Interfaces:

Cloneable, Map<String,Object>

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

Represents a single post in a comment or suggestion thread.

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 Docs 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
Post()

Method Summary

Modifier and Type	Method and Description
Post	clone()
String	getAssigneeEmail() Optional.
PostAuthor	getAuthor() Output only.
String	getCommentAction() Optional.
String	getContent() The content of the post.
String	getContentHtml() Output only.
String	getCreateTime() Output only.
Boolean	getDeleted() Output only.
Boolean	getFromCopiedDocument() Output only.
Boolean	getFromDocumentComparison() Output only.
Boolean	getFromImportedDocument() Output only.
String	getPostId() Output only.
String	getSuggestionAction() Output only.
String	getUpdateTime() Output only.
Post	set(String fieldName, Object value)
Post	setAssigneeEmail(String assigneeEmail) Optional.
Post	setAuthor(PostAuthor author) Output only.
Post	setCommentAction(String commentAction) Optional.
Post	setContent(String content) The content of the post.
Post	setContentHtml(String contentHtml) Output only.
Post	setCreateTime(String createTime) Output only.
Post	setDeleted(Boolean deleted) Output only.
Post	setFromCopiedDocument(Boolean fromCopiedDocument) Output only.
Post	setFromDocumentComparison(Boolean fromDocumentComparison) Output only.
Post	setFromImportedDocument(Boolean fromImportedDocument) Output only.
Post	setPostId(String postId) Output only.
Post	setSuggestionAction(String suggestionAction) Output only.
Post	setUpdateTime(String updateTime) Output only.

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

Post

public Post()

Method Detail

getAssigneeEmail

public String getAssigneeEmail()

Optional. The email of the user who is being newly assigned to the thread as part of this post. Returns a 400 bad request error if: - The parent thread is a CommentThread whose headPost does not have an assignee. - The parent thread is a SuggestionThread. - commentAction is specified as `RESOLVE` or `REOPEN`. - `assigneeEmail` exceeds 2048 UTF-8 code units.

Returns:

value or null for none

setAssigneeEmail

public Post setAssigneeEmail(String assigneeEmail)

Optional. The email of the user who is being newly assigned to the thread as part of this post. Returns a 400 bad request error if: - The parent thread is a CommentThread whose headPost does not have an assignee. - The parent thread is a SuggestionThread. - commentAction is specified as `RESOLVE` or `REOPEN`. - `assigneeEmail` exceeds 2048 UTF-8 code units.

Parameters:

assigneeEmail - assigneeEmail or null for none

getAuthor

public PostAuthor getAuthor()

Output only. The user who created the post.

Returns:

value or null for none

setAuthor

public Post setAuthor(PostAuthor author)

Output only. The user who created the post.

Parameters:

author - author or null for none

getCommentAction

public String getCommentAction()

Optional. The action type for comment posts.

Returns:

value or null for none

setCommentAction

public Post setCommentAction(String commentAction)

Optional. The action type for comment posts.

Parameters:

commentAction - commentAction or null for none

getContent

public String getContent()

The content of the post. Required to be non-empty if commentAction is not `RESOLVE` or `REOPEN`. This text content will be handled similarly to comments created in the Docs editor. It will have similar behaviors for formatting, notifications, etc. May not exceed 2048 UTF-8 code units.

Returns:

value or null for none

setContent

public Post setContent(String content)

The content of the post. Required to be non-empty if commentAction is not `RESOLVE` or `REOPEN`. This text content will be handled similarly to comments created in the Docs editor. It will have similar behaviors for formatting, notifications, etc. May not exceed 2048 UTF-8 code units.

Parameters:

content - content or null for none

getContentHtml

public String getContentHtml()

Output only. The content of the post as HTML.

Returns:

value or null for none

setContentHtml

public Post setContentHtml(String contentHtml)

Output only. The content of the post as HTML.

Parameters:

contentHtml - contentHtml or null for none

getCreateTime

public String getCreateTime()

Output only. The time the post was created.

Returns:

value or null for none

setCreateTime

public Post setCreateTime(String createTime)

Output only. The time the post was created.

Parameters:

createTime - createTime or null for none

getDeleted

public Boolean getDeleted()

Output only. Whether the post is deleted. If `true`, content and author fields will be empty.

Returns:

value or null for none

setDeleted

public Post setDeleted(Boolean deleted)

Output only. Whether the post is deleted. If `true`, content and author fields will be empty.

Parameters:

deleted - deleted or null for none

getFromCopiedDocument

public Boolean getFromCopiedDocument()

Output only. Whether the post is from a copied document. This field cannot be set directly by callers.

Returns:

value or null for none

setFromCopiedDocument

public Post setFromCopiedDocument(Boolean fromCopiedDocument)

Output only. Whether the post is from a copied document. This field cannot be set directly by callers.

Parameters:

fromCopiedDocument - fromCopiedDocument or null for none

getFromDocumentComparison

public Boolean getFromDocumentComparison()

Output only. Whether the post is from a document comparison. This field cannot be set directly by callers.

Returns:

value or null for none

setFromDocumentComparison

public Post setFromDocumentComparison(Boolean fromDocumentComparison)

Output only. Whether the post is from a document comparison. This field cannot be set directly by callers.

Parameters:

fromDocumentComparison - fromDocumentComparison or null for none

getFromImportedDocument

public Boolean getFromImportedDocument()

Output only. Whether the post is from an imported document. This field cannot be set directly by callers.

Returns:

value or null for none

setFromImportedDocument

public Post setFromImportedDocument(Boolean fromImportedDocument)

Output only. Whether the post is from an imported document. This field cannot be set directly by callers.

Parameters:

fromImportedDocument - fromImportedDocument or null for none

getPostId

public String getPostId()

Output only. The unique ID of the post.

Returns:

value or null for none

setPostId

public Post setPostId(String postId)

Output only. The unique ID of the post.

Parameters:

postId - postId or null for none

getSuggestionAction

public String getSuggestionAction()

Output only. The action type for suggestion posts.

Returns:

value or null for none

setSuggestionAction

public Post setSuggestionAction(String suggestionAction)

Output only. The action type for suggestion posts.

Parameters:

suggestionAction - suggestionAction or null for none

getUpdateTime

public String getUpdateTime()

Output only. The time the post was last updated.

Returns:

value or null for none

setUpdateTime

public Post setUpdateTime(String updateTime)

Output only. The time the post was last updated.

Parameters:

updateTime - updateTime or null for none

set

public Post set(String fieldName,
                Object value)

Overrides:

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

clone

public Post clone()

Overrides:

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