Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / dd49464a6262c0d1f71efcf11f131e2f591fe5f6 / . / docs / dyn / drive_v2.parents.html
blob: 0620c4a8f9c3c92a9f13b80ac8a66119ecf59246 [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.parents.html">parents</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]78 <code><a href="#delete">delete(fileId, parentId, enforceSingleParent=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]79<p class="firstline">Removes a parent from a file.</p>
80<p class="toc_element">
81 <code><a href="#get">get(fileId, parentId)</a></code></p>
82<p class="firstline">Gets a specific parent reference.</p>
83<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]84 <code><a href="#insert">insert(fileId, body=None, enforceSingleParent=None, supportsTeamDrives=None, supportsAllDrives=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]85<p class="firstline">Adds a parent folder for a file.</p>
86<p class="toc_element">
87 <code><a href="#list">list(fileId)</a></code></p>
88<p class="firstline">Lists a file's parents.</p>
89<h3>Method Details</h3>
90<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]91 <code class="details" id="delete">delete(fileId, parentId, enforceSingleParent=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]92 <pre>Removes a parent from a file.
93
94Args:
95 fileId: string, The ID of the file. (required)
96 parentId: string, The ID of the parent. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]97 enforceSingleParent: boolean, Set to true to opt in to API behavior that aims for all items to have exactly one parent. This parameter only takes effect if the item is not in a shared drive. If the item's last parent is removed, the item is placed under its owner's root.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]98</pre>
99</div>
100
101<div class="method">
102 <code class="details" id="get">get(fileId, parentId)</code>
103 <pre>Gets a specific parent reference.
104
105Args:
106 fileId: string, The ID of the file. (required)
107 parentId: string, The ID of the parent. (required)
108
109Returns:
110 An object of the form:
111
112 { # A reference to a file's parent.
113 "selfLink": "A String", # A link back to this reference.
114 "kind": "drive#parentReference", # This is always drive#parentReference.
115 "id": "A String", # The ID of the parent.
116 "isRoot": True or False, # Whether or not the parent is the root folder.
117 "parentLink": "A String", # A link to the parent.
118 }</pre>
119</div>
120
121<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]122 <code class="details" id="insert">insert(fileId, body=None, enforceSingleParent=None, supportsTeamDrives=None, supportsAllDrives=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]123 <pre>Adds a parent folder for a file.
124
125Args:
126 fileId: string, The ID of the file. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]127 body: object, The request body.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]128 The object takes the form of:
129
130{ # A reference to a file's parent.
131 "selfLink": "A String", # A link back to this reference.
132 "kind": "drive#parentReference", # This is always drive#parentReference.
133 "id": "A String", # The ID of the parent.
134 "isRoot": True or False, # Whether or not the parent is the root folder.
135 "parentLink": "A String", # A link to the parent.
136}
137
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]138 enforceSingleParent: boolean, Set to true to opt in to API behavior that aims for all items to have exactly one parent. This parameter only takes effect if the item is not in a shared drive. If the child's owner makes the request, the child is removed from all current folders and placed in the requested folder. Any other requests that increase the number of the child's parents fail, except when the canAddMyDriveParent file capability is true and a single parent is being added.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]139 supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead.
140 supportsAllDrives: boolean, Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]141
142Returns:
143 An object of the form:
144
145 { # A reference to a file's parent.
146 "selfLink": "A String", # A link back to this reference.
147 "kind": "drive#parentReference", # This is always drive#parentReference.
148 "id": "A String", # The ID of the parent.
149 "isRoot": True or False, # Whether or not the parent is the root folder.
150 "parentLink": "A String", # A link to the parent.
151 }</pre>
152</div>
153
154<div class="method">
155 <code class="details" id="list">list(fileId)</code>
156 <pre>Lists a file's parents.
157
158Args:
159 fileId: string, The ID of the file. (required)
160
161Returns:
162 An object of the form:
163
164 { # A list of a file's parents.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]165 "items": [ # The list of parents.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]166 { # A reference to a file's parent.
167 "selfLink": "A String", # A link back to this reference.
168 "kind": "drive#parentReference", # This is always drive#parentReference.
169 "id": "A String", # The ID of the parent.
170 "isRoot": True or False, # Whether or not the parent is the root folder.
171 "parentLink": "A String", # A link to the parent.
172 },
173 ],
174 "kind": "drive#parentList", # This is always drive#parentList.
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</body></html>