Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 02bae1c909ec28088ebbc4007f3ef9b968b55e0a / . / docs / dyn / drive_v2.children.html
blob: 59d9772c87852a2b2ce4eb84ce1fc762315d94ae [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">
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]84 <code><a href="#insert">insert(folderId, body, supportsTeamDrives=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]85<p class="firstline">Inserts a file into a folder.</p>
86<p class="toc_element">
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]87 <code><a href="#list">list(folderId, orderBy=None, q=None, pageToken=None, maxResults=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]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">
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]123 <code class="details" id="insert">insert(folderId, body, supportsTeamDrives=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]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
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]138 supportsTeamDrives: boolean, Whether the requesting application supports Team Drives.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]139
140Returns:
141 An object of the form:
142
143 { # A reference to a folder's child.
144 "kind": "drive#childReference", # This is always drive#childReference.
145 "childLink": "A String", # A link to the child.
146 "id": "A String", # The ID of the child.
147 "selfLink": "A String", # A link back to this reference.
148 }</pre>
149</div>
150
151<div class="method">
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]152 <code class="details" id="list">list(folderId, orderBy=None, q=None, pageToken=None, maxResults=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]153 <pre>Lists a folder's children.
154
155Args:
156 folderId: string, The ID of the folder. (required)
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]157 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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]158 q: string, Query string for searching children.
159 pageToken: string, Page token for children.
160 maxResults: integer, Maximum number of children to return.
161
162Returns:
163 An object of the form:
164
165 { # A list of children of a file.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]166 "nextPageToken": "A String", # 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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]167 "kind": "drive#childList", # This is always drive#childList.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]168 "items": [ # The list of children. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]169 { # A reference to a folder's child.
170 "kind": "drive#childReference", # This is always drive#childReference.
171 "childLink": "A String", # A link to the child.
172 "id": "A String", # The ID of the child.
173 "selfLink": "A String", # A link back to this reference.
174 },
175 ],
176 "nextLink": "A String", # A link to the next page of children.
177 "etag": "A String", # The ETag of the list.
178 "selfLink": "A String", # A link back to this list.
179 }</pre>
180</div>
181
182<div class="method">
183 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
184 <pre>Retrieves the next page of results.
185
186Args:
187 previous_request: The request for the previous page. (required)
188 previous_response: The response from the request for the previous page. (required)
189
190Returns:
191 A request object that you can call 'execute()' on to request the next
192 page. Returns None if there are no more items in the collection.
193 </pre>
194</div>
195
196</body></html>