Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 075572b86b87d93810e12170f57bcbf72ab4c507 / . / docs / dyn / drive_v2.revisions.html
blob: 7b810bbbb7628a0c0de7b356e59c61b9d20820ae [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.revisions.html">revisions</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#delete">delete(fileId, revisionId)</a></code></p>
79<p class="firstline">Removes a revision.</p>
80<p class="toc_element">
81 <code><a href="#get">get(fileId, revisionId)</a></code></p>
82<p class="firstline">Gets a specific revision.</p>
83<p class="toc_element">
84 <code><a href="#list">list(fileId)</a></code></p>
85<p class="firstline">Lists a file's revisions.</p>
86<p class="toc_element">
87 <code><a href="#patch">patch(fileId, revisionId, body)</a></code></p>
88<p class="firstline">Updates a revision. This method supports patch semantics.</p>
89<p class="toc_element">
90 <code><a href="#update">update(fileId, revisionId, body)</a></code></p>
91<p class="firstline">Updates a revision.</p>
92<h3>Method Details</h3>
93<div class="method">
94 <code class="details" id="delete">delete(fileId, revisionId)</code>
95 <pre>Removes a revision.
96
97Args:
98 fileId: string, The ID of the file. (required)
99 revisionId: string, The ID of the revision. (required)
100</pre>
101</div>
102
103<div class="method">
104 <code class="details" id="get">get(fileId, revisionId)</code>
105 <pre>Gets a specific revision.
106
107Args:
108 fileId: string, The ID of the file. (required)
109 revisionId: string, The ID of the revision. (required)
110
111Returns:
112 An object of the form:
113
114 { # A single revision of a file.
115 "mimeType": "A String", # The MIME type of the revision.
116 "pinned": True or False, # Whether this revision is pinned to prevent automatic purging. This will only be populated on files with content stored in Drive.
117 "kind": "drive#revision", # This is always drive#revision.
118 "publishedLink": "A String", # A link to the published revision.
119 "publishedOutsideDomain": True or False, # Whether this revision is published outside the domain.
120 "publishAuto": True or False, # Whether subsequent revisions will be automatically republished.
121 "published": True or False, # Whether this revision is published. This is only populated for Google Docs.
122 "downloadUrl": "A String", # Short term download URL for the file. This will only be populated on files with content stored in Drive.
123 "selfLink": "A String", # A link back to this revision.
124 "etag": "A String", # The ETag of the revision.
125 "fileSize": "A String", # The size of the revision in bytes. This will only be populated on files with content stored in Drive.
126 "exportLinks": { # Links for exporting Google Docs to specific formats.
127 },
128 "lastModifyingUserName": "A String", # Name of the last user to modify this revision.
129 "originalFilename": "A String", # The original filename when this revision was created. This will only be populated on files with content stored in Drive.
130 "id": "A String", # The ID of the revision.
131 "md5Checksum": "A String", # An MD5 checksum for the content of this revision. This will only be populated on files with content stored in Drive.
132 "modifiedDate": "A String", # Last time this revision was modified (formatted RFC 3339 timestamp).
133 }</pre>
134</div>
135
136<div class="method">
137 <code class="details" id="list">list(fileId)</code>
138 <pre>Lists a file's revisions.
139
140Args:
141 fileId: string, The ID of the file. (required)
142
143Returns:
144 An object of the form:
145
146 { # A list of revisions of a file.
147 "items": [ # The actual list of revisions.
148 { # A single revision of a file.
149 "mimeType": "A String", # The MIME type of the revision.
150 "pinned": True or False, # Whether this revision is pinned to prevent automatic purging. This will only be populated on files with content stored in Drive.
151 "kind": "drive#revision", # This is always drive#revision.
152 "publishedLink": "A String", # A link to the published revision.
153 "publishedOutsideDomain": True or False, # Whether this revision is published outside the domain.
154 "publishAuto": True or False, # Whether subsequent revisions will be automatically republished.
155 "published": True or False, # Whether this revision is published. This is only populated for Google Docs.
156 "downloadUrl": "A String", # Short term download URL for the file. This will only be populated on files with content stored in Drive.
157 "selfLink": "A String", # A link back to this revision.
158 "etag": "A String", # The ETag of the revision.
159 "fileSize": "A String", # The size of the revision in bytes. This will only be populated on files with content stored in Drive.
160 "exportLinks": { # Links for exporting Google Docs to specific formats.
161 },
162 "lastModifyingUserName": "A String", # Name of the last user to modify this revision.
163 "originalFilename": "A String", # The original filename when this revision was created. This will only be populated on files with content stored in Drive.
164 "id": "A String", # The ID of the revision.
165 "md5Checksum": "A String", # An MD5 checksum for the content of this revision. This will only be populated on files with content stored in Drive.
166 "modifiedDate": "A String", # Last time this revision was modified (formatted RFC 3339 timestamp).
167 },
168 ],
169 "kind": "drive#revisionList", # This is always drive#revisionList.
170 "etag": "A String", # The ETag of the list.
171 "selfLink": "A String", # A link back to this list.
172 }</pre>
173</div>
174
175<div class="method">
176 <code class="details" id="patch">patch(fileId, revisionId, body)</code>
177 <pre>Updates a revision. This method supports patch semantics.
178
179Args:
180 fileId: string, The ID for the file. (required)
181 revisionId: string, The ID for the revision. (required)
182 body: object, The request body. (required)
183 The object takes the form of:
184
185{ # A single revision of a file.
186 "mimeType": "A String", # The MIME type of the revision.
187 "pinned": True or False, # Whether this revision is pinned to prevent automatic purging. This will only be populated on files with content stored in Drive.
188 "kind": "drive#revision", # This is always drive#revision.
189 "publishedLink": "A String", # A link to the published revision.
190 "publishedOutsideDomain": True or False, # Whether this revision is published outside the domain.
191 "publishAuto": True or False, # Whether subsequent revisions will be automatically republished.
192 "published": True or False, # Whether this revision is published. This is only populated for Google Docs.
193 "downloadUrl": "A String", # Short term download URL for the file. This will only be populated on files with content stored in Drive.
194 "selfLink": "A String", # A link back to this revision.
195 "etag": "A String", # The ETag of the revision.
196 "fileSize": "A String", # The size of the revision in bytes. This will only be populated on files with content stored in Drive.
197 "exportLinks": { # Links for exporting Google Docs to specific formats.
198 },
199 "lastModifyingUserName": "A String", # Name of the last user to modify this revision.
200 "originalFilename": "A String", # The original filename when this revision was created. This will only be populated on files with content stored in Drive.
201 "id": "A String", # The ID of the revision.
202 "md5Checksum": "A String", # An MD5 checksum for the content of this revision. This will only be populated on files with content stored in Drive.
203 "modifiedDate": "A String", # Last time this revision was modified (formatted RFC 3339 timestamp).
204 }
205
206
207Returns:
208 An object of the form:
209
210 { # A single revision of a file.
211 "mimeType": "A String", # The MIME type of the revision.
212 "pinned": True or False, # Whether this revision is pinned to prevent automatic purging. This will only be populated on files with content stored in Drive.
213 "kind": "drive#revision", # This is always drive#revision.
214 "publishedLink": "A String", # A link to the published revision.
215 "publishedOutsideDomain": True or False, # Whether this revision is published outside the domain.
216 "publishAuto": True or False, # Whether subsequent revisions will be automatically republished.
217 "published": True or False, # Whether this revision is published. This is only populated for Google Docs.
218 "downloadUrl": "A String", # Short term download URL for the file. This will only be populated on files with content stored in Drive.
219 "selfLink": "A String", # A link back to this revision.
220 "etag": "A String", # The ETag of the revision.
221 "fileSize": "A String", # The size of the revision in bytes. This will only be populated on files with content stored in Drive.
222 "exportLinks": { # Links for exporting Google Docs to specific formats.
223 },
224 "lastModifyingUserName": "A String", # Name of the last user to modify this revision.
225 "originalFilename": "A String", # The original filename when this revision was created. This will only be populated on files with content stored in Drive.
226 "id": "A String", # The ID of the revision.
227 "md5Checksum": "A String", # An MD5 checksum for the content of this revision. This will only be populated on files with content stored in Drive.
228 "modifiedDate": "A String", # Last time this revision was modified (formatted RFC 3339 timestamp).
229 }</pre>
230</div>
231
232<div class="method">
233 <code class="details" id="update">update(fileId, revisionId, body)</code>
234 <pre>Updates a revision.
235
236Args:
237 fileId: string, The ID for the file. (required)
238 revisionId: string, The ID for the revision. (required)
239 body: object, The request body. (required)
240 The object takes the form of:
241
242{ # A single revision of a file.
243 "mimeType": "A String", # The MIME type of the revision.
244 "pinned": True or False, # Whether this revision is pinned to prevent automatic purging. This will only be populated on files with content stored in Drive.
245 "kind": "drive#revision", # This is always drive#revision.
246 "publishedLink": "A String", # A link to the published revision.
247 "publishedOutsideDomain": True or False, # Whether this revision is published outside the domain.
248 "publishAuto": True or False, # Whether subsequent revisions will be automatically republished.
249 "published": True or False, # Whether this revision is published. This is only populated for Google Docs.
250 "downloadUrl": "A String", # Short term download URL for the file. This will only be populated on files with content stored in Drive.
251 "selfLink": "A String", # A link back to this revision.
252 "etag": "A String", # The ETag of the revision.
253 "fileSize": "A String", # The size of the revision in bytes. This will only be populated on files with content stored in Drive.
254 "exportLinks": { # Links for exporting Google Docs to specific formats.
255 },
256 "lastModifyingUserName": "A String", # Name of the last user to modify this revision.
257 "originalFilename": "A String", # The original filename when this revision was created. This will only be populated on files with content stored in Drive.
258 "id": "A String", # The ID of the revision.
259 "md5Checksum": "A String", # An MD5 checksum for the content of this revision. This will only be populated on files with content stored in Drive.
260 "modifiedDate": "A String", # Last time this revision was modified (formatted RFC 3339 timestamp).
261 }
262
263
264Returns:
265 An object of the form:
266
267 { # A single revision of a file.
268 "mimeType": "A String", # The MIME type of the revision.
269 "pinned": True or False, # Whether this revision is pinned to prevent automatic purging. This will only be populated on files with content stored in Drive.
270 "kind": "drive#revision", # This is always drive#revision.
271 "publishedLink": "A String", # A link to the published revision.
272 "publishedOutsideDomain": True or False, # Whether this revision is published outside the domain.
273 "publishAuto": True or False, # Whether subsequent revisions will be automatically republished.
274 "published": True or False, # Whether this revision is published. This is only populated for Google Docs.
275 "downloadUrl": "A String", # Short term download URL for the file. This will only be populated on files with content stored in Drive.
276 "selfLink": "A String", # A link back to this revision.
277 "etag": "A String", # The ETag of the revision.
278 "fileSize": "A String", # The size of the revision in bytes. This will only be populated on files with content stored in Drive.
279 "exportLinks": { # Links for exporting Google Docs to specific formats.
280 },
281 "lastModifyingUserName": "A String", # Name of the last user to modify this revision.
282 "originalFilename": "A String", # The original filename when this revision was created. This will only be populated on files with content stored in Drive.
283 "id": "A String", # The ID of the revision.
284 "md5Checksum": "A String", # An MD5 checksum for the content of this revision. This will only be populated on files with content stored in Drive.
285 "modifiedDate": "A String", # Last time this revision was modified (formatted RFC 3339 timestamp).
286 }</pre>
287</div>
288
289</body></html>