Blame - docs/dyn/drive_v2.children.html - platform/external/python/google-api-python-client

blob: acc0229a04d337bfced56350273f5a63e71e0e8c [file] [log] [blame]

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.children.html">children</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(folderId, childId, enforceSingleParent=None)</a></code></p>
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	79	<p class="firstline">Removes a child from a folder.</p>
				80	<p class="toc_element">
				81	<code><a href="#get">get(folderId, childId)</a></code></p>
				82	<p class="firstline">Gets a specific child 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(folderId, 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">Inserts a file into a folder.</p>
				86	<p class="toc_element">
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	87	<code><a href="#list">list(folderId, maxResults=None, orderBy=None, pageToken=None, q=None)</a></code></p>
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	88	<p class="firstline">Lists a folder's children.</p>
				89	<p class="toc_element">
				90	<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
				91	<p class="firstline">Retrieves the next page of results.</p>
				92	<h3>Method Details</h3>
				93	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	94	<code class="details" id="delete">delete(folderId, childId, enforceSingleParent=None)</code>
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	95	<pre>Removes a child from a folder.
				96
				97	Args:
				98	folderId: string, The ID of the folder. (required)
				99	childId: string, The ID of the child. (required)
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	100	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]	101	</pre>
				102	</div>
				103
				104	<div class="method">
				105	<code class="details" id="get">get(folderId, childId)</code>
				106	<pre>Gets a specific child reference.
				107
				108	Args:
				109	folderId: string, The ID of the folder. (required)
				110	childId: string, The ID of the child. (required)
				111
				112	Returns:
				113	An object of the form:
				114
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	115	{ # A reference to a folder's child.
				116	"childLink": "A String", # A link to the child.
				117	"id": "A String", # The ID of the child.
				118	"kind": "drive#childReference", # This is always drive#childReference.
				119	"selfLink": "A String", # A link back to this reference.
				120	}</pre>
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	121	</div>
				122
				123	<div class="method">
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	124	<code class="details" id="insert">insert(folderId, body=None, enforceSingleParent=None, supportsAllDrives=None, supportsTeamDrives=None)</code>
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	125	<pre>Inserts a file into a folder.
				126
				127	Args:
				128	folderId: string, The ID of the folder. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	129	body: object, The request body.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	130	The object takes the form of:
				131
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	132	{ # A reference to a folder's child.
				133	"childLink": "A String", # A link to the child.
				134	"id": "A String", # The ID of the child.
				135	"kind": "drive#childReference", # This is always drive#childReference.
				136	"selfLink": "A String", # A link back to this reference.
				137	}
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	138
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	139	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]	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.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	141	supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	142
				143	Returns:
				144	An object of the form:
				145
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	146	{ # A reference to a folder's child.
				147	"childLink": "A String", # A link to the child.
				148	"id": "A String", # The ID of the child.
				149	"kind": "drive#childReference", # This is always drive#childReference.
				150	"selfLink": "A String", # A link back to this reference.
				151	}</pre>
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	152	</div>
				153
				154	<div class="method">
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	155	<code class="details" id="list">list(folderId, maxResults=None, orderBy=None, pageToken=None, q=None)</code>
				156	<pre>Lists a folder's children.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	157
				158	Args:
				159	folderId: string, The ID of the folder. (required)
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	160	maxResults: integer, Maximum number of children to return.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	161	orderBy: string, A comma-separated list of sort keys. Valid keys are 'createdDate', 'folder', 'lastViewedByMeDate', 'modifiedByMeDate', 'modifiedDate', 'quotaBytesUsed', 'recency', 'sharedWithMeDate', 'starred', and 'title'. Each key sorts ascending by default, but may be reversed with the 'desc' modifier. Example usage: ?orderBy=folder,modifiedDate desc,title. Please note that there is a current limitation for users with approximately one million files in which the requested sort order is ignored.
				162	pageToken: string, Page token for children.
				163	q: string, Query string for searching children.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	164
				165	Returns:
				166	An object of the form:
				167
				168	{ # A list of children of a file.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	169	"etag": "A String", # The ETag of the list.
				170	"items": [ # The list of children. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched.
				171	{ # A reference to a folder's child.
				172	"childLink": "A String", # A link to the child.
				173	"id": "A String", # The ID of the child.
				174	"kind": "drive#childReference", # This is always drive#childReference.
				175	"selfLink": "A String", # A link back to this reference.
				176	},
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	177	],
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	178	"kind": "drive#childList", # This is always drive#childList.
				179	"nextLink": "A String", # A link to the next page of children.
				180	"nextPageToken": "A String", # The page token for the next page of children. This will be absent if the end of the children list has been reached. If the token is rejected for any reason, it should be discarded, and pagination should be restarted from the first page of results.
				181	"selfLink": "A String", # A link back to this list.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	182	}</pre>
				183	</div>
				184
				185	<div class="method">
				186	<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
				187	<pre>Retrieves the next page of results.
				188
				189	Args:
				190	previous_request: The request for the previous page. (required)
				191	previous_response: The response from the request for the previous page. (required)
				192
				193	Returns:
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	194	A request object that you can call 'execute()' on to request the next
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	195	page. Returns None if there are no more items in the collection.
				196	</pre>
				197	</div>
				198
				199	</body></html>