blob: 0314d64a58ef046547a8f78b2a30c734f90419f1 [file] [log] [blame]
John Asmuth614db982014-04-24 15:46:26 -04001<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.children.html">children</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070078 <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070081 <code><a href="#delete">delete(folderId, childId, enforceSingleParent=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -040082<p class="firstline">Removes a child from a folder.</p>
83<p class="toc_element">
84 <code><a href="#get">get(folderId, childId)</a></code></p>
85<p class="firstline">Gets a specific child reference.</p>
86<p class="toc_element">
Bu Sun Kim65020912020-05-20 12:08:20 -070087 <code><a href="#insert">insert(folderId, body=None, enforceSingleParent=None, supportsAllDrives=None, supportsTeamDrives=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -040088<p class="firstline">Inserts a file into a folder.</p>
89<p class="toc_element">
Bu Sun Kim65020912020-05-20 12:08:20 -070090 <code><a href="#list">list(folderId, maxResults=None, orderBy=None, pageToken=None, q=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -040091<p class="firstline">Lists a folder's children.</p>
92<p class="toc_element">
93 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
94<p class="firstline">Retrieves the next page of results.</p>
95<h3>Method Details</h3>
96<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070097 <code class="details" id="close">close()</code>
98 <pre>Close httplib2 connections.</pre>
99</div>
100
101<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700102 <code class="details" id="delete">delete(folderId, childId, enforceSingleParent=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400103 <pre>Removes a child from a folder.
104
105Args:
106 folderId: string, The ID of the folder. (required)
107 childId: string, The ID of the child. (required)
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800108 enforceSingleParent: boolean, Deprecated. If an item is not in a shared drive and its last parent is deleted but the item itself is not, the item will be placed under its owner&#x27;s root.
John Asmuth614db982014-04-24 15:46:26 -0400109</pre>
110</div>
111
112<div class="method">
113 <code class="details" id="get">get(folderId, childId)</code>
114 <pre>Gets a specific child reference.
115
116Args:
117 folderId: string, The ID of the folder. (required)
118 childId: string, The ID of the child. (required)
119
120Returns:
121 An object of the form:
122
Bu Sun Kim65020912020-05-20 12:08:20 -0700123 { # A reference to a folder&#x27;s child.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800124 &quot;childLink&quot;: &quot;A String&quot;, # A link to the child.
125 &quot;id&quot;: &quot;A String&quot;, # The ID of the child.
126 &quot;kind&quot;: &quot;drive#childReference&quot;, # This is always drive#childReference.
127 &quot;selfLink&quot;: &quot;A String&quot;, # A link back to this reference.
128}</pre>
John Asmuth614db982014-04-24 15:46:26 -0400129</div>
130
131<div class="method">
Bu Sun Kim65020912020-05-20 12:08:20 -0700132 <code class="details" id="insert">insert(folderId, body=None, enforceSingleParent=None, supportsAllDrives=None, supportsTeamDrives=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400133 <pre>Inserts a file into a folder.
134
135Args:
136 folderId: string, The ID of the folder. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700137 body: object, The request body.
John Asmuth614db982014-04-24 15:46:26 -0400138 The object takes the form of:
139
Bu Sun Kim65020912020-05-20 12:08:20 -0700140{ # A reference to a folder&#x27;s child.
141 &quot;childLink&quot;: &quot;A String&quot;, # A link to the child.
142 &quot;id&quot;: &quot;A String&quot;, # The ID of the child.
143 &quot;kind&quot;: &quot;drive#childReference&quot;, # This is always drive#childReference.
144 &quot;selfLink&quot;: &quot;A String&quot;, # A link back to this reference.
145}
John Asmuth614db982014-04-24 15:46:26 -0400146
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800147 enforceSingleParent: boolean, Deprecated. Adding files to multiple folders is no longer supported. Use shortcuts instead.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700148 supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives.
Bu Sun Kim65020912020-05-20 12:08:20 -0700149 supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead.
John Asmuth614db982014-04-24 15:46:26 -0400150
151Returns:
152 An object of the form:
153
Bu Sun Kim65020912020-05-20 12:08:20 -0700154 { # A reference to a folder&#x27;s child.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800155 &quot;childLink&quot;: &quot;A String&quot;, # A link to the child.
156 &quot;id&quot;: &quot;A String&quot;, # The ID of the child.
157 &quot;kind&quot;: &quot;drive#childReference&quot;, # This is always drive#childReference.
158 &quot;selfLink&quot;: &quot;A String&quot;, # A link back to this reference.
159}</pre>
John Asmuth614db982014-04-24 15:46:26 -0400160</div>
161
162<div class="method">
Bu Sun Kim65020912020-05-20 12:08:20 -0700163 <code class="details" id="list">list(folderId, maxResults=None, orderBy=None, pageToken=None, q=None)</code>
164 <pre>Lists a folder&#x27;s children.
John Asmuth614db982014-04-24 15:46:26 -0400165
166Args:
167 folderId: string, The ID of the folder. (required)
John Asmuth614db982014-04-24 15:46:26 -0400168 maxResults: integer, Maximum number of children to return.
Bu Sun Kim65020912020-05-20 12:08:20 -0700169 orderBy: string, A comma-separated list of sort keys. Valid keys are &#x27;createdDate&#x27;, &#x27;folder&#x27;, &#x27;lastViewedByMeDate&#x27;, &#x27;modifiedByMeDate&#x27;, &#x27;modifiedDate&#x27;, &#x27;quotaBytesUsed&#x27;, &#x27;recency&#x27;, &#x27;sharedWithMeDate&#x27;, &#x27;starred&#x27;, and &#x27;title&#x27;. Each key sorts ascending by default, but may be reversed with the &#x27;desc&#x27; modifier. Example usage: ?orderBy=folder,modifiedDate desc,title. Please note that there is a current limitation for users with approximately one million files in which the requested sort order is ignored.
170 pageToken: string, Page token for children.
171 q: string, Query string for searching children.
John Asmuth614db982014-04-24 15:46:26 -0400172
173Returns:
174 An object of the form:
175
176 { # A list of children of a file.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800177 &quot;etag&quot;: &quot;A String&quot;, # The ETag of the list.
178 &quot;items&quot;: [ # The list of children. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched.
179 { # A reference to a folder&#x27;s child.
180 &quot;childLink&quot;: &quot;A String&quot;, # A link to the child.
181 &quot;id&quot;: &quot;A String&quot;, # The ID of the child.
182 &quot;kind&quot;: &quot;drive#childReference&quot;, # This is always drive#childReference.
183 &quot;selfLink&quot;: &quot;A String&quot;, # A link back to this reference.
184 },
185 ],
186 &quot;kind&quot;: &quot;drive#childList&quot;, # This is always drive#childList.
187 &quot;nextLink&quot;: &quot;A String&quot;, # A link to the next page of children.
188 &quot;nextPageToken&quot;: &quot;A String&quot;, # The page token for the next page of children. This will be absent if the end of the children 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.
189 &quot;selfLink&quot;: &quot;A String&quot;, # A link back to this list.
190}</pre>
John Asmuth614db982014-04-24 15:46:26 -0400191</div>
192
193<div class="method">
194 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
195 <pre>Retrieves the next page of results.
196
197Args:
198 previous_request: The request for the previous page. (required)
199 previous_response: The response from the request for the previous page. (required)
200
201Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700202 A request object that you can call &#x27;execute()&#x27; on to request the next
John Asmuth614db982014-04-24 15:46:26 -0400203 page. Returns None if there are no more items in the collection.
204 </pre>
205</div>
206
207</body></html>