patch method
- CourseWorkMaterial request,
- String courseId,
- String id, {
- String? updateMask,
- String? $fields,
Updates one or more fields of a course work material.
This method returns the following error codes: * PERMISSION_DENIED
if
the requesting developer project for access errors. * INVALID_ARGUMENT
if the request is malformed. * FAILED_PRECONDITION
if the requested
course work material has already been deleted. * NOT_FOUND
if the
requested course or course work material does not exist
request
- The metadata request object.
Request parameters:
courseId
- Identifier of the course. This identifier can be either the
Classroom-assigned identifier or an alias.
id
- Identifier of the course work material.
updateMask
- Mask that identifies which fields on the course work
material to update. This field is required to do an update. The update
fails if invalid fields are specified. If a field supports empty values,
it can be cleared by specifying it in the update mask and not in the
course work material object. If a field that does not support empty values
is included in the update mask and not set in the course work material
object, an INVALID_ARGUMENT
error is returned. The following fields may
be specified by teachers: * title
* description
* state
*
scheduled_time
* topic_id
$fields
- Selector specifying which fields to include in a partial
response.
Completes with a CourseWorkMaterial.
Completes with a commons.ApiRequestError if the API endpoint returned an error.
If the used http.Client
completes with an error when making a REST call,
this method will complete with the same error.
Implementation
async.Future<CourseWorkMaterial> patch(
CourseWorkMaterial request,
core.String courseId,
core.String id, {
core.String? updateMask,
core.String? $fields,
}) async {
final body_ = convert.json.encode(request);
final queryParams_ = <core.String, core.List<core.String>>{
if (updateMask != null) 'updateMask': [updateMask],
if ($fields != null) 'fields': [$fields],
};
final url_ = 'v1/courses/' +
commons.escapeVariable('$courseId') +
'/courseWorkMaterials/' +
commons.escapeVariable('$id');
final response_ = await _requester.request(
url_,
'PATCH',
body: body_,
queryParams: queryParams_,
);
return CourseWorkMaterial.fromJson(
response_ as core.Map<core.String, core.dynamic>);
}