Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 075572b86b87d93810e12170f57bcbf72ab4c507 / . / docs / dyn / drive_v2.changes.html
blob: df5f928e6676ccc5028be4f6546b117df6c679f0 [file] [log] [blame]
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame^]1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="drive_v2.html">Drive API</a> . <a href="drive_v2.changes.html">changes</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#get">get(changeId)</a></code></p>
79<p class="firstline">Gets a specific change.</p>
80<p class="toc_element">
81 <code><a href="#list">list(includeSubscribed=None, includeDeleted=None, pageToken=None, maxResults=None, startChangeId=None)</a></code></p>
82<p class="firstline">Lists the changes for a user.</p>
83<p class="toc_element">
84 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
85<p class="firstline">Retrieves the next page of results.</p>
86<h3>Method Details</h3>
87<div class="method">
88 <code class="details" id="get">get(changeId)</code>
89 <pre>Gets a specific change.
90
91Args:
92 changeId: string, The ID of the change. (required)
93
94Returns:
95 An object of the form:
96
97 { # Representation of a change to a file.
98 "kind": "drive#change", # This is always drive#change.
99 "deleted": True or False, # Whether the file has been deleted.
100 "file": { # The metadata for a file. # The updated state of the file. Present if the file has not been deleted.
101 "mimeType": "A String", # The MIME type of the file.
102 "thumbnailLink": "A String", # A link to the file's thumbnail.
103 "labels": { # A group of labels for the file.
104 "restricted": True or False, # Whether viewers are prevented from downloading this file.
105 "hidden": True or False, # Whether this file is hidden from the user.
106 "viewed": True or False, # Whether this file has been viewed by this user.
107 "starred": True or False, # Whether this file is starred by the user.
108 "trashed": True or False, # Whether this file has been trashed.
109 },
110 "indexableText": { # Indexable text attributes for the file (can only be written)
111 "text": "A String", # The text to be indexed for this file
112 },
113 "etag": "A String", # ETag of the file.
114 "lastModifyingUserName": "A String", # Name of the last user to modify this file. This will only be populated if a user has edited this file.
115 "writersCanShare": True or False, # Whether writers can share the document with other users.
116 "id": "A String", # The id of the file.
117 "title": "A String", # The title of this file.
118 "ownerNames": [ # Name(s) of the owner(s) of this file.
119 "A String",
120 ],
121 "sharedWithMeDate": "A String", # Time at which this file was shared with the user (formatted RFC 3339 timestamp).
122 "lastViewedByMeDate": "A String", # Last time this file was viewed by the user (formatted RFC 3339 timestamp).
123 "parents": [ # Collection of parent folders which contain this file.
124 # On insert, setting this field will put the file in all of the provided folders. If no folders are provided, the file will be placed in the default root folder. On update, this field is ignored.
125 { # A reference to a file's parent.
126 "selfLink": "A String", # A link back to this reference.
127 "kind": "drive#parentReference", # This is always drive#parentReference.
128 "id": "A String", # The ID of the parent.
129 "isRoot": True or False, # Whether or not the parent is the root folder.
130 "parentLink": "A String", # A link to the parent.
131 },
132 ],
133 "exportLinks": { # Links for exporting Google Docs to specific formats.
134 },
135 "originalFilename": "A String", # The filename when uploading this file. This will only be populated on files with content stored in Drive.
136 "description": "A String", # A short description of the file.
137 "editable": True or False, # Whether the file can be edited by the current user.
138 "kind": "drive#file", # The type of file. This is always drive#file.
139 "quotaBytesUsed": "A String", # The number of quota bytes used by this file.
140 "fileSize": "A String", # The size of the file in bytes. This will only be populated on files with content stored in Drive.
141 "createdDate": "A String", # Create time for this file (formatted ISO8601 timestamp).
142 "md5Checksum": "A String", # An MD5 checksum for the content of this file. This will only be populated on files with content stored in Drive.
143 "embedLink": "A String", # A link for embedding the file.
144 "alternateLink": "A String", # A link for opening the file in a browser.
145 "permissionsLink": "A String", # A link to the permissions collection.
146 "modifiedByMeDate": "A String", # Last time this file was modified by the user (formatted RFC 3339 timestamp).
147 "downloadUrl": "A String", # Short term download URL for the file. This will only be populated on files with content stored in Drive.
148 "userPermission": { # A single permission for a file. # The permissions for the authenticated user on this file.
149 "withLink": True or False, # Whether the link is required for this permission.
150 "kind": "drive#permission", # This is always drive#permission.
151 "name": "A String", # The name for this permission.
152 "value": "A String", # The email address or domain name for the entity. This is not populated in responses.
153 "id": "A String", # The ID of the permission.
154 "authKey": "A String", # The authkey parameter required for this permission.
155 "etag": "A String", # The ETag of the permission.
156 "role": "A String", # The primary role for this user. Allowed values are:
157 # - owner
158 # - reader
159 # - writer
160 "photoLink": "A String", # A link to the profile photo, if available.
161 "type": "A String", # The account type. Allowed values are:
162 # - user
163 # - group
164 # - domain
165 # - anyone
166 "additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed.
167 "A String",
168 ],
169 "selfLink": "A String", # A link back to this permission.
170 },
171 "fileExtension": "A String", # The file extension used when downloading this file. This field is read only. To set the extension, include it on title when creating the file. This will only be populated on files with content stored in Drive.
172 "selfLink": "A String", # A link back to this file.
173 "modifiedDate": "A String", # Last time this file was modified by anyone (formatted RFC 3339 timestamp).
174 },
175 "id": "A String", # The ID of the change.
176 "selfLink": "A String", # A link back to this change.
177 "fileId": "A String", # The ID of the file associated with this change.
178 }</pre>
179</div>
180
181<div class="method">
182 <code class="details" id="list">list(includeSubscribed=None, includeDeleted=None, pageToken=None, maxResults=None, startChangeId=None)</code>
183 <pre>Lists the changes for a user.
184
185Args:
186 includeSubscribed: boolean, Whether to include subscribed items.
187 includeDeleted: boolean, Whether to include deleted items.
188 pageToken: string, Page token for changes.
189 maxResults: integer, Maximum number of changes to return.
190 startChangeId: string, Change ID to start listing changes from.
191
192Returns:
193 An object of the form:
194
195 { # A list of changes for a user.
196 "nextPageToken": "A String", # The page token for the next page of changes.
197 "kind": "drive#changeList", # This is always drive#changeList.
198 "items": [ # The actual list of changes.
199 { # Representation of a change to a file.
200 "kind": "drive#change", # This is always drive#change.
201 "deleted": True or False, # Whether the file has been deleted.
202 "file": { # The metadata for a file. # The updated state of the file. Present if the file has not been deleted.
203 "mimeType": "A String", # The MIME type of the file.
204 "thumbnailLink": "A String", # A link to the file's thumbnail.
205 "labels": { # A group of labels for the file.
206 "restricted": True or False, # Whether viewers are prevented from downloading this file.
207 "hidden": True or False, # Whether this file is hidden from the user.
208 "viewed": True or False, # Whether this file has been viewed by this user.
209 "starred": True or False, # Whether this file is starred by the user.
210 "trashed": True or False, # Whether this file has been trashed.
211 },
212 "indexableText": { # Indexable text attributes for the file (can only be written)
213 "text": "A String", # The text to be indexed for this file
214 },
215 "etag": "A String", # ETag of the file.
216 "lastModifyingUserName": "A String", # Name of the last user to modify this file. This will only be populated if a user has edited this file.
217 "writersCanShare": True or False, # Whether writers can share the document with other users.
218 "id": "A String", # The id of the file.
219 "title": "A String", # The title of this file.
220 "ownerNames": [ # Name(s) of the owner(s) of this file.
221 "A String",
222 ],
223 "sharedWithMeDate": "A String", # Time at which this file was shared with the user (formatted RFC 3339 timestamp).
224 "lastViewedByMeDate": "A String", # Last time this file was viewed by the user (formatted RFC 3339 timestamp).
225 "parents": [ # Collection of parent folders which contain this file.
226 # On insert, setting this field will put the file in all of the provided folders. If no folders are provided, the file will be placed in the default root folder. On update, this field is ignored.
227 { # A reference to a file's parent.
228 "selfLink": "A String", # A link back to this reference.
229 "kind": "drive#parentReference", # This is always drive#parentReference.
230 "id": "A String", # The ID of the parent.
231 "isRoot": True or False, # Whether or not the parent is the root folder.
232 "parentLink": "A String", # A link to the parent.
233 },
234 ],
235 "exportLinks": { # Links for exporting Google Docs to specific formats.
236 },
237 "originalFilename": "A String", # The filename when uploading this file. This will only be populated on files with content stored in Drive.
238 "description": "A String", # A short description of the file.
239 "editable": True or False, # Whether the file can be edited by the current user.
240 "kind": "drive#file", # The type of file. This is always drive#file.
241 "quotaBytesUsed": "A String", # The number of quota bytes used by this file.
242 "fileSize": "A String", # The size of the file in bytes. This will only be populated on files with content stored in Drive.
243 "createdDate": "A String", # Create time for this file (formatted ISO8601 timestamp).
244 "md5Checksum": "A String", # An MD5 checksum for the content of this file. This will only be populated on files with content stored in Drive.
245 "embedLink": "A String", # A link for embedding the file.
246 "alternateLink": "A String", # A link for opening the file in a browser.
247 "permissionsLink": "A String", # A link to the permissions collection.
248 "modifiedByMeDate": "A String", # Last time this file was modified by the user (formatted RFC 3339 timestamp).
249 "downloadUrl": "A String", # Short term download URL for the file. This will only be populated on files with content stored in Drive.
250 "userPermission": { # A single permission for a file. # The permissions for the authenticated user on this file.
251 "withLink": True or False, # Whether the link is required for this permission.
252 "kind": "drive#permission", # This is always drive#permission.
253 "name": "A String", # The name for this permission.
254 "value": "A String", # The email address or domain name for the entity. This is not populated in responses.
255 "id": "A String", # The ID of the permission.
256 "authKey": "A String", # The authkey parameter required for this permission.
257 "etag": "A String", # The ETag of the permission.
258 "role": "A String", # The primary role for this user. Allowed values are:
259 # - owner
260 # - reader
261 # - writer
262 "photoLink": "A String", # A link to the profile photo, if available.
263 "type": "A String", # The account type. Allowed values are:
264 # - user
265 # - group
266 # - domain
267 # - anyone
268 "additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed.
269 "A String",
270 ],
271 "selfLink": "A String", # A link back to this permission.
272 },
273 "fileExtension": "A String", # The file extension used when downloading this file. This field is read only. To set the extension, include it on title when creating the file. This will only be populated on files with content stored in Drive.
274 "selfLink": "A String", # A link back to this file.
275 "modifiedDate": "A String", # Last time this file was modified by anyone (formatted RFC 3339 timestamp).
276 },
277 "id": "A String", # The ID of the change.
278 "selfLink": "A String", # A link back to this change.
279 "fileId": "A String", # The ID of the file associated with this change.
280 },
281 ],
282 "nextLink": "A String", # A link to the next page of changes.
283 "etag": "A String", # The ETag of the list.
284 "largestChangeId": "A String", # The current largest change ID.
285 "selfLink": "A String", # A link back to this list.
286 }</pre>
287</div>
288
289<div class="method">
290 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
291 <pre>Retrieves the next page of results.
292
293Args:
294 previous_request: The request for the previous page. (required)
295 previous_response: The response from the request for the previous page. (required)
296
297Returns:
298 A request object that you can call 'execute()' on to request the next
299 page. Returns None if there are no more items in the collection.
300 </pre>
301</div>
302
303</body></html>