Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / c30d2b5d4478b230246dcaaa9f1c533ca3304387 / . / docs / dyn / drive_v3.teamdrives.html
blob: 67ee7dbac2db9575994030b89c16c5a855392fda [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_v3.html">Drive API</a> . <a href="drive_v3.teamdrives.html">teamdrives</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#create">create(requestId, body)</a></code></p>
79<p class="firstline">Creates a new Team Drive.</p>
80<p class="toc_element">
81 <code><a href="#delete">delete(teamDriveId)</a></code></p>
82<p class="firstline">Permanently deletes a Team Drive for which the user is an organizer. The Team Drive cannot contain any untrashed items.</p>
83<p class="toc_element">
84 <code><a href="#get">get(teamDriveId)</a></code></p>
85<p class="firstline">Gets a Team Drive's metadata by ID.</p>
86<p class="toc_element">
87 <code><a href="#list">list(pageToken=None, pageSize=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="create">create(requestId, body)</code>
98 <pre>Creates a new Team Drive.
99
100Args:
101 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)
102 body: object, The request body. (required)
103 The object takes the form of:
104
105{ # Representation of a Team Drive.
106 "kind": "drive#teamDrive", # Identifies what kind of resource this is. Value: the fixed string "drive#teamDrive".
107 "id": "A String", # The ID of this Team Drive which is also the ID of the top level folder for this Team Drive.
108 "capabilities": { # Capabilities the current user has on this Team Drive.
109 "canReadRevisions": True or False, # Whether the current user has read access to the Revisions resource of files in this Team Drive.
110 "canCopy": True or False, # Whether files in this Team Drive can be copied by the current user.
111 "canRename": True or False, # Whether files or folders in this Team Drive can be renamed by the current user.
112 "canListChildren": True or False, # Whether the current user can list the children of folders in this Team Drive.
113 "canShare": True or False, # Whether the current user can share files or folders in this Team Drive.
114 "canManageMembers": True or False, # Whether the current user can add members to this Team Drive or remove them or change their role.
115 "canDownload": True or False, # Whether files in this Team Drive can be downloaded by the current user.
116 "canComment": True or False, # Whether the current user can comment on files in this Team Drive.
117 "canDeleteTeamDrive": True or False, # Whether this Team Drive can be deleted by the current user.
118 "canRenameTeamDrive": True or False, # Whether this Team Drive can be renamed by the current user.
119 "canRemoveChildren": True or False, # Whether the current user can remove children from folders in this Team Drive.
120 "canAddChildren": True or False, # Whether the current user can add children to folders in this Team Drive.
121 "canEdit": True or False, # Whether files in this Team Drive can be edited by the current user.
122 },
123 "name": "A String", # The name of this Team Drive.
124}
125
126
127Returns:
128 An object of the form:
129
130 { # Representation of a Team Drive.
131 "kind": "drive#teamDrive", # Identifies what kind of resource this is. Value: the fixed string "drive#teamDrive".
132 "id": "A String", # The ID of this Team Drive which is also the ID of the top level folder for this Team Drive.
133 "capabilities": { # Capabilities the current user has on this Team Drive.
134 "canReadRevisions": True or False, # Whether the current user has read access to the Revisions resource of files in this Team Drive.
135 "canCopy": True or False, # Whether files in this Team Drive can be copied by the current user.
136 "canRename": True or False, # Whether files or folders in this Team Drive can be renamed by the current user.
137 "canListChildren": True or False, # Whether the current user can list the children of folders in this Team Drive.
138 "canShare": True or False, # Whether the current user can share files or folders in this Team Drive.
139 "canManageMembers": True or False, # Whether the current user can add members to this Team Drive or remove them or change their role.
140 "canDownload": True or False, # Whether files in this Team Drive can be downloaded by the current user.
141 "canComment": True or False, # Whether the current user can comment on files in this Team Drive.
142 "canDeleteTeamDrive": True or False, # Whether this Team Drive can be deleted by the current user.
143 "canRenameTeamDrive": True or False, # Whether this Team Drive can be renamed by the current user.
144 "canRemoveChildren": True or False, # Whether the current user can remove children from folders in this Team Drive.
145 "canAddChildren": True or False, # Whether the current user can add children to folders in this Team Drive.
146 "canEdit": True or False, # Whether files in this Team Drive can be edited by the current user.
147 },
148 "name": "A String", # The name of this Team Drive.
149 }</pre>
150</div>
151
152<div class="method">
153 <code class="details" id="delete">delete(teamDriveId)</code>
154 <pre>Permanently deletes a Team Drive for which the user is an organizer. The Team Drive cannot contain any untrashed items.
155
156Args:
157 teamDriveId: string, The ID of the Team Drive (required)
158</pre>
159</div>
160
161<div class="method">
162 <code class="details" id="get">get(teamDriveId)</code>
163 <pre>Gets a Team Drive's metadata by ID.
164
165Args:
166 teamDriveId: string, The ID of the Team Drive (required)
167
168Returns:
169 An object of the form:
170
171 { # Representation of a Team Drive.
172 "kind": "drive#teamDrive", # Identifies what kind of resource this is. Value: the fixed string "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, pageSize=None)</code>
195 <pre>Lists the user's Team Drives.
196
197Args:
198 pageToken: string, Page token for Team Drives.
199 pageSize: 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. This will be absent if the end of the Team Drives list has been reached. If the token is rejected for any reason, it should be discarded, and pagination should be restarted from the first page of results.
206 "kind": "drive#teamDriveList", # Identifies what kind of resource this is. Value: the fixed string "drive#teamDriveList".
207 "teamDrives": [ # The list of Team Drives. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched.
208 { # Representation of a Team Drive.
209 "kind": "drive#teamDrive", # Identifies what kind of resource this is. Value: the fixed string "drive#teamDrive".
210 "id": "A String", # The ID of this Team Drive which is also the ID of the top level folder for this Team Drive.
211 "capabilities": { # Capabilities the current user has on this Team Drive.
212 "canReadRevisions": True or False, # Whether the current user has read access to the Revisions resource of files in this Team Drive.
213 "canCopy": True or False, # Whether files in this Team Drive can be copied by the current user.
214 "canRename": True or False, # Whether files or folders in this Team Drive can be renamed by the current user.
215 "canListChildren": True or False, # Whether the current user can list the children of folders in this Team Drive.
216 "canShare": True or False, # Whether the current user can share files or folders in this Team Drive.
217 "canManageMembers": True or False, # Whether the current user can add members to this Team Drive or remove them or change their role.
218 "canDownload": True or False, # Whether files in this Team Drive can be downloaded by the current user.
219 "canComment": True or False, # Whether the current user can comment on files in this Team Drive.
220 "canDeleteTeamDrive": True or False, # Whether this Team Drive can be deleted by the current user.
221 "canRenameTeamDrive": True or False, # Whether this Team Drive can be renamed by the current user.
222 "canRemoveChildren": True or False, # Whether the current user can remove children from folders in this Team Drive.
223 "canAddChildren": True or False, # Whether the current user can add children to folders in this Team Drive.
224 "canEdit": True or False, # Whether files in this Team Drive can be edited by the current user.
225 },
226 "name": "A String", # The name of this Team Drive.
227 },
228 ],
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", # Identifies what kind of resource this is. Value: the fixed string "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", # Identifies what kind of resource this is. Value: the fixed string "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>