File: drive_v3.revisions.html

package info (click to toggle)
python-googleapi 1.5.0-2~bpo8%2B1
  • links: PTS
  • area: main
  • in suites: jessie-backports
  • size: 28,336 kB
  • sloc: python: 6,808; makefile: 64; sh: 53; xml: 5
file content (254 lines) | stat: -rw-r--r-- 12,754 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
<html><body>
<style>

body, h1, h2, h3, div, span, p, pre, a {
  margin: 0;
  padding: 0;
  border: 0;
  font-weight: inherit;
  font-style: inherit;
  font-size: 100%;
  font-family: inherit;
  vertical-align: baseline;
}

body {
  font-size: 13px;
  padding: 1em;
}

h1 {
  font-size: 26px;
  margin-bottom: 1em;
}

h2 {
  font-size: 24px;
  margin-bottom: 1em;
}

h3 {
  font-size: 20px;
  margin-bottom: 1em;
  margin-top: 1em;
}

pre, code {
  line-height: 1.5;
  font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}

pre {
  margin-top: 0.5em;
}

h1, h2, h3, p {
  font-family: Arial, sans serif;
}

h1, h2, h3 {
  border-bottom: solid #CCC 1px;
}

.toc_element {
  margin-top: 0.5em;
}

.firstline {
  margin-left: 2 em;
}

.method  {
  margin-top: 1em;
  border: solid 1px #CCC;
  padding: 1em;
  background: #EEE;
}

.details {
  font-weight: bold;
  font-size: 14px;
}

</style>

<h1><a href="drive_v3.html">Drive API</a> . <a href="drive_v3.revisions.html">revisions</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
  <code><a href="#delete">delete(fileId, revisionId)</a></code></p>
<p class="firstline">Permanently deletes a revision. This method is only applicable to files with binary content in Drive.</p>
<p class="toc_element">
  <code><a href="#get">get(fileId, revisionId, acknowledgeAbuse=None)</a></code></p>
<p class="firstline">Gets a revision's metadata or content by ID.</p>
<p class="toc_element">
  <code><a href="#get_media">get_media(fileId, revisionId, acknowledgeAbuse=None)</a></code></p>
<p class="firstline">Gets a revision's metadata or content by ID.</p>
<p class="toc_element">
  <code><a href="#list">list(fileId)</a></code></p>
<p class="firstline">Lists a file's revisions.</p>
<p class="toc_element">
  <code><a href="#update">update(fileId, revisionId, body)</a></code></p>
<p class="firstline">Updates a revision with patch semantics.</p>
<h3>Method Details</h3>
<div class="method">
    <code class="details" id="delete">delete(fileId, revisionId)</code>
  <pre>Permanently deletes a revision. This method is only applicable to files with binary content in Drive.

Args:
  fileId: string, The ID of the file. (required)
  revisionId: string, The ID of the revision. (required)
</pre>
</div>

<div class="method">
    <code class="details" id="get">get(fileId, revisionId, acknowledgeAbuse=None)</code>
  <pre>Gets a revision's metadata or content by ID.

Args:
  fileId: string, The ID of the file. (required)
  revisionId: string, The ID of the revision. (required)
  acknowledgeAbuse: boolean, Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when alt=media.

Returns:
  An object of the form:

    { # The metadata for a revision to a file.
    "mimeType": "A String", # The MIME type of the revision.
    "kind": "drive#revision", # This is always drive#revision.
    "modifiedTime": "A String", # The last time the revision was modified (RFC 3339 date-time).
    "lastModifyingUser": { # Information about a Drive user. # The last user to modify this revision.
      "me": True or False, # Whether this user is the requesting user.
      "kind": "drive#user", # This is always drive#user.
      "displayName": "A String", # A plain text displayable name for this user.
      "permissionId": "A String", # The user's ID as visible in Permission resources.
      "emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
      "photoLink": "A String", # A link to the user's profile photo, if available.
    },
    "keepForever": True or False, # Whether to keep this revision forever, even if it is no longer the head revision. If not set, the revision will be automatically purged 30 days after newer content is uploaded. This can be set on a maximum of 200 revisions for a file.
        # This field is only applicable to files with binary content in Drive.
    "publishAuto": True or False, # Whether subsequent revisions will be automatically republished. This is only applicable to Google Docs.
    "originalFilename": "A String", # The original filename used to create this revision. This is only applicable to files with binary content in Drive.
    "published": True or False, # Whether this revision is published. This is only applicable to Google Docs.
    "size": "A String", # The size of the revision's content in bytes. This is only applicable to files with binary content in Drive.
    "id": "A String", # The ID of the revision.
    "md5Checksum": "A String", # The MD5 checksum of the revision's content. This is only applicable to files with binary content in Drive.
    "publishedOutsideDomain": True or False, # Whether this revision is published outside the domain. This is only applicable to Google Docs.
  }</pre>
</div>

<div class="method">
    <code class="details" id="get_media">get_media(fileId, revisionId, acknowledgeAbuse=None)</code>
  <pre>Gets a revision's metadata or content by ID.

Args:
  fileId: string, The ID of the file. (required)
  revisionId: string, The ID of the revision. (required)
  acknowledgeAbuse: boolean, Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when alt=media.

Returns:
  The media object as a string.

    </pre>
</div>

<div class="method">
    <code class="details" id="list">list(fileId)</code>
  <pre>Lists a file's revisions.

Args:
  fileId: string, The ID of the file. (required)

Returns:
  An object of the form:

    { # A list of revisions of a file.
    "kind": "drive#revisionList", # This is always drive#revisionList.
    "revisions": [ # The full list of revisions.
      { # The metadata for a revision to a file.
        "mimeType": "A String", # The MIME type of the revision.
        "kind": "drive#revision", # This is always drive#revision.
        "modifiedTime": "A String", # The last time the revision was modified (RFC 3339 date-time).
        "lastModifyingUser": { # Information about a Drive user. # The last user to modify this revision.
          "me": True or False, # Whether this user is the requesting user.
          "kind": "drive#user", # This is always drive#user.
          "displayName": "A String", # A plain text displayable name for this user.
          "permissionId": "A String", # The user's ID as visible in Permission resources.
          "emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
          "photoLink": "A String", # A link to the user's profile photo, if available.
        },
        "keepForever": True or False, # Whether to keep this revision forever, even if it is no longer the head revision. If not set, the revision will be automatically purged 30 days after newer content is uploaded. This can be set on a maximum of 200 revisions for a file.
            # This field is only applicable to files with binary content in Drive.
        "publishAuto": True or False, # Whether subsequent revisions will be automatically republished. This is only applicable to Google Docs.
        "originalFilename": "A String", # The original filename used to create this revision. This is only applicable to files with binary content in Drive.
        "published": True or False, # Whether this revision is published. This is only applicable to Google Docs.
        "size": "A String", # The size of the revision's content in bytes. This is only applicable to files with binary content in Drive.
        "id": "A String", # The ID of the revision.
        "md5Checksum": "A String", # The MD5 checksum of the revision's content. This is only applicable to files with binary content in Drive.
        "publishedOutsideDomain": True or False, # Whether this revision is published outside the domain. This is only applicable to Google Docs.
      },
    ],
  }</pre>
</div>

<div class="method">
    <code class="details" id="update">update(fileId, revisionId, body)</code>
  <pre>Updates a revision with patch semantics.

Args:
  fileId: string, The ID of the file. (required)
  revisionId: string, The ID of the revision. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # The metadata for a revision to a file.
  "mimeType": "A String", # The MIME type of the revision.
  "kind": "drive#revision", # This is always drive#revision.
  "modifiedTime": "A String", # The last time the revision was modified (RFC 3339 date-time).
  "lastModifyingUser": { # Information about a Drive user. # The last user to modify this revision.
    "me": True or False, # Whether this user is the requesting user.
    "kind": "drive#user", # This is always drive#user.
    "displayName": "A String", # A plain text displayable name for this user.
    "permissionId": "A String", # The user's ID as visible in Permission resources.
    "emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
    "photoLink": "A String", # A link to the user's profile photo, if available.
  },
  "keepForever": True or False, # Whether to keep this revision forever, even if it is no longer the head revision. If not set, the revision will be automatically purged 30 days after newer content is uploaded. This can be set on a maximum of 200 revisions for a file.
      # This field is only applicable to files with binary content in Drive.
  "publishAuto": True or False, # Whether subsequent revisions will be automatically republished. This is only applicable to Google Docs.
  "originalFilename": "A String", # The original filename used to create this revision. This is only applicable to files with binary content in Drive.
  "published": True or False, # Whether this revision is published. This is only applicable to Google Docs.
  "size": "A String", # The size of the revision's content in bytes. This is only applicable to files with binary content in Drive.
  "id": "A String", # The ID of the revision.
  "md5Checksum": "A String", # The MD5 checksum of the revision's content. This is only applicable to files with binary content in Drive.
  "publishedOutsideDomain": True or False, # Whether this revision is published outside the domain. This is only applicable to Google Docs.
}


Returns:
  An object of the form:

    { # The metadata for a revision to a file.
    "mimeType": "A String", # The MIME type of the revision.
    "kind": "drive#revision", # This is always drive#revision.
    "modifiedTime": "A String", # The last time the revision was modified (RFC 3339 date-time).
    "lastModifyingUser": { # Information about a Drive user. # The last user to modify this revision.
      "me": True or False, # Whether this user is the requesting user.
      "kind": "drive#user", # This is always drive#user.
      "displayName": "A String", # A plain text displayable name for this user.
      "permissionId": "A String", # The user's ID as visible in Permission resources.
      "emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
      "photoLink": "A String", # A link to the user's profile photo, if available.
    },
    "keepForever": True or False, # Whether to keep this revision forever, even if it is no longer the head revision. If not set, the revision will be automatically purged 30 days after newer content is uploaded. This can be set on a maximum of 200 revisions for a file.
        # This field is only applicable to files with binary content in Drive.
    "publishAuto": True or False, # Whether subsequent revisions will be automatically republished. This is only applicable to Google Docs.
    "originalFilename": "A String", # The original filename used to create this revision. This is only applicable to files with binary content in Drive.
    "published": True or False, # Whether this revision is published. This is only applicable to Google Docs.
    "size": "A String", # The size of the revision's content in bytes. This is only applicable to files with binary content in Drive.
    "id": "A String", # The ID of the revision.
    "md5Checksum": "A String", # The MD5 checksum of the revision's content. This is only applicable to files with binary content in Drive.
    "publishedOutsideDomain": True or False, # Whether this revision is published outside the domain. This is only applicable to Google Docs.
  }</pre>
</div>

</body></html>