Debian Codegraph @

docs/dyn/drive_v2.children.html

raw
1 <html><body>
2 <style>
3
4 body, 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
15 body {
16 font-size: 13px;
17 padding: 1em;
18 }
19
20 h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23 }
24
25 h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28 }
29
30 h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34 }
35
36 pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39 }
40
41 pre {
42 margin-top: 0.5em;
43 }
44
45 h1, h2, h3, p {
46 font-family: Arial, sans serif;
47 }
48
49 h1, 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">Google Drive API</a> . <a href="drive_v2.children.html">children</a></h1>
76 <h2>Instance Methods</h2>
77 <p class="toc_element">
78 <code><a href="#close">close()</a></code></p>
79 <p class="firstline">Close httplib2 connections.</p>
80 <p class="toc_element">
81 <code><a href="#delete">delete(folderId, childId, enforceSingleParent=None, x__xgafv=None)</a></code></p>
82 <p class="firstline">Removes a child from a folder.</p>
83 <p class="toc_element">
84 <code><a href="#get">get(folderId, childId, x__xgafv=None)</a></code></p>
85 <p class="firstline">Gets a specific child reference.</p>
86 <p class="toc_element">
87 <code><a href="#insert">insert(folderId, body=None, enforceSingleParent=None, supportsAllDrives=None, supportsTeamDrives=None, x__xgafv=None)</a></code></p>
88 <p class="firstline">Inserts a file into a folder.</p>
89 <p class="toc_element">
90 <code><a href="#list">list(folderId, maxResults=None, orderBy=None, pageToken=None, q=None, x__xgafv=None)</a></code></p>
91 <p class="firstline">Lists a folder's children.</p>
92 <p class="toc_element">
93 <code><a href="#list_next">list_next()</a></code></p>
94 <p class="firstline">Retrieves the next page of results.</p>
95 <h3>Method Details</h3>
96 <div class="method">
97 <code class="details" id="close">close()</code>
98 <pre>Close httplib2 connections.</pre>
99 </div>
100
101 <div class="method">
102 <code class="details" id="delete">delete(folderId, childId, enforceSingleParent=None, x__xgafv=None)</code>
103 <pre>Removes a child from a folder.
104
105 Args:
106 folderId: string, The ID of the folder. (required)
107 childId: string, The ID of the child. (required)
108 enforceSingleParent: boolean, Deprecated: If an item is not in a shared drive and its last parent is removed, the item is placed under its owner&#x27;s root.
109 x__xgafv: string, V1 error format.
110 Allowed values
111 1 - v1 error format
112 2 - v2 error format
113 </pre>
114 </div>
115
116 <div class="method">
117 <code class="details" id="get">get(folderId, childId, x__xgafv=None)</code>
118 <pre>Gets a specific child reference.
119
120 Args:
121 folderId: string, The ID of the folder. (required)
122 childId: string, The ID of the child. (required)
123 x__xgafv: string, V1 error format.
124 Allowed values
125 1 - v1 error format
126 2 - v2 error format
127
128 Returns:
129 An object of the form:
130
131 { # A reference to a folder&#x27;s child. Some resource methods (such as `children.get`) require a `childId`. Use the `children.list` method to retrieve the ID of the child.
132 &quot;childLink&quot;: &quot;A String&quot;, # Output only. A link to the child.
133 &quot;id&quot;: &quot;A String&quot;, # The ID of the child.
134 &quot;kind&quot;: &quot;drive#childReference&quot;, # Output only. This is always `drive#childReference`.
135 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. A link back to this reference.
136 }</pre>
137 </div>
138
139 <div class="method">
140 <code class="details" id="insert">insert(folderId, body=None, enforceSingleParent=None, supportsAllDrives=None, supportsTeamDrives=None, x__xgafv=None)</code>
141 <pre>Inserts a file into a folder.
142
143 Args:
144 folderId: string, The ID of the folder. (required)
145 body: object, The request body.
146 The object takes the form of:
147
148 { # A reference to a folder&#x27;s child. Some resource methods (such as `children.get`) require a `childId`. Use the `children.list` method to retrieve the ID of the child.
149 &quot;childLink&quot;: &quot;A String&quot;, # Output only. A link to the child.
150 &quot;id&quot;: &quot;A String&quot;, # The ID of the child.
151 &quot;kind&quot;: &quot;drive#childReference&quot;, # Output only. This is always `drive#childReference`.
152 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. A link back to this reference.
153 }
154
155 enforceSingleParent: boolean, Deprecated: Adding files to multiple folders is no longer supported. Use `shortcuts` instead.
156 supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives.
157 supportsTeamDrives: boolean, Deprecated: Use `supportsAllDrives` instead.
158 x__xgafv: string, V1 error format.
159 Allowed values
160 1 - v1 error format
161 2 - v2 error format
162
163 Returns:
164 An object of the form:
165
166 { # A reference to a folder&#x27;s child. Some resource methods (such as `children.get`) require a `childId`. Use the `children.list` method to retrieve the ID of the child.
167 &quot;childLink&quot;: &quot;A String&quot;, # Output only. A link to the child.
168 &quot;id&quot;: &quot;A String&quot;, # The ID of the child.
169 &quot;kind&quot;: &quot;drive#childReference&quot;, # Output only. This is always `drive#childReference`.
170 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. A link back to this reference.
171 }</pre>
172 </div>
173
174 <div class="method">
175 <code class="details" id="list">list(folderId, maxResults=None, orderBy=None, pageToken=None, q=None, x__xgafv=None)</code>
176 <pre>Lists a folder&#x27;s children.
177
178 Args:
179 folderId: string, The ID of the folder. (required)
180 maxResults: integer, Maximum number of children to return.
181 orderBy: string, A comma-separated list of sort keys. Valid keys are `createdDate`, `folder`, `lastViewedByMeDate`, `modifiedByMeDate`, `modifiedDate`, `quotaBytesUsed`, `recency`, `sharedWithMeDate`, `starred`, and `title`. Each key sorts ascending by default, but may be reversed with the `desc` 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.
182 pageToken: string, Page token for children.
183 q: string, Query string for searching children.
184 x__xgafv: string, V1 error format.
185 Allowed values
186 1 - v1 error format
187 2 - v2 error format
188
189 Returns:
190 An object of the form:
191
192 { # A list of children of a file.
193 &quot;etag&quot;: &quot;A String&quot;, # The ETag of the list.
194 &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.
195 { # A reference to a folder&#x27;s child. Some resource methods (such as `children.get`) require a `childId`. Use the `children.list` method to retrieve the ID of the child.
196 &quot;childLink&quot;: &quot;A String&quot;, # Output only. A link to the child.
197 &quot;id&quot;: &quot;A String&quot;, # The ID of the child.
198 &quot;kind&quot;: &quot;drive#childReference&quot;, # Output only. This is always `drive#childReference`.
199 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. A link back to this reference.
200 },
201 ],
202 &quot;kind&quot;: &quot;drive#childList&quot;, # This is always `drive#childList`.
203 &quot;nextLink&quot;: &quot;A String&quot;, # A link to the next page of children.
204 &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.
205 &quot;selfLink&quot;: &quot;A String&quot;, # A link back to this list.
206 }</pre>
207 </div>
208
209 <div class="method">
210 <code class="details" id="list_next">list_next()</code>
211 <pre>Retrieves the next page of results.
212
213 Args:
214 previous_request: The request for the previous page. (required)
215 previous_response: The response from the request for the previous page. (required)
216
217 Returns:
218 A request object that you can call &#x27;execute()&#x27; on to request the next
219 page. Returns None if there are no more items in the collection.
220 </pre>
221 </div>
222
223 </body></html>