blob: efd67514680fba1d5919bd8abf6f5c2322d6db6d [file] [log] [blame] [edit]
<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.parents.html">parents</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(fileId, parentId, enforceSingleParent=None, x__xgafv=None)</a></code></p>
<p class="firstline">Removes a parent from a file.</p>
<p class="toc_element">
<code><a href="#get">get(fileId, parentId, x__xgafv=None)</a></code></p>
<p class="firstline">Gets a specific parent reference.</p>
<p class="toc_element">
<code><a href="#insert">insert(fileId, body=None, enforceSingleParent=None, supportsAllDrives=None, supportsTeamDrives=None, x__xgafv=None)</a></code></p>
<p class="firstline">Adds a parent folder for a file.</p>
<p class="toc_element">
<code><a href="#list">list(fileId, x__xgafv=None)</a></code></p>
<p class="firstline">Lists a file's parents.</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(fileId, parentId, enforceSingleParent=None, x__xgafv=None)</code>
<pre>Removes a parent from a file.
Args:
fileId: string, The ID of the file. (required)
parentId: string, The ID of the parent. (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(fileId, parentId, x__xgafv=None)</code>
<pre>Gets a specific parent reference.
Args:
fileId: string, The ID of the file. (required)
parentId: string, The ID of the parent. (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 file&#x27;s parent. A file can only have one parent folder; specifying multiple parents isn&#x27;t supported. Some resource methods (such as `parents.get`) require a `parentId`. Use the `parents.list` method to retrieve the ID for a parent.
&quot;id&quot;: &quot;A String&quot;, # The ID of the parent.
&quot;isRoot&quot;: True or False, # Output only. Whether or not the parent is the root folder.
&quot;kind&quot;: &quot;drive#parentReference&quot;, # Output only. This is always `drive#parentReference`.
&quot;parentLink&quot;: &quot;A String&quot;, # Output only. A link to the parent.
&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(fileId, body=None, enforceSingleParent=None, supportsAllDrives=None, supportsTeamDrives=None, x__xgafv=None)</code>
<pre>Adds a parent folder for a file.
Args:
fileId: string, The ID of the file. (required)
body: object, The request body.
The object takes the form of:
{ # A reference to a file&#x27;s parent. A file can only have one parent folder; specifying multiple parents isn&#x27;t supported. Some resource methods (such as `parents.get`) require a `parentId`. Use the `parents.list` method to retrieve the ID for a parent.
&quot;id&quot;: &quot;A String&quot;, # The ID of the parent.
&quot;isRoot&quot;: True or False, # Output only. Whether or not the parent is the root folder.
&quot;kind&quot;: &quot;drive#parentReference&quot;, # Output only. This is always `drive#parentReference`.
&quot;parentLink&quot;: &quot;A String&quot;, # Output only. A link to the parent.
&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 file&#x27;s parent. A file can only have one parent folder; specifying multiple parents isn&#x27;t supported. Some resource methods (such as `parents.get`) require a `parentId`. Use the `parents.list` method to retrieve the ID for a parent.
&quot;id&quot;: &quot;A String&quot;, # The ID of the parent.
&quot;isRoot&quot;: True or False, # Output only. Whether or not the parent is the root folder.
&quot;kind&quot;: &quot;drive#parentReference&quot;, # Output only. This is always `drive#parentReference`.
&quot;parentLink&quot;: &quot;A String&quot;, # Output only. A link to the parent.
&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(fileId, x__xgafv=None)</code>
<pre>Lists a file&#x27;s parents.
Args:
fileId: string, The ID of the file. (required)
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 a file&#x27;s parents.
&quot;etag&quot;: &quot;A String&quot;, # The ETag of the list.
&quot;items&quot;: [ # The list of parents.
{ # A reference to a file&#x27;s parent. A file can only have one parent folder; specifying multiple parents isn&#x27;t supported. Some resource methods (such as `parents.get`) require a `parentId`. Use the `parents.list` method to retrieve the ID for a parent.
&quot;id&quot;: &quot;A String&quot;, # The ID of the parent.
&quot;isRoot&quot;: True or False, # Output only. Whether or not the parent is the root folder.
&quot;kind&quot;: &quot;drive#parentReference&quot;, # Output only. This is always `drive#parentReference`.
&quot;parentLink&quot;: &quot;A String&quot;, # Output only. A link to the parent.
&quot;selfLink&quot;: &quot;A String&quot;, # Output only. A link back to this reference.
},
],
&quot;kind&quot;: &quot;drive#parentList&quot;, # This is always `drive#parentList`.
&quot;selfLink&quot;: &quot;A String&quot;, # A link back to this list.
}</pre>
</div>
</body></html>