John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1 | <html><body> |
| 2 | <style> |
| 3 | |
| 4 | body, 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 | |
| 15 | body { |
| 16 | font-size: 13px; |
| 17 | padding: 1em; |
| 18 | } |
| 19 | |
| 20 | h1 { |
| 21 | font-size: 26px; |
| 22 | margin-bottom: 1em; |
| 23 | } |
| 24 | |
| 25 | h2 { |
| 26 | font-size: 24px; |
| 27 | margin-bottom: 1em; |
| 28 | } |
| 29 | |
| 30 | h3 { |
| 31 | font-size: 20px; |
| 32 | margin-bottom: 1em; |
| 33 | margin-top: 1em; |
| 34 | } |
| 35 | |
| 36 | pre, code { |
| 37 | line-height: 1.5; |
| 38 | font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 | } |
| 40 | |
| 41 | pre { |
| 42 | margin-top: 0.5em; |
| 43 | } |
| 44 | |
| 45 | h1, h2, h3, p { |
| 46 | font-family: Arial, sans serif; |
| 47 | } |
| 48 | |
| 49 | h1, 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"> |
Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 78 | <code><a href="#close">close()</a></code></p> |
| 79 | <p class="firstline">Close httplib2 connections.</p> |
| 80 | <p class="toc_element"> |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 81 | <code><a href="#delete">delete(fileId, parentId, enforceSingleParent=None)</a></code></p> |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 82 | <p class="firstline">Removes a parent from a file.</p> |
| 83 | <p class="toc_element"> |
| 84 | <code><a href="#get">get(fileId, parentId)</a></code></p> |
| 85 | <p class="firstline">Gets a specific parent reference.</p> |
| 86 | <p class="toc_element"> |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 87 | <code><a href="#insert">insert(fileId, body=None, enforceSingleParent=None, supportsAllDrives=None, supportsTeamDrives=None)</a></code></p> |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 88 | <p class="firstline">Adds a parent folder for a file.</p> |
| 89 | <p class="toc_element"> |
| 90 | <code><a href="#list">list(fileId)</a></code></p> |
| 91 | <p class="firstline">Lists a file's parents.</p> |
| 92 | <h3>Method Details</h3> |
| 93 | <div class="method"> |
Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 94 | <code class="details" id="close">close()</code> |
| 95 | <pre>Close httplib2 connections.</pre> |
| 96 | </div> |
| 97 | |
| 98 | <div class="method"> |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 99 | <code class="details" id="delete">delete(fileId, parentId, enforceSingleParent=None)</code> |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 100 | <pre>Removes a parent from a file. |
| 101 | |
| 102 | Args: |
| 103 | fileId: string, The ID of the file. (required) |
| 104 | parentId: string, The ID of the parent. (required) |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 105 | enforceSingleParent: boolean, Deprecated. If an item is not in a shared drive and its last parent is deleted but the item itself is not, the item will be placed under its owner's root. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 106 | </pre> |
| 107 | </div> |
| 108 | |
| 109 | <div class="method"> |
| 110 | <code class="details" id="get">get(fileId, parentId)</code> |
| 111 | <pre>Gets a specific parent reference. |
| 112 | |
| 113 | Args: |
| 114 | fileId: string, The ID of the file. (required) |
| 115 | parentId: string, The ID of the parent. (required) |
| 116 | |
| 117 | Returns: |
| 118 | An object of the form: |
| 119 | |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 120 | { # A reference to a file's parent. |
Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 121 | "id": "A String", # The ID of the parent. |
| 122 | "isRoot": True or False, # Whether or not the parent is the root folder. |
| 123 | "kind": "drive#parentReference", # This is always drive#parentReference. |
| 124 | "parentLink": "A String", # A link to the parent. |
| 125 | "selfLink": "A String", # A link back to this reference. |
| 126 | }</pre> |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 127 | </div> |
| 128 | |
| 129 | <div class="method"> |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 130 | <code class="details" id="insert">insert(fileId, body=None, enforceSingleParent=None, supportsAllDrives=None, supportsTeamDrives=None)</code> |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 131 | <pre>Adds a parent folder for a file. |
| 132 | |
| 133 | Args: |
| 134 | fileId: string, The ID of the file. (required) |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 135 | body: object, The request body. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 136 | The object takes the form of: |
| 137 | |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 138 | { # A reference to a file's parent. |
| 139 | "id": "A String", # The ID of the parent. |
| 140 | "isRoot": True or False, # Whether or not the parent is the root folder. |
| 141 | "kind": "drive#parentReference", # This is always drive#parentReference. |
| 142 | "parentLink": "A String", # A link to the parent. |
| 143 | "selfLink": "A String", # A link back to this reference. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 144 | } |
| 145 | |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 146 | enforceSingleParent: boolean, Deprecated. Adding files to multiple folders is no longer supported. Use shortcuts instead. |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 147 | supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 148 | supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 149 | |
| 150 | Returns: |
| 151 | An object of the form: |
| 152 | |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 153 | { # A reference to a file's parent. |
Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 154 | "id": "A String", # The ID of the parent. |
| 155 | "isRoot": True or False, # Whether or not the parent is the root folder. |
| 156 | "kind": "drive#parentReference", # This is always drive#parentReference. |
| 157 | "parentLink": "A String", # A link to the parent. |
| 158 | "selfLink": "A String", # A link back to this reference. |
| 159 | }</pre> |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 160 | </div> |
| 161 | |
| 162 | <div class="method"> |
| 163 | <code class="details" id="list">list(fileId)</code> |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 164 | <pre>Lists a file's parents. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 165 | |
| 166 | Args: |
| 167 | fileId: string, The ID of the file. (required) |
| 168 | |
| 169 | Returns: |
| 170 | An object of the form: |
| 171 | |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 172 | { # A list of a file's parents. |
Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 173 | "etag": "A String", # The ETag of the list. |
| 174 | "items": [ # The list of parents. |
| 175 | { # A reference to a file's parent. |
| 176 | "id": "A String", # The ID of the parent. |
| 177 | "isRoot": True or False, # Whether or not the parent is the root folder. |
| 178 | "kind": "drive#parentReference", # This is always drive#parentReference. |
| 179 | "parentLink": "A String", # A link to the parent. |
| 180 | "selfLink": "A String", # A link back to this reference. |
| 181 | }, |
| 182 | ], |
| 183 | "kind": "drive#parentList", # This is always drive#parentList. |
| 184 | "selfLink": "A String", # A link back to this list. |
| 185 | }</pre> |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 186 | </div> |
| 187 | |
| 188 | </body></html> |