Drive API v2 (revision 1)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.google.api.services.drive
Class Drive.Changes.List

java.lang.Object
  java.util.AbstractMap<String,Object>
      com.google.api.client.util.GenericData
          com.google.api.client.http.json.JsonHttpRequest
              com.google.api.services.drive.DriveRequest
                  com.google.api.services.drive.Drive.Changes.List

All Implemented Interfaces:: Cloneable, Map<String,Object>

Enclosing class:: Drive.Changes

public class Drive.Changes.List
extends DriveRequest
extends DriveRequest

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
`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>`

Method Summary
`ChangeList`	`execute()` Sends the "list" request to the Drive server.
`Boolean`	`getIncludeDeleted()` Whether to include deleted items.
`Boolean`	`getIncludeSubscribed()` Whether to include subscribed items.
`Integer`	`getMaxResults()` Maximum number of changes to return.
`String`	`getPageToken()` Page token for changes.
`BigInteger`	`getStartChangeId()` Change ID to start listing changes from.
`boolean`	`isIncludeDeleted()` Convenience method that returns only `Boolean.TRUE` or `Boolean.FALSE`.
`boolean`	`isIncludeSubscribed()` Convenience method that returns only `Boolean.TRUE` or `Boolean.FALSE`.
`void`	`queue(BatchRequest batch, JsonBatchCallback<ChangeList> callback)` Queues the "list" request to the Drive server into the given batch request.
`Drive.Changes.List`	`setFields(String fields)` Selector specifying which fields to include in a partial response.
`Drive.Changes.List`	`setIncludeDeleted(Boolean includeDeleted)` Whether to include deleted items.
`Drive.Changes.List`	`setIncludeSubscribed(Boolean includeSubscribed)` Whether to include subscribed items.
`Drive.Changes.List`	`setMaxResults(Integer maxResults)` Maximum number of changes to return.
`Drive.Changes.List`	`setPageToken(String pageToken)` Page token for changes.
`Drive.Changes.List`	`setStartChangeId(BigInteger startChangeId)` Change ID to start listing changes from.

Methods inherited from class com.google.api.services.drive.DriveRequest
`getAlt, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUserIp, setAlt, setKey, setOauthToken, setPrettyPrint, setQuotaUser, setUserIp`

Methods inherited from class com.google.api.client.http.json.JsonHttpRequest
`buildHttpRequest, buildHttpRequestUrl, download, executeAsInputStream, executeUnparsed, getClient, getEnableGZipContent, getJsonContent, getLastResponseHeaders, getMethod, getRequestHeaders, getUriTemplate, setEnableGZipContent, setRequestHeaders`

Methods inherited from class com.google.api.client.util.GenericData
`clone, entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, set, 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`

Method Detail

execute

public ChangeList execute()
                   throws IOException

Sends the "list" request to the Drive server.

Returns:: the ChangeList response
Throws:: IOException - if the request fails

queue

public void queue(BatchRequest batch,
                  JsonBatchCallback<ChangeList> callback)
           throws IOException

Queues the "list" request to the Drive server into the given batch request.

Example usage:

         request.queue(batchRequest, new JsonBatchCallback<ChangeList>() {

           public void onSuccess(ChangeList content, GoogleHeaders responseHeaders) {
             log("Success");
           }

           public void onFailure(GoogleJsonError e, GoogleHeaders responseHeaders) {
             log(e.getMessage());
           }
         });

Parameters:: batch - a single batch of requests; callback - batch callback
Throws:: IOException
Since:: 1.6

setFields

public Drive.Changes.List setFields(String fields)

Description copied from class: DriveRequest

Selector specifying which fields to include in a partial response.

Overrides:: setFields in class DriveRequest

Since:: 1.7

getIncludeSubscribed

public Boolean getIncludeSubscribed()

Whether to include subscribed items. [default: true]

setIncludeSubscribed

public Drive.Changes.List setIncludeSubscribed(Boolean includeSubscribed)

Whether to include subscribed items.

isIncludeSubscribed

public boolean isIncludeSubscribed()

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.

Whether to include subscribed items.

getStartChangeId

public BigInteger getStartChangeId()

Change ID to start listing changes from.

setStartChangeId

public Drive.Changes.List setStartChangeId(BigInteger startChangeId)