File: drive_v2.children.html

package info (click to toggle)
python-googleapi 2.180.0-1
  • links: PTS
  • area: main
  • in suites: forky, sid
  • size: 527,124 kB
  • sloc: python: 11,076; javascript: 249; sh: 114; makefile: 59
file content (223 lines) | stat: -rw-r--r-- 8,591 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
<html><body>
<style>

body, h1, h2, h3, div, span, p, pre, a {
  margin: 0;
  padding: 0;
  border: 0;
  font-weight: inherit;
  font-style: inherit;
  font-size: 100%;
  font-family: inherit;
  vertical-align: baseline;
}

body {
  font-size: 13px;
  padding: 1em;
}

h1 {
  font-size: 26px;
  margin-bottom: 1em;
}

h2 {
  font-size: 24px;
  margin-bottom: 1em;
}

h3 {
  font-size: 20px;
  margin-bottom: 1em;
  margin-top: 1em;
}

pre, code {
  line-height: 1.5;
  font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}

pre {
  margin-top: 0.5em;
}

h1, h2, h3, p {
  font-family: Arial, sans serif;
}

h1, h2, h3 {
  border-bottom: solid #CCC 1px;
}

.toc_element {
  margin-top: 0.5em;
}

.firstline {
  margin-left: 2 em;
}

.method  {
  margin-top: 1em;
  border: solid 1px #CCC;
  padding: 1em;
  background: #EEE;
}

.details {
  font-weight: bold;
  font-size: 14px;
}

</style>

<h1><a href="drive_v2.html">Google Drive API</a> . <a href="drive_v2.children.html">children</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
  <code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
  <code><a href="#delete">delete(folderId, childId, enforceSingleParent=None, x__xgafv=None)</a></code></p>
<p class="firstline">Removes a child from a folder.</p>
<p class="toc_element">
  <code><a href="#get">get(folderId, childId, x__xgafv=None)</a></code></p>
<p class="firstline">Gets a specific child reference.</p>
<p class="toc_element">
  <code><a href="#insert">insert(folderId, body=None, enforceSingleParent=None, supportsAllDrives=None, supportsTeamDrives=None, x__xgafv=None)</a></code></p>
<p class="firstline">Inserts a file into a folder.</p>
<p class="toc_element">
  <code><a href="#list">list(folderId, maxResults=None, orderBy=None, pageToken=None, q=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists a folder's children.</p>
<p class="toc_element">
  <code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
    <code class="details" id="close">close()</code>
  <pre>Close httplib2 connections.</pre>
</div>

<div class="method">
    <code class="details" id="delete">delete(folderId, childId, enforceSingleParent=None, x__xgafv=None)</code>
  <pre>Removes a child from a folder.

Args:
  folderId: string, The ID of the folder. (required)
  childId: string, The ID of the child. (required)
  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.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format
</pre>
</div>

<div class="method">
    <code class="details" id="get">get(folderId, childId, x__xgafv=None)</code>
  <pre>Gets a specific child reference.

Args:
  folderId: string, The ID of the folder. (required)
  childId: string, The ID of the child. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # 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.
  &quot;childLink&quot;: &quot;A String&quot;, # Output only. A link to the child.
  &quot;id&quot;: &quot;A String&quot;, # The ID of the child.
  &quot;kind&quot;: &quot;drive#childReference&quot;, # Output only. This is always `drive#childReference`.
  &quot;selfLink&quot;: &quot;A String&quot;, # Output only. A link back to this reference.
}</pre>
</div>

<div class="method">
    <code class="details" id="insert">insert(folderId, body=None, enforceSingleParent=None, supportsAllDrives=None, supportsTeamDrives=None, x__xgafv=None)</code>
  <pre>Inserts a file into a folder.

Args:
  folderId: string, The ID of the folder. (required)
  body: object, The request body.
    The object takes the form of:

{ # 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.
  &quot;childLink&quot;: &quot;A String&quot;, # Output only. A link to the child.
  &quot;id&quot;: &quot;A String&quot;, # The ID of the child.
  &quot;kind&quot;: &quot;drive#childReference&quot;, # Output only. This is always `drive#childReference`.
  &quot;selfLink&quot;: &quot;A String&quot;, # Output only. A link back to this reference.
}

  enforceSingleParent: boolean, Deprecated: Adding files to multiple folders is no longer supported. Use `shortcuts` instead.
  supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives.
  supportsTeamDrives: boolean, Deprecated: Use `supportsAllDrives` instead.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # 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.
  &quot;childLink&quot;: &quot;A String&quot;, # Output only. A link to the child.
  &quot;id&quot;: &quot;A String&quot;, # The ID of the child.
  &quot;kind&quot;: &quot;drive#childReference&quot;, # Output only. This is always `drive#childReference`.
  &quot;selfLink&quot;: &quot;A String&quot;, # Output only. A link back to this reference.
}</pre>
</div>

<div class="method">
    <code class="details" id="list">list(folderId, maxResults=None, orderBy=None, pageToken=None, q=None, x__xgafv=None)</code>
  <pre>Lists a folder&#x27;s children.

Args:
  folderId: string, The ID of the folder. (required)
  maxResults: integer, Maximum number of children to return.
  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.
  pageToken: string, Page token for children.
  q: string, Query string for searching children.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A list of children of a file.
  &quot;etag&quot;: &quot;A String&quot;, # The ETag of the list.
  &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.
    { # 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.
      &quot;childLink&quot;: &quot;A String&quot;, # Output only. A link to the child.
      &quot;id&quot;: &quot;A String&quot;, # The ID of the child.
      &quot;kind&quot;: &quot;drive#childReference&quot;, # Output only. This is always `drive#childReference`.
      &quot;selfLink&quot;: &quot;A String&quot;, # Output only. A link back to this reference.
    },
  ],
  &quot;kind&quot;: &quot;drive#childList&quot;, # This is always `drive#childList`.
  &quot;nextLink&quot;: &quot;A String&quot;, # A link to the next page of children.
  &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.
  &quot;selfLink&quot;: &quot;A String&quot;, # A link back to this list.
}</pre>
</div>

<div class="method">
    <code class="details" id="list_next">list_next()</code>
  <pre>Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call &#x27;execute()&#x27; on to request the next
          page. Returns None if there are no more items in the collection.
        </pre>
</div>

</body></html>