com.google.api.services.drive

Class Drive.Comments.List

java.lang.Object

java.util.AbstractMap<java.lang.String,java.lang.Object>

com.google.api.client.util.GenericData

com.google.api.client.googleapis.services.AbstractGoogleClientRequest<T>

com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest<T>

com.google.api.services.drive.DriveRequest<CommentList>

com.google.api.services.drive.Drive.Comments.List

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>

Enclosing class:

Drive.Comments

public class Drive.Comments.List
extends DriveRequest<CommentList>

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

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

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

java.util.Map.Entry<K,V>

Field Summary

Fields inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

USER_AGENT_SUFFIX

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Drive.Comments.List(java.lang.String fileId) Lists a file's comments.

Method Summary

Methods

Modifier and Type	Method and Description
com.google.api.client.http.HttpRequest	buildHttpRequestUsingHead()
com.google.api.client.http.HttpResponse	executeUsingHead()
java.lang.String	getFileId() The ID of the file.
java.lang.Boolean	getIncludeDeleted() If set, all comments and replies, including deleted comments and replies (with content stripped) will be returned.
java.lang.Integer	getMaxResults() The maximum number of discussions to include in the response, used for paging.
java.lang.String	getPageToken() The continuation token, used to page through large result sets.
java.lang.String	getUpdatedMin() Only discussions that were updated after this timestamp will be returned.
boolean	isIncludeDeleted() Convenience method that returns only Boolean.TRUE or Boolean.FALSE.
Drive.Comments.List	set(java.lang.String parameterName, java.lang.Object value)
Drive.Comments.List	setAlt(java.lang.String alt) Data format for the response.
Drive.Comments.List	setFields(java.lang.String fields) Selector specifying which fields to include in a partial response.
Drive.Comments.List	setFileId(java.lang.String fileId) The ID of the file.
Drive.Comments.List	setIncludeDeleted(java.lang.Boolean includeDeleted) If set, all comments and replies, including deleted comments and replies (with content stripped) will be returned.
Drive.Comments.List	setKey(java.lang.String key) API key.
Drive.Comments.List	setMaxResults(java.lang.Integer maxResults) The maximum number of discussions to include in the response, used for paging.
Drive.Comments.List	setOauthToken(java.lang.String oauthToken) OAuth 2.0 token for the current user.
Drive.Comments.List	setPageToken(java.lang.String pageToken) The continuation token, used to page through large result sets.
Drive.Comments.List	setPrettyPrint(java.lang.Boolean prettyPrint) Returns response with indentations and line breaks.
Drive.Comments.List	setQuotaUser(java.lang.String quotaUser) Available to use for quota purposes for server-side applications.
Drive.Comments.List	setUpdatedMin(java.lang.String updatedMin) Only discussions that were updated after this timestamp will be returned.
Drive.Comments.List	setUserIp(java.lang.String userIp) IP address of the site where the request originates.

Methods inherited from class com.google.api.services.drive.DriveRequest

getAbstractGoogleClient, getAlt, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUserIp, setDisableGZipContent, setRequestHeaders

Methods inherited from class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest

getJsonContent, newExceptionOnError, queue

Methods inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

buildHttpRequest, buildHttpRequestUrl, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, getDisableGZipContent, getHttpContent, getLastResponseHeaders, getLastStatusCode, getLastStatusMessage, getMediaHttpDownloader, getMediaHttpUploader, getRequestHeaders, getRequestMethod, getResponseClass, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue

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

clone, entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, toString, values

Methods inherited from class java.lang.Object

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

Constructor Detail

Drive.Comments.List

protected Drive.Comments.List(java.lang.String fileId)

Lists a file's comments. Create a request for the method "comments.list". This request holds the parameters needed by the the drive server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Drive.initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest) must be called to initialize this instance immediately after invoking the constructor.

Parameters:

fileId - The ID of the file.

Since:

1.13

Method Detail

executeUsingHead

public com.google.api.client.http.HttpResponse executeUsingHead()
                                                         throws java.io.IOException

Overrides:

executeUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<CommentList>

Throws:

java.io.IOException

buildHttpRequestUsingHead

public com.google.api.client.http.HttpRequest buildHttpRequestUsingHead()
                                                                 throws java.io.IOException

Overrides:

buildHttpRequestUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<CommentList>

Throws:

java.io.IOException

setAlt

public Drive.Comments.List setAlt(java.lang.String alt)

Description copied from class: DriveRequest

Data format for the response.

Overrides:

setAlt in class DriveRequest<CommentList>

setFields

public Drive.Comments.List setFields(java.lang.String fields)

Description copied from class: DriveRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class DriveRequest<CommentList>

setKey

public Drive.Comments.List setKey(java.lang.String key)

Description copied from class: DriveRequest

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Overrides:

setKey in class DriveRequest<CommentList>

setOauthToken

public Drive.Comments.List setOauthToken(java.lang.String oauthToken)

Description copied from class: DriveRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class DriveRequest<CommentList>

setPrettyPrint

public Drive.Comments.List setPrettyPrint(java.lang.Boolean prettyPrint)

Description copied from class: DriveRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class DriveRequest<CommentList>

setQuotaUser

public Drive.Comments.List setQuotaUser(java.lang.String quotaUser)

Description copied from class: DriveRequest

Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

Overrides:

setQuotaUser in class DriveRequest<CommentList>

setUserIp

public Drive.Comments.List setUserIp(java.lang.String userIp)

Description copied from class: DriveRequest

IP address of the site where the request originates. Use this if you want to enforce per-user limits.

Overrides:

setUserIp in class DriveRequest<CommentList>

getFileId

public java.lang.String getFileId()

The ID of the file.

setFileId

public Drive.Comments.List setFileId(java.lang.String fileId)

The ID of the file.

getPageToken

public java.lang.String getPageToken()

The continuation token, used to page through large result sets. To get the next page of results, set this parameter to the value of "nextPageToken" from the previous response.

setPageToken

public Drive.Comments.List setPageToken(java.lang.String pageToken)

The continuation token, used to page through large result sets. To get the next page of results, set this parameter to the value of "nextPageToken" from the previous response.

getUpdatedMin

public java.lang.String getUpdatedMin()

Only discussions that were updated after this timestamp will be returned. Formatted as an RFC 3339 timestamp.

setUpdatedMin

public Drive.Comments.List setUpdatedMin(java.lang.String updatedMin)

Only discussions that were updated after this timestamp will be returned. Formatted as an RFC 3339 timestamp.

getIncludeDeleted

public java.lang.Boolean getIncludeDeleted()

If set, all comments and replies, including deleted comments and replies (with content stripped) will be returned. [default: false]

setIncludeDeleted

public Drive.Comments.List setIncludeDeleted(java.lang.Boolean includeDeleted)

If set, all comments and replies, including deleted comments and replies (with content stripped) will be returned.

isIncludeDeleted

public boolean isIncludeDeleted()

Convenience method that returns only Boolean.TRUE or Boolean.FALSE.

Boolean properties can have four possible values: null, Data.NULL_BOOLEAN, Boolean.TRUE or Boolean.FALSE.

This method returns Boolean.TRUE if the default of the property is Boolean.TRUE and it is null or Data.NULL_BOOLEAN. Boolean.FALSE is returned if the default of the property is Boolean.FALSE and it is null or Data.NULL_BOOLEAN.

If set, all comments and replies, including deleted comments and replies (with content stripped) will be returned.

getMaxResults

public java.lang.Integer getMaxResults()

The maximum number of discussions to include in the response, used for paging. [default: 20] [minimum: 0] [maximum: 100]

setMaxResults

public Drive.Comments.List setMaxResults(java.lang.Integer maxResults)

The maximum number of discussions to include in the response, used for paging.

set

public Drive.Comments.List set(java.lang.String parameterName,
                      java.lang.Object value)

Overrides:

set in class DriveRequest<CommentList>