Blame - docs/dyn/classroom_v1.courses.topics.html - platform/external/python/google-api-python-client

blob: 7bf206f794991364313a9419cace26981e00f234 [file] [log] [blame]

Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[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="classroom_v1.html">Google Classroom API</a> . <a href="classroom_v1.courses.html">courses</a> . <a href="classroom_v1.courses.topics.html">topics</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="#create">create(courseId, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	79	<p class="firstline">Creates a topic.</p>
				80	<p class="toc_element">
				81	<code><a href="#delete">delete(courseId, id, x__xgafv=None)</a></code></p>
				82	<p class="firstline">Deletes a topic.</p>
				83	<p class="toc_element">
				84	<code><a href="#get">get(courseId, id, x__xgafv=None)</a></code></p>
				85	<p class="firstline">Returns a topic.</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(courseId, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	88	<p class="firstline">Returns the list of topics that the requester is permitted to view.</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	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	93	<code><a href="#patch">patch(courseId, id, body=None, updateMask=None, x__xgafv=None)</a></code></p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	94	<p class="firstline">Updates one or more fields of a topic.</p>
				95	<h3>Method Details</h3>
				96	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	97	<code class="details" id="create">create(courseId, body=None, x__xgafv=None)</code>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	98	<pre>Creates a topic.
				99
				100	This method returns the following error codes:
				101
				102	* `PERMISSION_DENIED` if the requesting user is not permitted to access the
				103	requested course, create a topic in the requested course,
				104	or for access errors.
				105	* `INVALID_ARGUMENT` if the request is malformed.
				106	* `NOT_FOUND` if the requested course does not exist.
				107
				108	Args:
				109	courseId: string, Identifier of the course.
				110	This identifier can be either the Classroom-assigned identifier or an
				111	alias. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	112	body: object, The request body.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	113	The object takes the form of:
				114
				115	{ # Topic created by a teacher for the course
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	116	"updateTime": "A String", # The time the topic was last updated by the system.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	117	#
				118	# Read-only.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	119	"name": "A String", # The name of the topic, generated by the user.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	120	# Leading and trailing whitespaces, if any, are trimmed. Also, multiple
				121	# consecutive whitespaces are collapsed into one inside the name. The
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	122	# result must be a non-empty string. Topic names are case sensitive, and must
				123	# be no longer than 100 characters.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	124	"topicId": "A String", # Unique identifier for the topic.
				125	#
				126	# Read-only.
				127	"courseId": "A String", # Identifier of the course.
				128	#
				129	# Read-only.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	130	}
				131
				132	x__xgafv: string, V1 error format.
				133	Allowed values
				134	1 - v1 error format
				135	2 - v2 error format
				136
				137	Returns:
				138	An object of the form:
				139
				140	{ # Topic created by a teacher for the course
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	141	"updateTime": "A String", # The time the topic was last updated by the system.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	142	#
				143	# Read-only.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	144	"name": "A String", # The name of the topic, generated by the user.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	145	# Leading and trailing whitespaces, if any, are trimmed. Also, multiple
				146	# consecutive whitespaces are collapsed into one inside the name. The
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	147	# result must be a non-empty string. Topic names are case sensitive, and must
				148	# be no longer than 100 characters.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	149	"topicId": "A String", # Unique identifier for the topic.
				150	#
				151	# Read-only.
				152	"courseId": "A String", # Identifier of the course.
				153	#
				154	# Read-only.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	155	}</pre>
				156	</div>
				157
				158	<div class="method">
				159	<code class="details" id="delete">delete(courseId, id, x__xgafv=None)</code>
				160	<pre>Deletes a topic.
				161
				162	This method returns the following error codes:
				163
				164	* `PERMISSION_DENIED` if the requesting user is not allowed to delete the
				165	requested topic or for access errors.
				166	* `FAILED_PRECONDITION` if the requested topic has already been
				167	deleted.
				168	* `NOT_FOUND` if no course or topic exists with the requested ID.
				169
				170	Args:
				171	courseId: string, Identifier of the course.
				172	This identifier can be either the Classroom-assigned identifier or an
				173	alias. (required)
				174	id: string, Identifier of the topic to delete. (required)
				175	x__xgafv: string, V1 error format.
				176	Allowed values
				177	1 - v1 error format
				178	2 - v2 error format
				179
				180	Returns:
				181	An object of the form:
				182
				183	{ # A generic empty message that you can re-use to avoid defining duplicated
				184	# empty messages in your APIs. A typical example is to use it as the request
				185	# or the response type of an API method. For instance:
				186	#
				187	# service Foo {
				188	# rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
				189	# }
				190	#
				191	# The JSON representation for `Empty` is empty JSON object `{}`.
				192	}</pre>
				193	</div>
				194
				195	<div class="method">
				196	<code class="details" id="get">get(courseId, id, x__xgafv=None)</code>
				197	<pre>Returns a topic.
				198
				199	This method returns the following error codes:
				200
				201	* `PERMISSION_DENIED` if the requesting user is not permitted to access the
				202	requested course or topic, or for access errors.
				203	* `INVALID_ARGUMENT` if the request is malformed.
				204	* `NOT_FOUND` if the requested course or topic does not exist.
				205
				206	Args:
				207	courseId: string, Identifier of the course. (required)
				208	id: string, Identifier of the topic. (required)
				209	x__xgafv: string, V1 error format.
				210	Allowed values
				211	1 - v1 error format
				212	2 - v2 error format
				213
				214	Returns:
				215	An object of the form:
				216
				217	{ # Topic created by a teacher for the course
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	218	"updateTime": "A String", # The time the topic was last updated by the system.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	219	#
				220	# Read-only.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	221	"name": "A String", # The name of the topic, generated by the user.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	222	# Leading and trailing whitespaces, if any, are trimmed. Also, multiple
				223	# consecutive whitespaces are collapsed into one inside the name. The
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	224	# result must be a non-empty string. Topic names are case sensitive, and must
				225	# be no longer than 100 characters.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	226	"topicId": "A String", # Unique identifier for the topic.
				227	#
				228	# Read-only.
				229	"courseId": "A String", # Identifier of the course.
				230	#
				231	# Read-only.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	232	}</pre>
				233	</div>
				234
				235	<div class="method">
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	236	<code class="details" id="list">list(courseId, pageToken=None, pageSize=None, x__xgafv=None)</code>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	237	<pre>Returns the list of topics that the requester is permitted to view.
				238
				239	This method returns the following error codes:
				240
				241	* `PERMISSION_DENIED` if the requesting user is not permitted to access
				242	the requested course or for access errors.
				243	* `INVALID_ARGUMENT` if the request is malformed.
				244	* `NOT_FOUND` if the requested course does not exist.
				245
				246	Args:
				247	courseId: string, Identifier of the course.
				248	This identifier can be either the Classroom-assigned identifier or an
				249	alias. (required)
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	250	pageToken: string, nextPageToken
				251	value returned from a previous
				252	list call,
				253	indicating that the subsequent page of results should be returned.
				254
				255	The list request
				256	must be otherwise identical to the one that resulted in this token.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	257	pageSize: integer, Maximum number of items to return. Zero or unspecified indicates that the
				258	server may assign a maximum.
				259
				260	The server may return fewer than the specified number of results.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	261	x__xgafv: string, V1 error format.
				262	Allowed values
				263	1 - v1 error format
				264	2 - v2 error format
				265
				266	Returns:
				267	An object of the form:
				268
				269	{ # Response when listing topics.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	270	"topic": [ # Topic items that match the request.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	271	{ # Topic created by a teacher for the course
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	272	"updateTime": "A String", # The time the topic was last updated by the system.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	273	#
				274	# Read-only.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	275	"name": "A String", # The name of the topic, generated by the user.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	276	# Leading and trailing whitespaces, if any, are trimmed. Also, multiple
				277	# consecutive whitespaces are collapsed into one inside the name. The
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	278	# result must be a non-empty string. Topic names are case sensitive, and must
				279	# be no longer than 100 characters.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	280	"topicId": "A String", # Unique identifier for the topic.
				281	#
				282	# Read-only.
				283	"courseId": "A String", # Identifier of the course.
				284	#
				285	# Read-only.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	286	},
				287	],
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	288	"nextPageToken": "A String", # Token identifying the next page of results to return. If empty, no further
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	289	# results are available.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	290	}</pre>
				291	</div>
				292
				293	<div class="method">
				294	<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
				295	<pre>Retrieves the next page of results.
				296
				297	Args:
				298	previous_request: The request for the previous page. (required)
				299	previous_response: The response from the request for the previous page. (required)
				300
				301	Returns:
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	302	A request object that you can call 'execute()' on to request the next
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	303	page. Returns None if there are no more items in the collection.
				304	</pre>
				305	</div>
				306
				307	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	308	<code class="details" id="patch">patch(courseId, id, body=None, updateMask=None, x__xgafv=None)</code>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	309	<pre>Updates one or more fields of a topic.
				310
				311	This method returns the following error codes:
				312
				313	* `PERMISSION_DENIED` if the requesting developer project did not create
				314	the corresponding topic or for access errors.
				315	* `INVALID_ARGUMENT` if the request is malformed.
				316	* `NOT_FOUND` if the requested course or topic does not exist
				317
				318	Args:
				319	courseId: string, Identifier of the course.
				320	This identifier can be either the Classroom-assigned identifier or an
				321	alias. (required)
				322	id: string, Identifier of the topic. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	323	body: object, The request body.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	324	The object takes the form of:
				325
				326	{ # Topic created by a teacher for the course
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	327	"updateTime": "A String", # The time the topic was last updated by the system.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	328	#
				329	# Read-only.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	330	"name": "A String", # The name of the topic, generated by the user.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	331	# Leading and trailing whitespaces, if any, are trimmed. Also, multiple
				332	# consecutive whitespaces are collapsed into one inside the name. The
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	333	# result must be a non-empty string. Topic names are case sensitive, and must
				334	# be no longer than 100 characters.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	335	"topicId": "A String", # Unique identifier for the topic.
				336	#
				337	# Read-only.
				338	"courseId": "A String", # Identifier of the course.
				339	#
				340	# Read-only.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	341	}
				342
				343	updateMask: string, Mask that identifies which fields on the topic to update.
				344	This field is required to do an update. The update fails if invalid
				345	fields are specified. If a field supports empty values, it can be cleared
				346	by specifying it in the update mask and not in the Topic object. If a
				347	field that does not support empty values is included in the update mask and
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	348	not set in the Topic object, an `INVALID_ARGUMENT` error is
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	349	returned.
				350
				351	The following fields may be specified:
				352
				353	* `name`
				354	x__xgafv: string, V1 error format.
				355	Allowed values
				356	1 - v1 error format
				357	2 - v2 error format
				358
				359	Returns:
				360	An object of the form:
				361
				362	{ # Topic created by a teacher for the course
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	363	"updateTime": "A String", # The time the topic was last updated by the system.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	364	#
				365	# Read-only.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	366	"name": "A String", # The name of the topic, generated by the user.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	367	# Leading and trailing whitespaces, if any, are trimmed. Also, multiple
				368	# consecutive whitespaces are collapsed into one inside the name. The
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	369	# result must be a non-empty string. Topic names are case sensitive, and must
				370	# be no longer than 100 characters.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	371	"topicId": "A String", # Unique identifier for the topic.
				372	#
				373	# Read-only.
				374	"courseId": "A String", # Identifier of the course.
				375	#
				376	# Read-only.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	377	}</pre>
				378	</div>
				379
				380	</body></html>