blob: c1b276199e24b05834f4066fd9f29c6a4c44e1d1 [file] [log] [blame]
John Asmuth614db982014-04-24 15:46:26 -04001<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">
78 <code><a href="#delete">delete(fileId, parentId)</a></code></p>
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">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070084 <code><a href="#insert">insert(fileId, body, supportsTeamDrives=None, supportsAllDrives=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -040085<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">
91 <code class="details" id="delete">delete(fileId, parentId)</code>
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)
97</pre>
98</div>
99
100<div class="method">
101 <code class="details" id="get">get(fileId, parentId)</code>
102 <pre>Gets a specific parent reference.
103
104Args:
105 fileId: string, The ID of the file. (required)
106 parentId: string, The ID of the parent. (required)
107
108Returns:
109 An object of the form:
110
111 { # A reference to a file's parent.
112 "selfLink": "A String", # A link back to this reference.
113 "kind": "drive#parentReference", # This is always drive#parentReference.
114 "id": "A String", # The ID of the parent.
115 "isRoot": True or False, # Whether or not the parent is the root folder.
116 "parentLink": "A String", # A link to the parent.
117 }</pre>
118</div>
119
120<div class="method">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700121 <code class="details" id="insert">insert(fileId, body, supportsTeamDrives=None, supportsAllDrives=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400122 <pre>Adds a parent folder for a file.
123
124Args:
125 fileId: string, The ID of the file. (required)
126 body: object, The request body. (required)
127 The object takes the form of:
128
129{ # A reference to a file's parent.
130 "selfLink": "A String", # A link back to this reference.
131 "kind": "drive#parentReference", # This is always drive#parentReference.
132 "id": "A String", # The ID of the parent.
133 "isRoot": True or False, # Whether or not the parent is the root folder.
134 "parentLink": "A String", # A link to the parent.
135}
136
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700137 supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead.
138 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 -0400139
140Returns:
141 An object of the form:
142
143 { # A reference to a file's parent.
144 "selfLink": "A String", # A link back to this reference.
145 "kind": "drive#parentReference", # This is always drive#parentReference.
146 "id": "A String", # The ID of the parent.
147 "isRoot": True or False, # Whether or not the parent is the root folder.
148 "parentLink": "A String", # A link to the parent.
149 }</pre>
150</div>
151
152<div class="method">
153 <code class="details" id="list">list(fileId)</code>
154 <pre>Lists a file's parents.
155
156Args:
157 fileId: string, The ID of the file. (required)
158
159Returns:
160 An object of the form:
161
162 { # A list of a file's parents.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400163 "items": [ # The list of parents.
John Asmuth614db982014-04-24 15:46:26 -0400164 { # A reference to a file's parent.
165 "selfLink": "A String", # A link back to this reference.
166 "kind": "drive#parentReference", # This is always drive#parentReference.
167 "id": "A String", # The ID of the parent.
168 "isRoot": True or False, # Whether or not the parent is the root folder.
169 "parentLink": "A String", # A link to the parent.
170 },
171 ],
172 "kind": "drive#parentList", # This is always drive#parentList.
173 "etag": "A String", # The ETag of the list.
174 "selfLink": "A String", # A link back to this list.
175 }</pre>
176</div>
177
178</body></html>