Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 614db98bf45b9da1f29c35a9d942536111e99d41 / . / docs / dyn / drive_v2.children.html
blob: 6babcde77bf216b45d3cda31a6bf0ededc5c39fa [file] [log] [blame]
John Asmuth614db982014-04-24 15:46:26 -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.children.html">children</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#delete">delete(folderId, childId)</a></code></p>
79<p class="firstline">Removes a child from a folder.</p>
80<p class="toc_element">
81 <code><a href="#get">get(folderId, childId)</a></code></p>
82<p class="firstline">Gets a specific child reference.</p>
83<p class="toc_element">
84 <code><a href="#insert">insert(folderId, body)</a></code></p>
85<p class="firstline">Inserts a file into a folder.</p>
86<p class="toc_element">
87 <code><a href="#list">list(folderId, q=None, pageToken=None, maxResults=None)</a></code></p>
88<p class="firstline">Lists a folder's children.</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<h3>Method Details</h3>
93<div class="method">
94 <code class="details" id="delete">delete(folderId, childId)</code>
95 <pre>Removes a child from a folder.
96
97Args:
98 folderId: string, The ID of the folder. (required)
99 childId: string, The ID of the child. (required)
100</pre>
101</div>
102
103<div class="method">
104 <code class="details" id="get">get(folderId, childId)</code>
105 <pre>Gets a specific child reference.
106
107Args:
108 folderId: string, The ID of the folder. (required)
109 childId: string, The ID of the child. (required)
110
111Returns:
112 An object of the form:
113
114 { # A reference to a folder's child.
115 "kind": "drive#childReference", # This is always drive#childReference.
116 "childLink": "A String", # A link to the child.
117 "id": "A String", # The ID of the child.
118 "selfLink": "A String", # A link back to this reference.
119 }</pre>
120</div>
121
122<div class="method">
123 <code class="details" id="insert">insert(folderId, body)</code>
124 <pre>Inserts a file into a folder.
125
126Args:
127 folderId: string, The ID of the folder. (required)
128 body: object, The request body. (required)
129 The object takes the form of:
130
131{ # A reference to a folder's child.
132 "kind": "drive#childReference", # This is always drive#childReference.
133 "childLink": "A String", # A link to the child.
134 "id": "A String", # The ID of the child.
135 "selfLink": "A String", # A link back to this reference.
136 }
137
138
139Returns:
140 An object of the form:
141
142 { # A reference to a folder's child.
143 "kind": "drive#childReference", # This is always drive#childReference.
144 "childLink": "A String", # A link to the child.
145 "id": "A String", # The ID of the child.
146 "selfLink": "A String", # A link back to this reference.
147 }</pre>
148</div>
149
150<div class="method">
151 <code class="details" id="list">list(folderId, q=None, pageToken=None, maxResults=None)</code>
152 <pre>Lists a folder's children.
153
154Args:
155 folderId: string, The ID of the folder. (required)
156 q: string, Query string for searching children.
157 pageToken: string, Page token for children.
158 maxResults: integer, Maximum number of children to return.
159
160Returns:
161 An object of the form:
162
163 { # A list of children of a file.
164 "nextPageToken": "A String", # The page token for the next page of children.
165 "kind": "drive#childList", # This is always drive#childList.
166 "items": [ # The actual list of children.
167 { # A reference to a folder's child.
168 "kind": "drive#childReference", # This is always drive#childReference.
169 "childLink": "A String", # A link to the child.
170 "id": "A String", # The ID of the child.
171 "selfLink": "A String", # A link back to this reference.
172 },
173 ],
174 "nextLink": "A String", # A link to the next page of children.
175 "etag": "A String", # The ETag of the list.
176 "selfLink": "A String", # A link back to this list.
177 }</pre>
178</div>
179
180<div class="method">
181 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
182 <pre>Retrieves the next page of results.
183
184Args:
185 previous_request: The request for the previous page. (required)
186 previous_response: The response from the request for the previous page. (required)
187
188Returns:
189 A request object that you can call 'execute()' on to request the next
190 page. Returns None if there are no more items in the collection.
191 </pre>
192</div>
193
194</body></html>