Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / c30d2b5d4478b230246dcaaa9f1c533ca3304387 / . / docs / dyn / drive_v2.teamdrives.html
blob: 4d3475a4954469b105cab6d837a082bdc7736ee1 [file] [log] [blame]
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -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.teamdrives.html">teamdrives</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#delete">delete(teamDriveId)</a></code></p>
79<p class="firstline">Permanently deletes a Team Drive for which the user is an organizer. The Team Drive cannot contain any untrashed items.</p>
80<p class="toc_element">
81 <code><a href="#get">get(teamDriveId)</a></code></p>
82<p class="firstline">Gets a Team Drive's metadata by ID.</p>
83<p class="toc_element">
84 <code><a href="#insert">insert(requestId, body)</a></code></p>
85<p class="firstline">Creates a new Team Drive.</p>
86<p class="toc_element">
87 <code><a href="#list">list(pageToken=None, maxResults=None)</a></code></p>
88<p class="firstline">Lists the user's Team Drives.</p>
89<p class="toc_element">
90 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
91<p class="firstline">Retrieves the next page of results.</p>
92<p class="toc_element">
93 <code><a href="#update">update(teamDriveId, body)</a></code></p>
94<p class="firstline">Updates a Team Drive's metadata</p>
95<h3>Method Details</h3>
96<div class="method">
97 <code class="details" id="delete">delete(teamDriveId)</code>
98 <pre>Permanently deletes a Team Drive for which the user is an organizer. The Team Drive cannot contain any untrashed items.
99
100Args:
101 teamDriveId: string, The ID of the Team Drive (required)
102</pre>
103</div>
104
105<div class="method">
106 <code class="details" id="get">get(teamDriveId)</code>
107 <pre>Gets a Team Drive's metadata by ID.
108
109Args:
110 teamDriveId: string, The ID of the Team Drive (required)
111
112Returns:
113 An object of the form:
114
115 { # Representation of a Team Drive.
116 "kind": "drive#teamDrive", # This is always drive#teamDrive
117 "id": "A String", # The ID of this Team Drive which is also the ID of the top level folder for this Team Drive.
118 "capabilities": { # Capabilities the current user has on this Team Drive.
119 "canReadRevisions": True or False, # Whether the current user has read access to the Revisions resource of files in this Team Drive.
120 "canCopy": True or False, # Whether files in this Team Drive can be copied by the current user.
121 "canRename": True or False, # Whether files or folders in this Team Drive can be renamed by the current user.
122 "canListChildren": True or False, # Whether the current user can list the children of folders in this Team Drive.
123 "canShare": True or False, # Whether the current user can share files or folders in this Team Drive.
124 "canManageMembers": True or False, # Whether the current user can add members to this Team Drive or remove them or change their role.
125 "canDownload": True or False, # Whether files in this Team Drive can be downloaded by the current user.
126 "canComment": True or False, # Whether the current user can comment on files in this Team Drive.
127 "canDeleteTeamDrive": True or False, # Whether this Team Drive can be deleted by the current user.
128 "canRenameTeamDrive": True or False, # Whether this Team Drive can be renamed by the current user.
129 "canRemoveChildren": True or False, # Whether the current user can remove children from folders in this Team Drive.
130 "canAddChildren": True or False, # Whether the current user can add children to folders in this Team Drive.
131 "canEdit": True or False, # Whether files in this Team Drive can be edited by the current user.
132 },
133 "name": "A String", # The name of this Team Drive.
134 }</pre>
135</div>
136
137<div class="method">
138 <code class="details" id="insert">insert(requestId, body)</code>
139 <pre>Creates a new Team Drive.
140
141Args:
142 requestId: string, An ID, such as a random UUID, which uniquely identifies this user's request for idempotent creation of a Team Drive. A repeated request by the same user and with the same request ID will avoid creating duplicates by attempting to create the same Team Drive. If the Team Drive already exists a 409 error will be returned. (required)
143 body: object, The request body. (required)
144 The object takes the form of:
145
146{ # Representation of a Team Drive.
147 "kind": "drive#teamDrive", # This is always drive#teamDrive
148 "id": "A String", # The ID of this Team Drive which is also the ID of the top level folder for this Team Drive.
149 "capabilities": { # Capabilities the current user has on this Team Drive.
150 "canReadRevisions": True or False, # Whether the current user has read access to the Revisions resource of files in this Team Drive.
151 "canCopy": True or False, # Whether files in this Team Drive can be copied by the current user.
152 "canRename": True or False, # Whether files or folders in this Team Drive can be renamed by the current user.
153 "canListChildren": True or False, # Whether the current user can list the children of folders in this Team Drive.
154 "canShare": True or False, # Whether the current user can share files or folders in this Team Drive.
155 "canManageMembers": True or False, # Whether the current user can add members to this Team Drive or remove them or change their role.
156 "canDownload": True or False, # Whether files in this Team Drive can be downloaded by the current user.
157 "canComment": True or False, # Whether the current user can comment on files in this Team Drive.
158 "canDeleteTeamDrive": True or False, # Whether this Team Drive can be deleted by the current user.
159 "canRenameTeamDrive": True or False, # Whether this Team Drive can be renamed by the current user.
160 "canRemoveChildren": True or False, # Whether the current user can remove children from folders in this Team Drive.
161 "canAddChildren": True or False, # Whether the current user can add children to folders in this Team Drive.
162 "canEdit": True or False, # Whether files in this Team Drive can be edited by the current user.
163 },
164 "name": "A String", # The name of this Team Drive.
165}
166
167
168Returns:
169 An object of the form:
170
171 { # Representation of a Team Drive.
172 "kind": "drive#teamDrive", # This is always drive#teamDrive
173 "id": "A String", # The ID of this Team Drive which is also the ID of the top level folder for this Team Drive.
174 "capabilities": { # Capabilities the current user has on this Team Drive.
175 "canReadRevisions": True or False, # Whether the current user has read access to the Revisions resource of files in this Team Drive.
176 "canCopy": True or False, # Whether files in this Team Drive can be copied by the current user.
177 "canRename": True or False, # Whether files or folders in this Team Drive can be renamed by the current user.
178 "canListChildren": True or False, # Whether the current user can list the children of folders in this Team Drive.
179 "canShare": True or False, # Whether the current user can share files or folders in this Team Drive.
180 "canManageMembers": True or False, # Whether the current user can add members to this Team Drive or remove them or change their role.
181 "canDownload": True or False, # Whether files in this Team Drive can be downloaded by the current user.
182 "canComment": True or False, # Whether the current user can comment on files in this Team Drive.
183 "canDeleteTeamDrive": True or False, # Whether this Team Drive can be deleted by the current user.
184 "canRenameTeamDrive": True or False, # Whether this Team Drive can be renamed by the current user.
185 "canRemoveChildren": True or False, # Whether the current user can remove children from folders in this Team Drive.
186 "canAddChildren": True or False, # Whether the current user can add children to folders in this Team Drive.
187 "canEdit": True or False, # Whether files in this Team Drive can be edited by the current user.
188 },
189 "name": "A String", # The name of this Team Drive.
190 }</pre>
191</div>
192
193<div class="method">
194 <code class="details" id="list">list(pageToken=None, maxResults=None)</code>
195 <pre>Lists the user's Team Drives.
196
197Args:
198 pageToken: string, Page token for Team Drives.
199 maxResults: integer, Maximum number of Team Drives to return.
200
201Returns:
202 An object of the form:
203
204 { # A list of Team Drives.
205 "nextPageToken": "A String", # The page token for the next page of Team Drives.
206 "items": [ # The list of Team Drives.
207 { # Representation of a Team Drive.
208 "kind": "drive#teamDrive", # This is always drive#teamDrive
209 "id": "A String", # The ID of this Team Drive which is also the ID of the top level folder for this Team Drive.
210 "capabilities": { # Capabilities the current user has on this Team Drive.
211 "canReadRevisions": True or False, # Whether the current user has read access to the Revisions resource of files in this Team Drive.
212 "canCopy": True or False, # Whether files in this Team Drive can be copied by the current user.
213 "canRename": True or False, # Whether files or folders in this Team Drive can be renamed by the current user.
214 "canListChildren": True or False, # Whether the current user can list the children of folders in this Team Drive.
215 "canShare": True or False, # Whether the current user can share files or folders in this Team Drive.
216 "canManageMembers": True or False, # Whether the current user can add members to this Team Drive or remove them or change their role.
217 "canDownload": True or False, # Whether files in this Team Drive can be downloaded by the current user.
218 "canComment": True or False, # Whether the current user can comment on files in this Team Drive.
219 "canDeleteTeamDrive": True or False, # Whether this Team Drive can be deleted by the current user.
220 "canRenameTeamDrive": True or False, # Whether this Team Drive can be renamed by the current user.
221 "canRemoveChildren": True or False, # Whether the current user can remove children from folders in this Team Drive.
222 "canAddChildren": True or False, # Whether the current user can add children to folders in this Team Drive.
223 "canEdit": True or False, # Whether files in this Team Drive can be edited by the current user.
224 },
225 "name": "A String", # The name of this Team Drive.
226 },
227 ],
228 "kind": "drive#teamDriveList", # This is always drive#teamDriveList
229 }</pre>
230</div>
231
232<div class="method">
233 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
234 <pre>Retrieves the next page of results.
235
236Args:
237 previous_request: The request for the previous page. (required)
238 previous_response: The response from the request for the previous page. (required)
239
240Returns:
241 A request object that you can call 'execute()' on to request the next
242 page. Returns None if there are no more items in the collection.
243 </pre>
244</div>
245
246<div class="method">
247 <code class="details" id="update">update(teamDriveId, body)</code>
248 <pre>Updates a Team Drive's metadata
249
250Args:
251 teamDriveId: string, The ID of the Team Drive (required)
252 body: object, The request body. (required)
253 The object takes the form of:
254
255{ # Representation of a Team Drive.
256 "kind": "drive#teamDrive", # This is always drive#teamDrive
257 "id": "A String", # The ID of this Team Drive which is also the ID of the top level folder for this Team Drive.
258 "capabilities": { # Capabilities the current user has on this Team Drive.
259 "canReadRevisions": True or False, # Whether the current user has read access to the Revisions resource of files in this Team Drive.
260 "canCopy": True or False, # Whether files in this Team Drive can be copied by the current user.
261 "canRename": True or False, # Whether files or folders in this Team Drive can be renamed by the current user.
262 "canListChildren": True or False, # Whether the current user can list the children of folders in this Team Drive.
263 "canShare": True or False, # Whether the current user can share files or folders in this Team Drive.
264 "canManageMembers": True or False, # Whether the current user can add members to this Team Drive or remove them or change their role.
265 "canDownload": True or False, # Whether files in this Team Drive can be downloaded by the current user.
266 "canComment": True or False, # Whether the current user can comment on files in this Team Drive.
267 "canDeleteTeamDrive": True or False, # Whether this Team Drive can be deleted by the current user.
268 "canRenameTeamDrive": True or False, # Whether this Team Drive can be renamed by the current user.
269 "canRemoveChildren": True or False, # Whether the current user can remove children from folders in this Team Drive.
270 "canAddChildren": True or False, # Whether the current user can add children to folders in this Team Drive.
271 "canEdit": True or False, # Whether files in this Team Drive can be edited by the current user.
272 },
273 "name": "A String", # The name of this Team Drive.
274}
275
276
277Returns:
278 An object of the form:
279
280 { # Representation of a Team Drive.
281 "kind": "drive#teamDrive", # This is always drive#teamDrive
282 "id": "A String", # The ID of this Team Drive which is also the ID of the top level folder for this Team Drive.
283 "capabilities": { # Capabilities the current user has on this Team Drive.
284 "canReadRevisions": True or False, # Whether the current user has read access to the Revisions resource of files in this Team Drive.
285 "canCopy": True or False, # Whether files in this Team Drive can be copied by the current user.
286 "canRename": True or False, # Whether files or folders in this Team Drive can be renamed by the current user.
287 "canListChildren": True or False, # Whether the current user can list the children of folders in this Team Drive.
288 "canShare": True or False, # Whether the current user can share files or folders in this Team Drive.
289 "canManageMembers": True or False, # Whether the current user can add members to this Team Drive or remove them or change their role.
290 "canDownload": True or False, # Whether files in this Team Drive can be downloaded by the current user.
291 "canComment": True or False, # Whether the current user can comment on files in this Team Drive.
292 "canDeleteTeamDrive": True or False, # Whether this Team Drive can be deleted by the current user.
293 "canRenameTeamDrive": True or False, # Whether this Team Drive can be renamed by the current user.
294 "canRemoveChildren": True or False, # Whether the current user can remove children from folders in this Team Drive.
295 "canAddChildren": True or False, # Whether the current user can add children to folders in this Team Drive.
296 "canEdit": True or False, # Whether files in this Team Drive can be edited by the current user.
297 },
298 "name": "A String", # The name of this Team Drive.
299 }</pre>
300</div>
301
302</body></html>