| 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"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 78 | <code><a href="#delete">delete(fileId, parentId, enforceSingleParent=None)</a></code></p> |
| John Asmuth | 614db98 | 2014-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"> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 84 | <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] | 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'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 91 | <code class="details" id="delete">delete(fileId, parentId, enforceSingleParent=None)</code> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 92 | <pre>Removes a parent from a file. |
| 93 | |
| 94 | Args: |
| 95 | fileId: string, The ID of the file. (required) |
| 96 | parentId: string, The ID of the parent. (required) |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -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 Asmuth | 614db98 | 2014-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 | |
| 105 | Args: |
| 106 | fileId: string, The ID of the file. (required) |
| 107 | parentId: string, The ID of the parent. (required) |
| 108 | |
| 109 | Returns: |
| 110 | An object of the form: |
| 111 | |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 112 | { # A reference to a file's parent. |
| 113 | "id": "A String", # The ID of the parent. |
| 114 | "isRoot": True or False, # Whether or not the parent is the root folder. |
| 115 | "kind": "drive#parentReference", # This is always drive#parentReference. |
| 116 | "parentLink": "A String", # A link to the parent. |
| 117 | "selfLink": "A String", # A link back to this reference. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 118 | }</pre> |
| 119 | </div> |
| 120 | |
| 121 | <div class="method"> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 122 | <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] | 123 | <pre>Adds a parent folder for a file. |
| 124 | |
| 125 | Args: |
| 126 | fileId: string, The ID of the file. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 127 | body: object, The request body. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 128 | The object takes the form of: |
| 129 | |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 130 | { # A reference to a file's parent. |
| 131 | "id": "A String", # The ID of the parent. |
| 132 | "isRoot": True or False, # Whether or not the parent is the root folder. |
| 133 | "kind": "drive#parentReference", # This is always drive#parentReference. |
| 134 | "parentLink": "A String", # A link to the parent. |
| 135 | "selfLink": "A String", # A link back to this reference. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 136 | } |
| 137 | |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -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 Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 139 | 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. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 140 | supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 141 | |
| 142 | Returns: |
| 143 | An object of the form: |
| 144 | |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 145 | { # A reference to a file's parent. |
| 146 | "id": "A String", # The ID of the parent. |
| 147 | "isRoot": True or False, # Whether or not the parent is the root folder. |
| 148 | "kind": "drive#parentReference", # This is always drive#parentReference. |
| 149 | "parentLink": "A String", # A link to the parent. |
| 150 | "selfLink": "A String", # A link back to this reference. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 151 | }</pre> |
| 152 | </div> |
| 153 | |
| 154 | <div class="method"> |
| 155 | <code class="details" id="list">list(fileId)</code> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 156 | <pre>Lists a file's parents. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 157 | |
| 158 | Args: |
| 159 | fileId: string, The ID of the file. (required) |
| 160 | |
| 161 | Returns: |
| 162 | An object of the form: |
| 163 | |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 164 | { # A list of a file's parents. |
| 165 | "etag": "A String", # The ETag of the list. |
| 166 | "items": [ # The list of parents. |
| 167 | { # A reference to a file's parent. |
| 168 | "id": "A String", # The ID of the parent. |
| 169 | "isRoot": True or False, # Whether or not the parent is the root folder. |
| 170 | "kind": "drive#parentReference", # This is always drive#parentReference. |
| 171 | "parentLink": "A String", # A link to the parent. |
| 172 | "selfLink": "A String", # A link back to this reference. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 173 | }, |
| 174 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 175 | "kind": "drive#parentList", # This is always drive#parentList. |
| 176 | "selfLink": "A String", # A link back to this list. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 177 | }</pre> |
| 178 | </div> |
| 179 | |
| 180 | </body></html> |