| Index: generated/googleapis/lib/classroom/v1.dart
|
| diff --git a/generated/googleapis/lib/classroom/v1.dart b/generated/googleapis/lib/classroom/v1.dart
|
| index 4e975a78e5a855da00114a93bb69360b1beb17c3..d3991750d0d4a8072bd760474db81957ceffb852 100644
|
| --- a/generated/googleapis/lib/classroom/v1.dart
|
| +++ b/generated/googleapis/lib/classroom/v1.dart
|
| @@ -16,12 +16,6 @@ const core.String USER_AGENT = 'dart-api-client classroom/v1';
|
|
|
| /** Manages classes, rosters, and invitations in Google Classroom. */
|
| class ClassroomApi {
|
| - /**
|
| - * View instructions for teacher-assigned work in your Google Classroom
|
| - * classes
|
| - */
|
| - static const ClassroomCourseWorkReadonlyScope = "https://www.googleapis.com/auth/classroom.course-work.readonly";
|
| -
|
| /** Manage your Google Classroom classes */
|
| static const ClassroomCoursesScope = "https://www.googleapis.com/auth/classroom.courses";
|
|
|
| @@ -91,14 +85,21 @@ class CoursesResourceApi {
|
| _requester = client;
|
|
|
| /**
|
| - * Creates a course. The user specified in `ownerId` is the owner of the
|
| - * created course and added as a teacher. This method returns the following
|
| - * error codes: * `PERMISSION_DENIED` if the requesting user is not permitted
|
| - * to create courses or for access errors. * `NOT_FOUND` if the primary
|
| - * teacher is not a valid user. * `FAILED_PRECONDITION` if the course owner's
|
| - * account is disabled or for the following request errors: *
|
| - * UserGroupsMembershipLimitReached * `ALREADY_EXISTS` if an alias was
|
| - * specified in the `id` and already exists.
|
| + * Creates a course.
|
| + *
|
| + * The user specified in `ownerId` is the owner of the created course
|
| + * and added as a teacher.
|
| + *
|
| + * This method returns the following error codes:
|
| + *
|
| + * * `PERMISSION_DENIED` if the requesting user is not permitted to create
|
| + * courses or for access errors.
|
| + * * `NOT_FOUND` if the primary teacher is not a valid user.
|
| + * * `FAILED_PRECONDITION` if the course owner's account is disabled or for
|
| + * the following request errors:
|
| + * * UserGroupsMembershipLimitReached
|
| + * * `ALREADY_EXISTS` if an alias was specified in the `id` and
|
| + * already exists.
|
| *
|
| * [request] - The metadata request object.
|
| *
|
| @@ -137,15 +138,19 @@ class CoursesResourceApi {
|
| }
|
|
|
| /**
|
| - * Deletes a course. This method returns the following error codes: *
|
| - * `PERMISSION_DENIED` if the requesting user is not permitted to delete the
|
| - * requested course or for access errors. * `NOT_FOUND` if no course exists
|
| - * with the requested ID.
|
| + * Deletes a course.
|
| + *
|
| + * This method returns the following error codes:
|
| + *
|
| + * * `PERMISSION_DENIED` if the requesting user is not permitted to delete the
|
| + * requested course or for access errors.
|
| + * * `NOT_FOUND` if no course exists with the requested ID.
|
| *
|
| * Request parameters:
|
| *
|
| - * [id] - Identifier of the course to delete. This identifier can be either
|
| - * the Classroom-assigned identifier or an alias.
|
| + * [id] - Identifier of the course to delete.
|
| + * This identifier can be either the Classroom-assigned identifier or an
|
| + * alias.
|
| *
|
| * Completes with a [Empty].
|
| *
|
| @@ -180,15 +185,19 @@ class CoursesResourceApi {
|
| }
|
|
|
| /**
|
| - * Returns a course. This method returns the following error codes: *
|
| - * `PERMISSION_DENIED` if the requesting user is not permitted to access the
|
| - * requested course or for access errors. * `NOT_FOUND` if no course exists
|
| - * with the requested ID.
|
| + * Returns a course.
|
| + *
|
| + * This method returns the following error codes:
|
| + *
|
| + * * `PERMISSION_DENIED` if the requesting user is not permitted to access the
|
| + * requested course or for access errors.
|
| + * * `NOT_FOUND` if no course exists with the requested ID.
|
| *
|
| * Request parameters:
|
| *
|
| - * [id] - Identifier of the course to return. This identifier can be either
|
| - * the Classroom-assigned identifier or an alias.
|
| + * [id] - Identifier of the course to return.
|
| + * This identifier can be either the Classroom-assigned identifier or an
|
| + * alias.
|
| *
|
| * Completes with a [Course].
|
| *
|
| @@ -224,33 +233,49 @@ class CoursesResourceApi {
|
|
|
| /**
|
| * Returns a list of courses that the requesting user is permitted to view,
|
| - * restricted to those that match the request. This method returns the
|
| - * following error codes: * `PERMISSION_DENIED` for access errors. *
|
| - * `INVALID_ARGUMENT` if the query argument is malformed. * `NOT_FOUND` if any
|
| - * users specified in the query arguments do not exist.
|
| + * restricted to those that match the request.
|
| *
|
| - * Request parameters:
|
| + * This method returns the following error codes:
|
| *
|
| - * [studentId] - Restricts returned courses to those having a student with the
|
| - * specified identifier. The identifier can be one of the following: * the
|
| - * numeric identifier for the user * the email address of the user * the
|
| - * string literal `"me"`, indicating the requesting user
|
| + * * `PERMISSION_DENIED` for access errors.
|
| + * * `INVALID_ARGUMENT` if the query argument is malformed.
|
| + * * `NOT_FOUND` if any users specified in the query arguments do not exist.
|
| *
|
| - * [teacherId] - Restricts returned courses to those having a teacher with the
|
| - * specified identifier. The identifier can be one of the following: * the
|
| - * numeric identifier for the user * the email address of the user * the
|
| - * string literal `"me"`, indicating the requesting user
|
| + * Request parameters:
|
| *
|
| * [courseStates] - Restricts returned courses to those in one of the
|
| * specified states
|
| + * The default value is ACTIVE, ARCHIVED, PROVISIONED, DECLINED.
|
| *
|
| * [pageSize] - Maximum number of items to return. Zero or unspecified
|
| - * indicates that the server may assign a maximum. The server may return fewer
|
| - * than the specified number of results.
|
| + * indicates that the
|
| + * server may assign a maximum.
|
| *
|
| - * [pageToken] - nextPageToken value returned from a previous list call,
|
| - * indicating that the subsequent page of results should be returned. The list
|
| - * request must be otherwise identical to the one that resulted in this token.
|
| + * The server may return fewer than the specified number of results.
|
| + *
|
| + * [teacherId] - Restricts returned courses to those having a teacher with the
|
| + * specified
|
| + * identifier. The identifier can be one of the following:
|
| + *
|
| + * * the numeric identifier for the user
|
| + * * the email address of the user
|
| + * * the string literal `"me"`, indicating the requesting user
|
| + *
|
| + * [studentId] - Restricts returned courses to those having a student with the
|
| + * specified
|
| + * identifier. The identifier can be one of the following:
|
| + *
|
| + * * the numeric identifier for the user
|
| + * * the email address of the user
|
| + * * the string literal `"me"`, indicating the requesting user
|
| + *
|
| + * [pageToken] - nextPageToken
|
| + * value returned from a previous
|
| + * list call,
|
| + * indicating that the subsequent page of results should be returned.
|
| + *
|
| + * The list request must be
|
| + * otherwise identical to the one that resulted in this token.
|
| *
|
| * Completes with a [ListCoursesResponse].
|
| *
|
| @@ -260,7 +285,7 @@ class CoursesResourceApi {
|
| * If the used [http.Client] completes with an error when making a REST call,
|
| * this method will complete with the same error.
|
| */
|
| - async.Future<ListCoursesResponse> list({core.String studentId, core.String teacherId, core.List<core.String> courseStates, core.int pageSize, core.String pageToken}) {
|
| + async.Future<ListCoursesResponse> list({core.List<core.String> courseStates, core.int pageSize, core.String teacherId, core.String studentId, core.String pageToken}) {
|
| var _url = null;
|
| var _queryParams = new core.Map();
|
| var _uploadMedia = null;
|
| @@ -268,18 +293,18 @@ class CoursesResourceApi {
|
| var _downloadOptions = commons.DownloadOptions.Metadata;
|
| var _body = null;
|
|
|
| - if (studentId != null) {
|
| - _queryParams["studentId"] = [studentId];
|
| - }
|
| - if (teacherId != null) {
|
| - _queryParams["teacherId"] = [teacherId];
|
| - }
|
| if (courseStates != null) {
|
| _queryParams["courseStates"] = courseStates;
|
| }
|
| if (pageSize != null) {
|
| _queryParams["pageSize"] = ["${pageSize}"];
|
| }
|
| + if (teacherId != null) {
|
| + _queryParams["teacherId"] = [teacherId];
|
| + }
|
| + if (studentId != null) {
|
| + _queryParams["studentId"] = [studentId];
|
| + }
|
| if (pageToken != null) {
|
| _queryParams["pageToken"] = [pageToken];
|
| }
|
| @@ -297,26 +322,40 @@ class CoursesResourceApi {
|
| }
|
|
|
| /**
|
| - * Updates one or more fields in a course. This method returns the following
|
| - * error codes: * `PERMISSION_DENIED` if the requesting user is not permitted
|
| - * to modify the requested course or for access errors. * `NOT_FOUND` if no
|
| - * course exists with the requested ID. * `INVALID_ARGUMENT` if invalid fields
|
| - * are specified in the update mask or if no update mask is supplied. *
|
| - * `FAILED_PRECONDITION` for the following request errors: *
|
| - * CourseNotModifiable
|
| + * Updates one or more fields in a course.
|
| + *
|
| + * This method returns the following error codes:
|
| + *
|
| + * * `PERMISSION_DENIED` if the requesting user is not permitted to modify the
|
| + * requested course or for access errors.
|
| + * * `NOT_FOUND` if no course exists with the requested ID.
|
| + * * `INVALID_ARGUMENT` if invalid fields are specified in the update mask or
|
| + * if no update mask is supplied.
|
| + * * `FAILED_PRECONDITION` for the following request errors:
|
| + * * CourseNotModifiable
|
| *
|
| * [request] - The metadata request object.
|
| *
|
| * Request parameters:
|
| *
|
| - * [id] - Identifier of the course to update. This identifier can be either
|
| - * the Classroom-assigned identifier or an alias.
|
| + * [id] - Identifier of the course to update.
|
| + * This identifier can be either the Classroom-assigned identifier or an
|
| + * alias.
|
| *
|
| * [updateMask] - Mask that identifies which fields on the course to update.
|
| * This field is required to do an update. The update will fail if invalid
|
| - * fields are specified. The following fields are valid: * `name` * `section`
|
| - * * `descriptionHeading` * `description` * `room` * `courseState` When set in
|
| - * a query parameter, this field should be specified as `updateMask=,,...`
|
| + * fields are specified. The following fields are valid:
|
| + *
|
| + * * `name`
|
| + * * `section`
|
| + * * `descriptionHeading`
|
| + * * `description`
|
| + * * `room`
|
| + * * `courseState`
|
| + *
|
| + * When set in a query parameter, this field should be specified as
|
| + *
|
| + * `updateMask=<field1>,<field2>,...`
|
| *
|
| * Completes with a [Course].
|
| *
|
| @@ -357,18 +396,23 @@ class CoursesResourceApi {
|
| }
|
|
|
| /**
|
| - * Updates a course. This method returns the following error codes: *
|
| - * `PERMISSION_DENIED` if the requesting user is not permitted to modify the
|
| - * requested course or for access errors. * `NOT_FOUND` if no course exists
|
| - * with the requested ID. * `FAILED_PRECONDITION` for the following request
|
| - * errors: * CourseNotModifiable
|
| + * Updates a course.
|
| + *
|
| + * This method returns the following error codes:
|
| + *
|
| + * * `PERMISSION_DENIED` if the requesting user is not permitted to modify the
|
| + * requested course or for access errors.
|
| + * * `NOT_FOUND` if no course exists with the requested ID.
|
| + * * `FAILED_PRECONDITION` for the following request errors:
|
| + * * CourseNotModifiable
|
| *
|
| * [request] - The metadata request object.
|
| *
|
| * Request parameters:
|
| *
|
| - * [id] - Identifier of the course to update. This identifier can be either
|
| - * the Classroom-assigned identifier or an alias.
|
| + * [id] - Identifier of the course to update.
|
| + * This identifier can be either the Classroom-assigned identifier or an
|
| + * alias.
|
| *
|
| * Completes with a [Course].
|
| *
|
| @@ -415,17 +459,25 @@ class CoursesAliasesResourceApi {
|
| _requester = client;
|
|
|
| /**
|
| - * Creates an alias for a course. This method returns the following error
|
| - * codes: * `PERMISSION_DENIED` if the requesting user is not permitted to
|
| - * create the alias or for access errors. * `NOT_FOUND` if the course does not
|
| - * exist. * `ALREADY_EXISTS` if the alias already exists.
|
| + * Creates an alias for a course.
|
| + *
|
| + * This method returns the following error codes:
|
| + *
|
| + * * `PERMISSION_DENIED` if the requesting user is not permitted to create the
|
| + * alias or for access errors.
|
| + * * `NOT_FOUND` if the course does not exist.
|
| + * * `ALREADY_EXISTS` if the alias already exists.
|
| + * * `FAILED_PRECONDITION` if the alias requested does not make sense for the
|
| + * requesting user or course (for example, if a user not in a domain
|
| + * attempts to access a domain-scoped alias).
|
| *
|
| * [request] - The metadata request object.
|
| *
|
| * Request parameters:
|
| *
|
| - * [courseId] - Identifier of the course to alias. This identifier can be
|
| - * either the Classroom-assigned identifier or an alias.
|
| + * [courseId] - Identifier of the course to alias.
|
| + * This identifier can be either the Classroom-assigned identifier or an
|
| + * alias.
|
| *
|
| * Completes with a [CourseAlias].
|
| *
|
| @@ -463,18 +515,25 @@ class CoursesAliasesResourceApi {
|
| }
|
|
|
| /**
|
| - * Deletes an alias of a course. This method returns the following error
|
| - * codes: * `PERMISSION_DENIED` if the requesting user is not permitted to
|
| - * remove the alias or for access errors. * `NOT_FOUND` if the alias does not
|
| - * exist.
|
| + * Deletes an alias of a course.
|
| + *
|
| + * This method returns the following error codes:
|
| + *
|
| + * * `PERMISSION_DENIED` if the requesting user is not permitted to remove the
|
| + * alias or for access errors.
|
| + * * `NOT_FOUND` if the alias does not exist.
|
| + * * `FAILED_PRECONDITION` if the alias requested does not make sense for the
|
| + * requesting user or course (for example, if a user not in a domain
|
| + * attempts to delete a domain-scoped alias).
|
| *
|
| * Request parameters:
|
| *
|
| - * [courseId] - Identifier of the course whose alias should be deleted. This
|
| - * identifier can be either the Classroom-assigned identifier or an alias.
|
| + * [courseId] - Identifier of the course whose alias should be deleted.
|
| + * This identifier can be either the Classroom-assigned identifier or an
|
| + * alias.
|
| *
|
| - * [alias] - Alias to delete. This may not be the Classroom-assigned
|
| - * identifier.
|
| + * [alias] - Alias to delete.
|
| + * This may not be the Classroom-assigned identifier.
|
| *
|
| * Completes with a [Empty].
|
| *
|
| @@ -512,23 +571,33 @@ class CoursesAliasesResourceApi {
|
| }
|
|
|
| /**
|
| - * Returns a list of aliases for a course. This method returns the following
|
| - * error codes: * `PERMISSION_DENIED` if the requesting user is not permitted
|
| - * to access the course or for access errors. * `NOT_FOUND` if the course does
|
| - * not exist.
|
| + * Returns a list of aliases for a course.
|
| + *
|
| + * This method returns the following error codes:
|
| + *
|
| + * * `PERMISSION_DENIED` if the requesting user is not permitted to access the
|
| + * course or for access errors.
|
| + * * `NOT_FOUND` if the course does not exist.
|
| *
|
| * Request parameters:
|
| *
|
| - * [courseId] - The identifier of the course. This identifier can be either
|
| - * the Classroom-assigned identifier or an alias.
|
| + * [courseId] - The identifier of the course.
|
| + * This identifier can be either the Classroom-assigned identifier or an
|
| + * alias.
|
| *
|
| * [pageSize] - Maximum number of items to return. Zero or unspecified
|
| - * indicates that the server may assign a maximum. The server may return fewer
|
| - * than the specified number of results.
|
| + * indicates that the
|
| + * server may assign a maximum.
|
| + *
|
| + * The server may return fewer than the specified number of results.
|
| *
|
| - * [pageToken] - nextPageToken value returned from a previous list call,
|
| - * indicating that the subsequent page of results should be returned. The list
|
| - * request must be otherwise identical to the one that resulted in this token.
|
| + * [pageToken] - nextPageToken
|
| + * value returned from a previous
|
| + * list call,
|
| + * indicating that the subsequent page of results should be returned.
|
| + *
|
| + * The list request
|
| + * must be otherwise identical to the one that resulted in this token.
|
| *
|
| * Completes with a [ListCourseAliasesResponse].
|
| *
|
| @@ -580,25 +649,32 @@ class CoursesCourseWorkResourceApi {
|
| _requester = client;
|
|
|
| /**
|
| - * Creates course work. The resulting course work (and corresponding student
|
| - * submissions) are associated with the Developer Console project of the
|
| + * Creates course work.
|
| + *
|
| + * The resulting course work (and corresponding student submissions) are
|
| + * associated with the Developer Console project of the
|
| * [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to
|
| * make the request. Classroom API requests to modify course work and student
|
| * submissions must be made with an OAuth client ID from the associated
|
| - * Developer Console project. This method returns the following error codes: *
|
| - * `PERMISSION_DENIED` if the requesting user is not permitted to access the
|
| - * requested course, create course work in the requested course, share a Drive
|
| - * attachment, or for access errors. * `INVALID_ARGUMENT` if the request is
|
| - * malformed. * `NOT_FOUND` if the requested course does not exist. *
|
| - * `FAILED_PRECONDITION` for the following request error: *
|
| - * AttachmentNotVisible
|
| + * Developer Console project.
|
| + *
|
| + * This method returns the following error codes:
|
| + *
|
| + * * `PERMISSION_DENIED` if the requesting user is not permitted to access the
|
| + * requested course, create course work in the requested course, share a
|
| + * Drive attachment, or for access errors.
|
| + * * `INVALID_ARGUMENT` if the request is malformed.
|
| + * * `NOT_FOUND` if the requested course does not exist.
|
| + * * `FAILED_PRECONDITION` for the following request error:
|
| + * * AttachmentNotVisible
|
| *
|
| * [request] - The metadata request object.
|
| *
|
| * Request parameters:
|
| *
|
| - * [courseId] - Identifier of the course. This identifier can be either the
|
| - * Classroom-assigned identifier or an alias.
|
| + * [courseId] - Identifier of the course.
|
| + * This identifier can be either the Classroom-assigned identifier or an
|
| + * alias.
|
| *
|
| * Completes with a [CourseWork].
|
| *
|
| @@ -636,23 +712,29 @@ class CoursesCourseWorkResourceApi {
|
| }
|
|
|
| /**
|
| - * Deletes a course work. This request must be made by the Developer Console
|
| - * project of the [OAuth client
|
| - * ID](https://support.google.com/cloud/answer/6158849) used to create the
|
| - * corresponding course work item. This method returns the following error
|
| - * codes: * `PERMISSION_DENIED` if the requesting developer project did not
|
| - * create the corresponding course work, if the requesting user is not
|
| - * permitted to delete the requested course or for access errors. *
|
| - * `FAILED_PRECONDITION` if the requested course work has already been
|
| - * deleted. * `NOT_FOUND` if no course exists with the requested ID.
|
| + * Deletes a course work.
|
| + *
|
| + * This request must be made by the Developer Console project of the
|
| + * [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to
|
| + * create the corresponding course work item.
|
| + *
|
| + * This method returns the following error codes:
|
| + *
|
| + * * `PERMISSION_DENIED` if the requesting developer project did not create
|
| + * the corresponding course work, if the requesting user is not permitted
|
| + * to delete the requested course or for access errors.
|
| + * * `FAILED_PRECONDITION` if the requested course work has already been
|
| + * deleted.
|
| + * * `NOT_FOUND` if no course exists with the requested ID.
|
| *
|
| * Request parameters:
|
| *
|
| - * [courseId] - Identifier of the course. This identifier can be either the
|
| - * Classroom-assigned identifier or an alias.
|
| + * [courseId] - Identifier of the course.
|
| + * This identifier can be either the Classroom-assigned identifier or an
|
| + * alias.
|
| *
|
| - * [id] - Identifier of the course work to delete. This identifier is a
|
| - * Classroom-assigned identifier.
|
| + * [id] - Identifier of the course work to delete.
|
| + * This identifier is a Classroom-assigned identifier.
|
| *
|
| * Completes with a [Empty].
|
| *
|
| @@ -690,16 +772,20 @@ class CoursesCourseWorkResourceApi {
|
| }
|
|
|
| /**
|
| - * Returns course work. This method returns the following error codes: *
|
| - * `PERMISSION_DENIED` if the requesting user is not permitted to access the
|
| - * requested course or course work, or for access errors. * `INVALID_ARGUMENT`
|
| - * if the request is malformed. * `NOT_FOUND` if the requested course or
|
| - * course work does not exist.
|
| + * Returns course work.
|
| + *
|
| + * This method returns the following error codes:
|
| + *
|
| + * * `PERMISSION_DENIED` if the requesting user is not permitted to access the
|
| + * requested course or course work, or for access errors.
|
| + * * `INVALID_ARGUMENT` if the request is malformed.
|
| + * * `NOT_FOUND` if the requested course or course work does not exist.
|
| *
|
| * Request parameters:
|
| *
|
| - * [courseId] - Identifier of the course. This identifier can be either the
|
| - * Classroom-assigned identifier or an alias.
|
| + * [courseId] - Identifier of the course.
|
| + * This identifier can be either the Classroom-assigned identifier or an
|
| + * alias.
|
| *
|
| * [id] - Identifier of the course work.
|
| *
|
| @@ -740,35 +826,48 @@ class CoursesCourseWorkResourceApi {
|
|
|
| /**
|
| * Returns a list of course work that the requester is permitted to view.
|
| - * Course students may only view `PUBLISHED` course work. Course teachers and
|
| - * domain administrators may view all course work. This method returns the
|
| - * following error codes: * `PERMISSION_DENIED` if the requesting user is not
|
| - * permitted to access the requested course or for access errors. *
|
| - * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the
|
| - * requested course does not exist.
|
| + *
|
| + * Course students may only view `PUBLISHED` course work. Course teachers
|
| + * and domain administrators may view all course work.
|
| + *
|
| + * This method returns the following error codes:
|
| + *
|
| + * * `PERMISSION_DENIED` if the requesting user is not permitted to access
|
| + * the requested course or for access errors.
|
| + * * `INVALID_ARGUMENT` if the request is malformed.
|
| + * * `NOT_FOUND` if the requested course does not exist.
|
| *
|
| * Request parameters:
|
| *
|
| - * [courseId] - Identifier of the course. This identifier can be either the
|
| - * Classroom-assigned identifier or an alias.
|
| + * [courseId] - Identifier of the course.
|
| + * This identifier can be either the Classroom-assigned identifier or an
|
| + * alias.
|
| *
|
| * [courseWorkStates] - Restriction on the work status to return. Only
|
| - * courseWork that matches is returned. If unspecified, items with a work
|
| - * status of `PUBLISHED` is returned.
|
| + * courseWork that matches
|
| + * is returned. If unspecified, items with a work status of `PUBLISHED`
|
| + * is returned.
|
| + *
|
| + * [pageSize] - Maximum number of items to return. Zero or unspecified
|
| + * indicates that the
|
| + * server may assign a maximum.
|
| + *
|
| + * The server may return fewer than the specified number of results.
|
| *
|
| * [orderBy] - Optional sort ordering for results. A comma-separated list of
|
| - * fields with an optional sort direction keyword. Supported fields are
|
| - * `updateTime` and `dueDate`. Supported direction keywords are `asc` and
|
| - * `desc`. If not specified, `updateTime desc` is the default behavior.
|
| + * fields with
|
| + * an optional sort direction keyword. Supported fields are `updateTime`
|
| + * and `dueDate`. Supported direction keywords are `asc` and `desc`.
|
| + * If not specified, `updateTime desc` is the default behavior.
|
| * Examples: `dueDate asc,updateTime desc`, `updateTime,dueDate desc`
|
| *
|
| - * [pageSize] - Maximum number of items to return. Zero or unspecified
|
| - * indicates that the server may assign a maximum. The server may return fewer
|
| - * than the specified number of results.
|
| + * [pageToken] - nextPageToken
|
| + * value returned from a previous
|
| + * list call,
|
| + * indicating that the subsequent page of results should be returned.
|
| *
|
| - * [pageToken] - nextPageToken value returned from a previous list call,
|
| - * indicating that the subsequent page of results should be returned. The list
|
| - * request must be otherwise identical to the one that resulted in this token.
|
| + * The list request
|
| + * must be otherwise identical to the one that resulted in this token.
|
| *
|
| * Completes with a [ListCourseWorkResponse].
|
| *
|
| @@ -778,7 +877,7 @@ class CoursesCourseWorkResourceApi {
|
| * If the used [http.Client] completes with an error when making a REST call,
|
| * this method will complete with the same error.
|
| */
|
| - async.Future<ListCourseWorkResponse> list(core.String courseId, {core.List<core.String> courseWorkStates, core.String orderBy, core.int pageSize, core.String pageToken}) {
|
| + async.Future<ListCourseWorkResponse> list(core.String courseId, {core.List<core.String> courseWorkStates, core.int pageSize, core.String orderBy, core.String pageToken}) {
|
| var _url = null;
|
| var _queryParams = new core.Map();
|
| var _uploadMedia = null;
|
| @@ -792,12 +891,12 @@ class CoursesCourseWorkResourceApi {
|
| if (courseWorkStates != null) {
|
| _queryParams["courseWorkStates"] = courseWorkStates;
|
| }
|
| - if (orderBy != null) {
|
| - _queryParams["orderBy"] = [orderBy];
|
| - }
|
| if (pageSize != null) {
|
| _queryParams["pageSize"] = ["${pageSize}"];
|
| }
|
| + if (orderBy != null) {
|
| + _queryParams["orderBy"] = [orderBy];
|
| + }
|
| if (pageToken != null) {
|
| _queryParams["pageToken"] = [pageToken];
|
| }
|
| @@ -815,37 +914,54 @@ class CoursesCourseWorkResourceApi {
|
| }
|
|
|
| /**
|
| - * Updates one or more fields of a course work. See
|
| - * google.classroom.v1.CourseWork for details of which fields may be updated
|
| - * and who may change them. This request must be made by the Developer Console
|
| - * project of the [OAuth client
|
| - * ID](https://support.google.com/cloud/answer/6158849) used to create the
|
| - * corresponding course work item. This method returns the following error
|
| - * codes: * `PERMISSION_DENIED` if the requesting developer project did not
|
| - * create the corresponding course work, if the user is not permitted to make
|
| - * the requested modification to the student submission, or for access errors.
|
| - * * `INVALID_ARGUMENT` if the request is malformed. * `FAILED_PRECONDITION`
|
| - * if the requested course work has already been deleted. * `NOT_FOUND` if the
|
| - * requested course, course work, or student submission does not exist.
|
| + * Updates one or more fields of a course work.
|
| + *
|
| + * See google.classroom.v1.CourseWork for details
|
| + * of which fields may be updated and who may change them.
|
| + *
|
| + * This request must be made by the Developer Console project of the
|
| + * [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to
|
| + * create the corresponding course work item.
|
| + *
|
| + * This method returns the following error codes:
|
| + *
|
| + * * `PERMISSION_DENIED` if the requesting developer project did not create
|
| + * the corresponding course work, if the user is not permitted to make the
|
| + * requested modification to the student submission, or for
|
| + * access errors.
|
| + * * `INVALID_ARGUMENT` if the request is malformed.
|
| + * * `FAILED_PRECONDITION` if the requested course work has already been
|
| + * deleted.
|
| + * * `NOT_FOUND` if the requested course, course work, or student submission
|
| + * 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.
|
| + * [courseId] - Identifier of the course.
|
| + * This identifier can be either the Classroom-assigned identifier or an
|
| + * alias.
|
| *
|
| * [id] - Identifier of the course work.
|
| *
|
| * [updateMask] - Mask that identifies which fields on the course work to
|
| - * update. This field is required to do an update. The update fails if invalid
|
| + * 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 CourseWork object. If a
|
| * field that does not support empty values is included in the update mask and
|
| * not set in the CourseWork object, an `INVALID_ARGUMENT` error will be
|
| - * returned. The following fields may be specified by teachers: * `title` *
|
| - * `description` * `state` * `due_date` * `due_time` * `max_points` *
|
| - * `submission_modification_mode`
|
| + * returned.
|
| + *
|
| + * The following fields may be specified by teachers:
|
| + * * `title`
|
| + * * `description`
|
| + * * `state`
|
| + * * `due_date`
|
| + * * `due_time`
|
| + * * `max_points`
|
| + * * `submission_modification_mode`
|
| *
|
| * Completes with a [CourseWork].
|
| *
|
| @@ -898,16 +1014,20 @@ class CoursesCourseWorkStudentSubmissionsResourceApi {
|
| _requester = client;
|
|
|
| /**
|
| - * Returns a student submission. * `PERMISSION_DENIED` if the requesting user
|
| - * is not permitted to access the requested course, course work, or student
|
| - * submission or for access errors. * `INVALID_ARGUMENT` if the request is
|
| - * malformed. * `NOT_FOUND` if the requested course, course work, or student
|
| - * submission does not exist.
|
| + * Returns a student submission.
|
| + *
|
| + * * `PERMISSION_DENIED` if the requesting user is not permitted to access the
|
| + * requested course, course work, or student submission or for
|
| + * access errors.
|
| + * * `INVALID_ARGUMENT` if the request is malformed.
|
| + * * `NOT_FOUND` if the requested course, course work, or student submission
|
| + * does not exist.
|
| *
|
| * Request parameters:
|
| *
|
| - * [courseId] - Identifier of the course. This identifier can be either the
|
| - * Classroom-assigned identifier or an alias.
|
| + * [courseId] - Identifier of the course.
|
| + * This identifier can be either the Classroom-assigned identifier or an
|
| + * alias.
|
| *
|
| * [courseWorkId] - Identifier of the course work.
|
| *
|
| @@ -953,48 +1073,65 @@ class CoursesCourseWorkStudentSubmissionsResourceApi {
|
|
|
| /**
|
| * Returns a list of student submissions that the requester is permitted to
|
| - * view, factoring in the OAuth scopes of the request. `-` may be specified as
|
| - * the `course_work_id` to include student submissions for multiple course
|
| - * work items. Course students may only view their own work. Course teachers
|
| - * and domain administrators may view all student submissions. This method
|
| - * returns the following error codes: * `PERMISSION_DENIED` if the requesting
|
| - * user is not permitted to access the requested course or course work, or for
|
| - * access errors. * `INVALID_ARGUMENT` if the request is malformed. *
|
| - * `NOT_FOUND` if the requested course does not exist.
|
| + * view, factoring in the OAuth scopes of the request.
|
| + * `-` may be specified as the `course_work_id` to include student
|
| + * submissions for multiple course work items.
|
| + *
|
| + * Course students may only view their own work. Course teachers
|
| + * and domain administrators may view all student submissions.
|
| + *
|
| + * This method returns the following error codes:
|
| + *
|
| + * * `PERMISSION_DENIED` if the requesting user is not permitted to access the
|
| + * requested course or course work, or for access errors.
|
| + * * `INVALID_ARGUMENT` if the request is malformed.
|
| + * * `NOT_FOUND` if the requested course does not exist.
|
| *
|
| * Request parameters:
|
| *
|
| - * [courseId] - Identifier of the course. This identifier can be either the
|
| - * Classroom-assigned identifier or an alias.
|
| + * [courseId] - Identifier of the course.
|
| + * This identifier can be either the Classroom-assigned identifier or an
|
| + * alias.
|
| + *
|
| + * [courseWorkId] - Identifer of the student work to request.
|
| + * This may be set to the string literal `"-"` to request student work for
|
| + * all course work in the specified course.
|
| *
|
| - * [courseWorkId] - Identifer of the student work to request. This may be set
|
| - * to the string literal `"-"` to request student work for all course work in
|
| - * the specified course.
|
| + * [states] - Requested submission states. If specified, returned student
|
| + * submissions
|
| + * match one of the specified submission states.
|
| *
|
| * [userId] - Optional argument to restrict returned student work to those
|
| - * owned by the student with the specified identifier. The identifier can be
|
| - * one of the following: * the numeric identifier for the user * the email
|
| - * address of the user * the string literal `"me"`, indicating the requesting
|
| - * user
|
| + * owned by the
|
| + * student with the specified identifier. The identifier can be one of the
|
| + * following:
|
| *
|
| - * [states] - Requested submission states. If specified, returned student
|
| - * submissions match one of the specified submission states.
|
| + * * the numeric identifier for the user
|
| + * * the email address of the user
|
| + * * the string literal `"me"`, indicating the requesting user
|
| + *
|
| + * [pageSize] - Maximum number of items to return. Zero or unspecified
|
| + * indicates that the
|
| + * server may assign a maximum.
|
| + *
|
| + * The server may return fewer than the specified number of results.
|
| *
|
| * [late] - Requested lateness value. If specified, returned student
|
| - * submissions are restricted by the requested value. If unspecified,
|
| - * submissions are returned regardless of `late` value.
|
| + * submissions are
|
| + * restricted by the requested value.
|
| + * If unspecified, submissions are returned regardless of `late` value.
|
| * Possible string values are:
|
| * - "LATE_VALUES_UNSPECIFIED" : A LATE_VALUES_UNSPECIFIED.
|
| * - "LATE_ONLY" : A LATE_ONLY.
|
| * - "NOT_LATE_ONLY" : A NOT_LATE_ONLY.
|
| *
|
| - * [pageSize] - Maximum number of items to return. Zero or unspecified
|
| - * indicates that the server may assign a maximum. The server may return fewer
|
| - * than the specified number of results.
|
| + * [pageToken] - nextPageToken
|
| + * value returned from a previous
|
| + * list call,
|
| + * indicating that the subsequent page of results should be returned.
|
| *
|
| - * [pageToken] - nextPageToken value returned from a previous list call,
|
| - * indicating that the subsequent page of results should be returned. The list
|
| - * request must be otherwise identical to the one that resulted in this token.
|
| + * The list request
|
| + * must be otherwise identical to the one that resulted in this token.
|
| *
|
| * Completes with a [ListStudentSubmissionsResponse].
|
| *
|
| @@ -1004,7 +1141,7 @@ class CoursesCourseWorkStudentSubmissionsResourceApi {
|
| * If the used [http.Client] completes with an error when making a REST call,
|
| * this method will complete with the same error.
|
| */
|
| - async.Future<ListStudentSubmissionsResponse> list(core.String courseId, core.String courseWorkId, {core.String userId, core.List<core.String> states, core.String late, core.int pageSize, core.String pageToken}) {
|
| + async.Future<ListStudentSubmissionsResponse> list(core.String courseId, core.String courseWorkId, {core.List<core.String> states, core.String userId, core.int pageSize, core.String late, core.String pageToken}) {
|
| var _url = null;
|
| var _queryParams = new core.Map();
|
| var _uploadMedia = null;
|
| @@ -1018,18 +1155,18 @@ class CoursesCourseWorkStudentSubmissionsResourceApi {
|
| if (courseWorkId == null) {
|
| throw new core.ArgumentError("Parameter courseWorkId is required.");
|
| }
|
| - if (userId != null) {
|
| - _queryParams["userId"] = [userId];
|
| - }
|
| if (states != null) {
|
| _queryParams["states"] = states;
|
| }
|
| - if (late != null) {
|
| - _queryParams["late"] = [late];
|
| + if (userId != null) {
|
| + _queryParams["userId"] = [userId];
|
| }
|
| if (pageSize != null) {
|
| _queryParams["pageSize"] = ["${pageSize}"];
|
| }
|
| + if (late != null) {
|
| + _queryParams["late"] = [late];
|
| + }
|
| if (pageToken != null) {
|
| _queryParams["pageToken"] = [pageToken];
|
| }
|
| @@ -1047,24 +1184,32 @@ class CoursesCourseWorkStudentSubmissionsResourceApi {
|
| }
|
|
|
| /**
|
| - * Modifies attachments of student submission. Attachments may only be added
|
| - * to student submissions belonging to course work objects with a `workType`
|
| - * of `ASSIGNMENT`. This request must be made by the Developer Console project
|
| - * of the [OAuth client ID](https://support.google.com/cloud/answer/6158849)
|
| - * used to create the corresponding course work item. This method returns the
|
| - * following error codes: * `PERMISSION_DENIED` if the requesting user is not
|
| - * permitted to access the requested course or course work, if the user is not
|
| - * permitted to modify attachments on the requested student submission, or for
|
| - * access errors. * `INVALID_ARGUMENT` if the request is malformed. *
|
| - * `NOT_FOUND` if the requested course, course work, or student submission
|
| + * Modifies attachments of student submission.
|
| + *
|
| + * Attachments may only be added to student submissions belonging to course
|
| + * work objects with a `workType` of `ASSIGNMENT`.
|
| + *
|
| + * This request must be made by the Developer Console project of the
|
| + * [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to
|
| + * create the corresponding course work item.
|
| + *
|
| + * This method returns the following error codes:
|
| + *
|
| + * * `PERMISSION_DENIED` if the requesting user is not permitted to access the
|
| + * requested course or course work, if the user is not permitted to modify
|
| + * attachments on the requested student submission, or for
|
| + * access errors.
|
| + * * `INVALID_ARGUMENT` if the request is malformed.
|
| + * * `NOT_FOUND` if the requested course, course work, or student submission
|
| * 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.
|
| + * [courseId] - Identifier of the course.
|
| + * This identifier can be either the Classroom-assigned identifier or an
|
| + * alias.
|
| *
|
| * [courseWorkId] - Identifier of the course work.
|
| *
|
| @@ -1112,33 +1257,45 @@ class CoursesCourseWorkStudentSubmissionsResourceApi {
|
| }
|
|
|
| /**
|
| - * Updates one or more fields of a student submission. See
|
| - * google.classroom.v1.StudentSubmission for details of which fields may be
|
| - * updated and who may change them. This request must be made by the Developer
|
| - * Console project of the [OAuth client
|
| - * ID](https://support.google.com/cloud/answer/6158849) used to create the
|
| - * corresponding course work item. This method returns the following error
|
| - * codes: * `PERMISSION_DENIED` if the requesting developer project did not
|
| - * create the corresponding course work, if the user is not permitted to make
|
| - * the requested modification to the student submission, or for access errors.
|
| - * * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the
|
| - * requested course, course work, or student submission does not exist.
|
| + * Updates one or more fields of a student submission.
|
| + *
|
| + * See google.classroom.v1.StudentSubmission for details
|
| + * of which fields may be updated and who may change them.
|
| + *
|
| + * This request must be made by the Developer Console project of the
|
| + * [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to
|
| + * create the corresponding course work item.
|
| + *
|
| + * This method returns the following error codes:
|
| + *
|
| + * * `PERMISSION_DENIED` if the requesting developer project did not create
|
| + * the corresponding course work, if the user is not permitted to make the
|
| + * requested modification to the student submission, or for
|
| + * access errors.
|
| + * * `INVALID_ARGUMENT` if the request is malformed.
|
| + * * `NOT_FOUND` if the requested course, course work, or student submission
|
| + * 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.
|
| + * [courseId] - Identifier of the course.
|
| + * This identifier can be either the Classroom-assigned identifier or an
|
| + * alias.
|
| *
|
| * [courseWorkId] - Identifier of the course work.
|
| *
|
| * [id] - Identifier of the student submission.
|
| *
|
| * [updateMask] - Mask that identifies which fields on the student submission
|
| - * to update. This field is required to do an update. The update fails if
|
| - * invalid fields are specified. The following fields may be specified by
|
| - * teachers: * `draft_grade` * `assigned_grade`
|
| + * to update.
|
| + * This field is required to do an update. The update fails if invalid
|
| + * fields are specified.
|
| + *
|
| + * The following fields may be specified by teachers:
|
| + * * `draft_grade`
|
| + * * `assigned_grade`
|
| *
|
| * Completes with a [StudentSubmission].
|
| *
|
| @@ -1186,26 +1343,34 @@ class CoursesCourseWorkStudentSubmissionsResourceApi {
|
|
|
| /**
|
| * Reclaims a student submission on behalf of the student that owns it.
|
| - * Reclaiming a student submission transfers ownership of attached Drive files
|
| - * to the student and update the submission state. Only the student that owns
|
| - * the requested student submission may call this method, and only for a
|
| - * student submission that has been turned in. This request must be made by
|
| - * the Developer Console project of the [OAuth client
|
| - * ID](https://support.google.com/cloud/answer/6158849) used to create the
|
| - * corresponding course work item. This method returns the following error
|
| - * codes: * `PERMISSION_DENIED` if the requesting user is not permitted to
|
| - * access the requested course or course work, unsubmit the requested student
|
| - * submission, or for access errors. * `FAILED_PRECONDITION` if the student
|
| - * submission has not been turned in. * `INVALID_ARGUMENT` if the request is
|
| - * malformed. * `NOT_FOUND` if the requested course, course work, or student
|
| - * submission does not exist.
|
| + *
|
| + * Reclaiming a student submission transfers ownership of attached Drive
|
| + * files to the student and update the submission state.
|
| + *
|
| + * Only the student that owns the requested student submission may call this
|
| + * method, and only for a student submission that has been turned in.
|
| + *
|
| + * This request must be made by the Developer Console project of the
|
| + * [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to
|
| + * create the corresponding course work item.
|
| + *
|
| + * This method returns the following error codes:
|
| + *
|
| + * * `PERMISSION_DENIED` if the requesting user is not permitted to access the
|
| + * requested course or course work, unsubmit the requested student submission,
|
| + * or for access errors.
|
| + * * `FAILED_PRECONDITION` if the student submission has not been turned in.
|
| + * * `INVALID_ARGUMENT` if the request is malformed.
|
| + * * `NOT_FOUND` if the requested course, course work, or student submission
|
| + * 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.
|
| + * [courseId] - Identifier of the course.
|
| + * This identifier can be either the Classroom-assigned identifier or an
|
| + * alias.
|
| *
|
| * [courseWorkId] - Identifier of the course work.
|
| *
|
| @@ -1253,27 +1418,36 @@ class CoursesCourseWorkStudentSubmissionsResourceApi {
|
| }
|
|
|
| /**
|
| - * Returns a student submission. Returning a student submission transfers
|
| - * ownership of attached Drive files to the student and may also update the
|
| - * submission state. Unlike the Classroom application, returning a student
|
| - * submission does not set assignedGrade to the draftGrade value. Only a
|
| - * teacher of the course that contains the requested student submission may
|
| - * call this method. This request must be made by the Developer Console
|
| - * project of the [OAuth client
|
| - * ID](https://support.google.com/cloud/answer/6158849) used to create the
|
| - * corresponding course work item. This method returns the following error
|
| - * codes: * `PERMISSION_DENIED` if the requesting user is not permitted to
|
| - * access the requested course or course work, return the requested student
|
| - * submission, or for access errors. * `INVALID_ARGUMENT` if the request is
|
| - * malformed. * `NOT_FOUND` if the requested course, course work, or student
|
| - * submission does not exist.
|
| + * Returns a student submission.
|
| + *
|
| + * Returning a student submission transfers ownership of attached Drive
|
| + * files to the student and may also update the submission state.
|
| + * Unlike the Classroom application, returning a student submission does not
|
| + * set assignedGrade to the draftGrade value.
|
| + *
|
| + * Only a teacher of the course that contains the requested student submission
|
| + * may call this method.
|
| + *
|
| + * This request must be made by the Developer Console project of the
|
| + * [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to
|
| + * create the corresponding course work item.
|
| + *
|
| + * This method returns the following error codes:
|
| + *
|
| + * * `PERMISSION_DENIED` if the requesting user is not permitted to access the
|
| + * requested course or course work, return the requested student submission,
|
| + * or for access errors.
|
| + * * `INVALID_ARGUMENT` if the request is malformed.
|
| + * * `NOT_FOUND` if the requested course, course work, or student submission
|
| + * 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.
|
| + * [courseId] - Identifier of the course.
|
| + * This identifier can be either the Classroom-assigned identifier or an
|
| + * alias.
|
| *
|
| * [courseWorkId] - Identifier of the course work.
|
| *
|
| @@ -1321,25 +1495,34 @@ class CoursesCourseWorkStudentSubmissionsResourceApi {
|
| }
|
|
|
| /**
|
| - * Turns in a student submission. Turning in a student submission transfers
|
| - * ownership of attached Drive files to the teacher and may also update the
|
| - * submission state. This may only be called by the student that owns the
|
| - * specified student submission. This request must be made by the Developer
|
| - * Console project of the [OAuth client
|
| - * ID](https://support.google.com/cloud/answer/6158849) used to create the
|
| - * corresponding course work item. This method returns the following error
|
| - * codes: * `PERMISSION_DENIED` if the requesting user is not permitted to
|
| - * access the requested course or course work, turn in the requested student
|
| - * submission, or for access errors. * `INVALID_ARGUMENT` if the request is
|
| - * malformed. * `NOT_FOUND` if the requested course, course work, or student
|
| - * submission does not exist.
|
| + * Turns in a student submission.
|
| + *
|
| + * Turning in a student submission transfers ownership of attached Drive
|
| + * files to the teacher and may also update the submission state.
|
| + *
|
| + * This may only be called by the student that owns the specified student
|
| + * submission.
|
| + *
|
| + * This request must be made by the Developer Console project of the
|
| + * [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to
|
| + * create the corresponding course work item.
|
| + *
|
| + * This method returns the following error codes:
|
| + *
|
| + * * `PERMISSION_DENIED` if the requesting user is not permitted to access the
|
| + * requested course or course work, turn in the requested student submission,
|
| + * or for access errors.
|
| + * * `INVALID_ARGUMENT` if the request is malformed.
|
| + * * `NOT_FOUND` if the requested course, course work, or student submission
|
| + * 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.
|
| + * [courseId] - Identifier of the course.
|
| + * This identifier can be either the Classroom-assigned identifier or an
|
| + * alias.
|
| *
|
| * [courseWorkId] - Identifier of the course work.
|
| *
|
| @@ -1396,26 +1579,33 @@ class CoursesStudentsResourceApi {
|
| _requester = client;
|
|
|
| /**
|
| - * Adds a user as a student of a course. This method returns the following
|
| - * error codes: * `PERMISSION_DENIED` if the requesting user is not permitted
|
| - * to create students in this course or for access errors. * `NOT_FOUND` if
|
| - * the requested course ID does not exist. * `FAILED_PRECONDITION` if the
|
| - * requested user's account is disabled, for the following request errors: *
|
| - * CourseMemberLimitReached * CourseNotModifiable *
|
| - * UserGroupsMembershipLimitReached * `ALREADY_EXISTS` if the user is already
|
| - * a student or teacher in the course.
|
| + * Adds a user as a student of a course.
|
| + *
|
| + * This method returns the following error codes:
|
| + *
|
| + * * `PERMISSION_DENIED` if the requesting user is not permitted to create
|
| + * students in this course or for access errors.
|
| + * * `NOT_FOUND` if the requested course ID does not exist.
|
| + * * `FAILED_PRECONDITION` if the requested user's account is disabled,
|
| + * for the following request errors:
|
| + * * CourseMemberLimitReached
|
| + * * CourseNotModifiable
|
| + * * UserGroupsMembershipLimitReached
|
| + * * `ALREADY_EXISTS` if the user is already a student or teacher in the
|
| + * course.
|
| *
|
| * [request] - The metadata request object.
|
| *
|
| * Request parameters:
|
| *
|
| - * [courseId] - Identifier of the course to create the student in. This
|
| - * identifier can be either the Classroom-assigned identifier or an alias.
|
| + * [courseId] - Identifier of the course to create the student in.
|
| + * This identifier can be either the Classroom-assigned identifier or an
|
| + * alias.
|
| *
|
| * [enrollmentCode] - Enrollment code of the course to create the student in.
|
| - * This code is required if userId corresponds to the requesting user; it may
|
| - * be omitted if the requesting user has administrative permissions to create
|
| - * students for any user.
|
| + * This code is required if userId
|
| + * corresponds to the requesting user; it may be omitted if the requesting
|
| + * user has administrative permissions to create students for any user.
|
| *
|
| * Completes with a [Student].
|
| *
|
| @@ -1456,20 +1646,28 @@ class CoursesStudentsResourceApi {
|
| }
|
|
|
| /**
|
| - * Deletes a student of a course. This method returns the following error
|
| - * codes: * `PERMISSION_DENIED` if the requesting user is not permitted to
|
| - * delete students of this course or for access errors. * `NOT_FOUND` if no
|
| - * student of this course has the requested ID or if the course does not
|
| - * exist.
|
| + * Deletes a student of a course.
|
| + *
|
| + * This method returns the following error codes:
|
| + *
|
| + * * `PERMISSION_DENIED` if the requesting user is not permitted to delete
|
| + * students of this course or for access errors.
|
| + * * `NOT_FOUND` if no student of this course has the requested ID or if the
|
| + * course does not exist.
|
| *
|
| * Request parameters:
|
| *
|
| - * [courseId] - Identifier of the course. This identifier can be either the
|
| - * Classroom-assigned identifier or an alias.
|
| + * [courseId] - Identifier of the course.
|
| + * This identifier can be either the Classroom-assigned identifier or an
|
| + * alias.
|
| *
|
| * [userId] - Identifier of the student to delete. The identifier can be one
|
| - * of the following: * the numeric identifier for the user * the email address
|
| - * of the user * the string literal `"me"`, indicating the requesting user
|
| + * of the
|
| + * following:
|
| + *
|
| + * * the numeric identifier for the user
|
| + * * the email address of the user
|
| + * * the string literal `"me"`, indicating the requesting user
|
| *
|
| * Completes with a [Empty].
|
| *
|
| @@ -1507,20 +1705,28 @@ class CoursesStudentsResourceApi {
|
| }
|
|
|
| /**
|
| - * Returns a student of a course. This method returns the following error
|
| - * codes: * `PERMISSION_DENIED` if the requesting user is not permitted to
|
| - * view students of this course or for access errors. * `NOT_FOUND` if no
|
| - * student of this course has the requested ID or if the course does not
|
| - * exist.
|
| + * Returns a student of a course.
|
| + *
|
| + * This method returns the following error codes:
|
| + *
|
| + * * `PERMISSION_DENIED` if the requesting user is not permitted to view
|
| + * students of this course or for access errors.
|
| + * * `NOT_FOUND` if no student of this course has the requested ID or if the
|
| + * course does not exist.
|
| *
|
| * Request parameters:
|
| *
|
| - * [courseId] - Identifier of the course. This identifier can be either the
|
| - * Classroom-assigned identifier or an alias.
|
| + * [courseId] - Identifier of the course.
|
| + * This identifier can be either the Classroom-assigned identifier or an
|
| + * alias.
|
| *
|
| * [userId] - Identifier of the student to return. The identifier can be one
|
| - * of the following: * the numeric identifier for the user * the email address
|
| - * of the user * the string literal `"me"`, indicating the requesting user
|
| + * of the
|
| + * following:
|
| + *
|
| + * * the numeric identifier for the user
|
| + * * the email address of the user
|
| + * * the string literal `"me"`, indicating the requesting user
|
| *
|
| * Completes with a [Student].
|
| *
|
| @@ -1558,21 +1764,31 @@ class CoursesStudentsResourceApi {
|
| }
|
|
|
| /**
|
| - * Returns a list of students of this course that the requester is permitted
|
| - * to view. This method returns the following error codes: * `NOT_FOUND` if
|
| - * the course does not exist. * `PERMISSION_DENIED` for access errors.
|
| + * Returns a list of students of this course that the requester
|
| + * is permitted to view.
|
| + *
|
| + * This method returns the following error codes:
|
| + *
|
| + * * `NOT_FOUND` if the course does not exist.
|
| + * * `PERMISSION_DENIED` for access errors.
|
| *
|
| * Request parameters:
|
| *
|
| - * [courseId] - Identifier of the course. This identifier can be either the
|
| - * Classroom-assigned identifier or an alias.
|
| + * [courseId] - Identifier of the course.
|
| + * This identifier can be either the Classroom-assigned identifier or an
|
| + * alias.
|
| + *
|
| + * [pageSize] - Maximum number of items to return. Zero means no maximum.
|
| *
|
| - * [pageSize] - Maximum number of items to return. Zero means no maximum. The
|
| - * server may return fewer than the specified number of results.
|
| + * The server may return fewer than the specified number of results.
|
| *
|
| - * [pageToken] - nextPageToken value returned from a previous list call,
|
| - * indicating that the subsequent page of results should be returned. The list
|
| - * request must be otherwise identical to the one that resulted in this token.
|
| + * [pageToken] - nextPageToken
|
| + * value returned from a previous
|
| + * list call, indicating that
|
| + * the subsequent page of results should be returned.
|
| + *
|
| + * The list request must be
|
| + * otherwise identical to the one that resulted in this token.
|
| *
|
| * Completes with a [ListStudentsResponse].
|
| *
|
| @@ -1622,21 +1838,29 @@ class CoursesTeachersResourceApi {
|
| _requester = client;
|
|
|
| /**
|
| - * Creates a teacher of a course. This method returns the following error
|
| - * codes: * `PERMISSION_DENIED` if the requesting user is not permitted to
|
| - * create teachers in this course or for access errors. * `NOT_FOUND` if the
|
| - * requested course ID does not exist. * `FAILED_PRECONDITION` if the
|
| - * requested user's account is disabled, for the following request errors: *
|
| - * CourseMemberLimitReached * CourseNotModifiable * CourseTeacherLimitReached
|
| - * * UserGroupsMembershipLimitReached * `ALREADY_EXISTS` if the user is
|
| - * already a teacher or student in the course.
|
| + * Creates a teacher of a course.
|
| + *
|
| + * This method returns the following error codes:
|
| + *
|
| + * * `PERMISSION_DENIED` if the requesting user is not permitted to create
|
| + * teachers in this course or for access errors.
|
| + * * `NOT_FOUND` if the requested course ID does not exist.
|
| + * * `FAILED_PRECONDITION` if the requested user's account is disabled,
|
| + * for the following request errors:
|
| + * * CourseMemberLimitReached
|
| + * * CourseNotModifiable
|
| + * * CourseTeacherLimitReached
|
| + * * UserGroupsMembershipLimitReached
|
| + * * `ALREADY_EXISTS` if the user is already a teacher or student in the
|
| + * course.
|
| *
|
| * [request] - The metadata request object.
|
| *
|
| * Request parameters:
|
| *
|
| - * [courseId] - Identifier of the course. This identifier can be either the
|
| - * Classroom-assigned identifier or an alias.
|
| + * [courseId] - Identifier of the course.
|
| + * This identifier can be either the Classroom-assigned identifier or an
|
| + * alias.
|
| *
|
| * Completes with a [Teacher].
|
| *
|
| @@ -1674,21 +1898,30 @@ class CoursesTeachersResourceApi {
|
| }
|
|
|
| /**
|
| - * Deletes a teacher of a course. This method returns the following error
|
| - * codes: * `PERMISSION_DENIED` if the requesting user is not permitted to
|
| - * delete teachers of this course or for access errors. * `NOT_FOUND` if no
|
| - * teacher of this course has the requested ID or if the course does not
|
| - * exist. * `FAILED_PRECONDITION` if the requested ID belongs to the primary
|
| - * teacher of this course.
|
| + * Deletes a teacher of a course.
|
| + *
|
| + * This method returns the following error codes:
|
| + *
|
| + * * `PERMISSION_DENIED` if the requesting user is not permitted to delete
|
| + * teachers of this course or for access errors.
|
| + * * `NOT_FOUND` if no teacher of this course has the requested ID or if the
|
| + * course does not exist.
|
| + * * `FAILED_PRECONDITION` if the requested ID belongs to the primary teacher
|
| + * of this course.
|
| *
|
| * Request parameters:
|
| *
|
| - * [courseId] - Identifier of the course. This identifier can be either the
|
| - * Classroom-assigned identifier or an alias.
|
| + * [courseId] - Identifier of the course.
|
| + * This identifier can be either the Classroom-assigned identifier or an
|
| + * alias.
|
| *
|
| * [userId] - Identifier of the teacher to delete. The identifier can be one
|
| - * of the following: * the numeric identifier for the user * the email address
|
| - * of the user * the string literal `"me"`, indicating the requesting user
|
| + * of the
|
| + * following:
|
| + *
|
| + * * the numeric identifier for the user
|
| + * * the email address of the user
|
| + * * the string literal `"me"`, indicating the requesting user
|
| *
|
| * Completes with a [Empty].
|
| *
|
| @@ -1726,20 +1959,28 @@ class CoursesTeachersResourceApi {
|
| }
|
|
|
| /**
|
| - * Returns a teacher of a course. This method returns the following error
|
| - * codes: * `PERMISSION_DENIED` if the requesting user is not permitted to
|
| - * view teachers of this course or for access errors. * `NOT_FOUND` if no
|
| - * teacher of this course has the requested ID or if the course does not
|
| - * exist.
|
| + * Returns a teacher of a course.
|
| + *
|
| + * This method returns the following error codes:
|
| + *
|
| + * * `PERMISSION_DENIED` if the requesting user is not permitted to view
|
| + * teachers of this course or for access errors.
|
| + * * `NOT_FOUND` if no teacher of this course has the requested ID or if the
|
| + * course does not exist.
|
| *
|
| * Request parameters:
|
| *
|
| - * [courseId] - Identifier of the course. This identifier can be either the
|
| - * Classroom-assigned identifier or an alias.
|
| + * [courseId] - Identifier of the course.
|
| + * This identifier can be either the Classroom-assigned identifier or an
|
| + * alias.
|
| *
|
| * [userId] - Identifier of the teacher to return. The identifier can be one
|
| - * of the following: * the numeric identifier for the user * the email address
|
| - * of the user * the string literal `"me"`, indicating the requesting user
|
| + * of the
|
| + * following:
|
| + *
|
| + * * the numeric identifier for the user
|
| + * * the email address of the user
|
| + * * the string literal `"me"`, indicating the requesting user
|
| *
|
| * Completes with a [Teacher].
|
| *
|
| @@ -1777,21 +2018,31 @@ class CoursesTeachersResourceApi {
|
| }
|
|
|
| /**
|
| - * Returns a list of teachers of this course that the requester is permitted
|
| - * to view. This method returns the following error codes: * `NOT_FOUND` if
|
| - * the course does not exist. * `PERMISSION_DENIED` for access errors.
|
| + * Returns a list of teachers of this course that the requester
|
| + * is permitted to view.
|
| + *
|
| + * This method returns the following error codes:
|
| + *
|
| + * * `NOT_FOUND` if the course does not exist.
|
| + * * `PERMISSION_DENIED` for access errors.
|
| *
|
| * Request parameters:
|
| *
|
| - * [courseId] - Identifier of the course. This identifier can be either the
|
| - * Classroom-assigned identifier or an alias.
|
| + * [courseId] - Identifier of the course.
|
| + * This identifier can be either the Classroom-assigned identifier or an
|
| + * alias.
|
| + *
|
| + * [pageSize] - Maximum number of items to return. Zero means no maximum.
|
| *
|
| - * [pageSize] - Maximum number of items to return. Zero means no maximum. The
|
| - * server may return fewer than the specified number of results.
|
| + * The server may return fewer than the specified number of results.
|
| *
|
| - * [pageToken] - nextPageToken value returned from a previous list call,
|
| - * indicating that the subsequent page of results should be returned. The list
|
| - * request must be otherwise identical to the one that resulted in this token.
|
| + * [pageToken] - nextPageToken
|
| + * value returned from a previous
|
| + * list call, indicating that
|
| + * the subsequent page of results should be returned.
|
| + *
|
| + * The list request must be
|
| + * otherwise identical to the one that resulted in this token.
|
| *
|
| * Completes with a [ListTeachersResponse].
|
| *
|
| @@ -1843,13 +2094,18 @@ class InvitationsResourceApi {
|
| /**
|
| * Accepts an invitation, removing it and adding the invited user to the
|
| * teachers or students (as appropriate) of the specified course. Only the
|
| - * invited user may accept an invitation. This method returns the following
|
| - * error codes: * `PERMISSION_DENIED` if the requesting user is not permitted
|
| - * to accept the requested invitation or for access errors. *
|
| - * `FAILED_PRECONDITION` for the following request errors: *
|
| - * CourseMemberLimitReached * CourseNotModifiable * CourseTeacherLimitReached
|
| - * * UserGroupsMembershipLimitReached * `NOT_FOUND` if no invitation exists
|
| - * with the requested ID.
|
| + * invited user may accept an invitation.
|
| + *
|
| + * This method returns the following error codes:
|
| + *
|
| + * * `PERMISSION_DENIED` if the requesting user is not permitted to accept the
|
| + * requested invitation or for access errors.
|
| + * * `FAILED_PRECONDITION` for the following request errors:
|
| + * * CourseMemberLimitReached
|
| + * * CourseNotModifiable
|
| + * * CourseTeacherLimitReached
|
| + * * UserGroupsMembershipLimitReached
|
| + * * `NOT_FOUND` if no invitation exists with the requested ID.
|
| *
|
| * Request parameters:
|
| *
|
| @@ -1889,14 +2145,17 @@ class InvitationsResourceApi {
|
|
|
| /**
|
| * Creates an invitation. Only one invitation for a user and course may exist
|
| - * at a time. Delete and re-create an invitation to make changes. This method
|
| - * returns the following error codes: * `PERMISSION_DENIED` if the requesting
|
| - * user is not permitted to create invitations for this course or for access
|
| - * errors. * `NOT_FOUND` if the course or the user does not exist. *
|
| - * `FAILED_PRECONDITION` if the requested user's account is disabled or if the
|
| - * user already has this role or a role with greater permissions. *
|
| - * `ALREADY_EXISTS` if an invitation for the specified user and course already
|
| - * exists.
|
| + * at a time. Delete and re-create an invitation to make changes.
|
| + *
|
| + * This method returns the following error codes:
|
| + *
|
| + * * `PERMISSION_DENIED` if the requesting user is not permitted to create
|
| + * invitations for this course or for access errors.
|
| + * * `NOT_FOUND` if the course or the user does not exist.
|
| + * * `FAILED_PRECONDITION` if the requested user's account is disabled or if
|
| + * the user already has this role or a role with greater permissions.
|
| + * * `ALREADY_EXISTS` if an invitation for the specified user and course
|
| + * already exists.
|
| *
|
| * [request] - The metadata request object.
|
| *
|
| @@ -1935,10 +2194,13 @@ class InvitationsResourceApi {
|
| }
|
|
|
| /**
|
| - * Deletes an invitation. This method returns the following error codes: *
|
| - * `PERMISSION_DENIED` if the requesting user is not permitted to delete the
|
| - * requested invitation or for access errors. * `NOT_FOUND` if no invitation
|
| - * exists with the requested ID.
|
| + * Deletes an invitation.
|
| + *
|
| + * This method returns the following error codes:
|
| + *
|
| + * * `PERMISSION_DENIED` if the requesting user is not permitted to delete the
|
| + * requested invitation or for access errors.
|
| + * * `NOT_FOUND` if no invitation exists with the requested ID.
|
| *
|
| * Request parameters:
|
| *
|
| @@ -1977,10 +2239,13 @@ class InvitationsResourceApi {
|
| }
|
|
|
| /**
|
| - * Returns an invitation. This method returns the following error codes: *
|
| - * `PERMISSION_DENIED` if the requesting user is not permitted to view the
|
| - * requested invitation or for access errors. * `NOT_FOUND` if no invitation
|
| - * exists with the requested ID.
|
| + * Returns an invitation.
|
| + *
|
| + * This method returns the following error codes:
|
| + *
|
| + * * `PERMISSION_DENIED` if the requesting user is not permitted to view the
|
| + * requested invitation or for access errors.
|
| + * * `NOT_FOUND` if no invitation exists with the requested ID.
|
| *
|
| * Request parameters:
|
| *
|
| @@ -2020,27 +2285,40 @@ class InvitationsResourceApi {
|
|
|
| /**
|
| * Returns a list of invitations that the requesting user is permitted to
|
| - * view, restricted to those that match the list request. *Note:* At least one
|
| - * of `user_id` or `course_id` must be supplied. Both fields can be supplied.
|
| - * This method returns the following error codes: * `PERMISSION_DENIED` for
|
| - * access errors.
|
| + * view, restricted to those that match the list request.
|
| + *
|
| + * *Note:* At least one of `user_id` or `course_id` must be supplied. Both
|
| + * fields can be supplied.
|
| + *
|
| + * This method returns the following error codes:
|
| + *
|
| + * * `PERMISSION_DENIED` for access errors.
|
| *
|
| * Request parameters:
|
| *
|
| + * [courseId] - Restricts returned invitations to those for a course with the
|
| + * specified
|
| + * identifier.
|
| + *
|
| + * [pageSize] - Maximum number of items to return. Zero means no maximum.
|
| + *
|
| + * The server may return fewer than the specified number of results.
|
| + *
|
| * [userId] - Restricts returned invitations to those for a specific user. The
|
| - * identifier can be one of the following: * the numeric identifier for the
|
| - * user * the email address of the user * the string literal `"me"`,
|
| - * indicating the requesting user
|
| + * identifier
|
| + * can be one of the following:
|
| *
|
| - * [courseId] - Restricts returned invitations to those for a course with the
|
| - * specified identifier.
|
| + * * the numeric identifier for the user
|
| + * * the email address of the user
|
| + * * the string literal `"me"`, indicating the requesting user
|
| *
|
| - * [pageSize] - Maximum number of items to return. Zero means no maximum. The
|
| - * server may return fewer than the specified number of results.
|
| + * [pageToken] - nextPageToken
|
| + * value returned from a previous
|
| + * list call, indicating
|
| + * that the subsequent page of results should be returned.
|
| *
|
| - * [pageToken] - nextPageToken value returned from a previous list call,
|
| - * indicating that the subsequent page of results should be returned. The list
|
| - * request must be otherwise identical to the one that resulted in this token.
|
| + * The list request must be
|
| + * otherwise identical to the one that resulted in this token.
|
| *
|
| * Completes with a [ListInvitationsResponse].
|
| *
|
| @@ -2050,7 +2328,7 @@ class InvitationsResourceApi {
|
| * If the used [http.Client] completes with an error when making a REST call,
|
| * this method will complete with the same error.
|
| */
|
| - async.Future<ListInvitationsResponse> list({core.String userId, core.String courseId, core.int pageSize, core.String pageToken}) {
|
| + async.Future<ListInvitationsResponse> list({core.String courseId, core.int pageSize, core.String userId, core.String pageToken}) {
|
| var _url = null;
|
| var _queryParams = new core.Map();
|
| var _uploadMedia = null;
|
| @@ -2058,15 +2336,15 @@ class InvitationsResourceApi {
|
| var _downloadOptions = commons.DownloadOptions.Metadata;
|
| var _body = null;
|
|
|
| - if (userId != null) {
|
| - _queryParams["userId"] = [userId];
|
| - }
|
| if (courseId != null) {
|
| _queryParams["courseId"] = [courseId];
|
| }
|
| if (pageSize != null) {
|
| _queryParams["pageSize"] = ["${pageSize}"];
|
| }
|
| + if (userId != null) {
|
| + _queryParams["userId"] = [userId];
|
| + }
|
| if (pageToken != null) {
|
| _queryParams["pageToken"] = [pageToken];
|
| }
|
| @@ -2096,16 +2374,23 @@ class UserProfilesResourceApi {
|
| _requester = client;
|
|
|
| /**
|
| - * Returns a user profile. This method returns the following error codes: *
|
| - * `PERMISSION_DENIED` if the requesting user is not permitted to access this
|
| - * user profile, if no profile exists with the requested ID, or for access
|
| - * errors.
|
| + * Returns a user profile.
|
| + *
|
| + * This method returns the following error codes:
|
| + *
|
| + * * `PERMISSION_DENIED` if the requesting user is not permitted to access
|
| + * this user profile, if no profile exists with the requested ID, or for
|
| + * access errors.
|
| *
|
| * Request parameters:
|
| *
|
| * [userId] - Identifier of the profile to return. The identifier can be one
|
| - * of the following: * the numeric identifier for the user * the email address
|
| - * of the user * the string literal `"me"`, indicating the requesting user
|
| + * of the
|
| + * following:
|
| + *
|
| + * * the numeric identifier for the user
|
| + * * the email address of the user
|
| + * * the string literal `"me"`, indicating the requesting user
|
| *
|
| * Completes with a [UserProfile].
|
| *
|
| @@ -2150,28 +2435,35 @@ class UserProfilesGuardianInvitationsResourceApi {
|
|
|
| /**
|
| * Creates a guardian invitation, and sends an email to the guardian asking
|
| - * them to confirm that they are the student's guardian. Once the guardian
|
| - * accepts the invitation, their `state` will change to `COMPLETED` and they
|
| - * will start receiving guardian notifications. A `Guardian` resource will
|
| - * also be created to represent the active guardian. The request object must
|
| - * have the `student_id` and `invited_email_address` fields set. Failing to
|
| - * set these fields, or setting any other fields in the request, will result
|
| - * in an error. This method returns the following error codes: *
|
| - * `PERMISSION_DENIED` if the current user does not have permission to manage
|
| - * guardians, if the guardian in question has already rejected too many
|
| - * requests for that student, if guardians are not enabled for the domain in
|
| - * question, or for other access errors. * `RESOURCE_EXHAUSTED` if the student
|
| - * or guardian has exceeded the guardian link limit. * `INVALID_ARGUMENT` if
|
| - * the guardian email address is not valid (for example, if it is too long),
|
| - * or if the format of the student ID provided cannot be recognized (it is not
|
| - * an email address, nor a `user_id` from this API). This error will also be
|
| - * returned if read-only fields are set, or if the `state` field is set to to
|
| - * a value other than `PENDING`. * `NOT_FOUND` if the student ID provided is a
|
| - * valid student ID, but Classroom has no record of that student. *
|
| - * `ALREADY_EXISTS` if there is already a pending guardian invitation for the
|
| - * student and `invited_email_address` provided, or if the provided
|
| - * `invited_email_address` matches the Google account of an existing
|
| - * `Guardian` for this user.
|
| + * them to confirm that they are the student's guardian.
|
| + *
|
| + * Once the guardian accepts the invitation, their `state` will change to
|
| + * `COMPLETED` and they will start receiving guardian notifications. A
|
| + * `Guardian` resource will also be created to represent the active guardian.
|
| + *
|
| + * The request object must have the `student_id` and
|
| + * `invited_email_address` fields set. Failing to set these fields, or
|
| + * setting any other fields in the request, will result in an error.
|
| + *
|
| + * This method returns the following error codes:
|
| + *
|
| + * * `PERMISSION_DENIED` if the current user does not have permission to
|
| + * manage guardians, if the guardian in question has already rejected
|
| + * too many requests for that student, if guardians are not enabled for the
|
| + * domain in question, or for other access errors.
|
| + * * `RESOURCE_EXHAUSTED` if the student or guardian has exceeded the guardian
|
| + * link limit.
|
| + * * `INVALID_ARGUMENT` if the guardian email address is not valid (for
|
| + * example, if it is too long), or if the format of the student ID provided
|
| + * cannot be recognized (it is not an email address, nor a `user_id` from
|
| + * this API). This error will also be returned if read-only fields are set,
|
| + * or if the `state` field is set to to a value other than `PENDING`.
|
| + * * `NOT_FOUND` if the student ID provided is a valid student ID, but
|
| + * Classroom has no record of that student.
|
| + * * `ALREADY_EXISTS` if there is already a pending guardian invitation for
|
| + * the student and `invited_email_address` provided, or if the provided
|
| + * `invited_email_address` matches the Google account of an existing
|
| + * `Guardian` for this user.
|
| *
|
| * [request] - The metadata request object.
|
| *
|
| @@ -2215,16 +2507,20 @@ class UserProfilesGuardianInvitationsResourceApi {
|
| }
|
|
|
| /**
|
| - * Returns a specific guardian invitation. This method returns the following
|
| - * error codes: * `PERMISSION_DENIED` if the requesting user is not permitted
|
| - * to view guardian invitations for the student identified by the
|
| - * `student_id`, if guardians are not enabled for the domain in question, or
|
| - * for other access errors. * `INVALID_ARGUMENT` if a `student_id` is
|
| - * specified, but its format cannot be recognized (it is not an email address,
|
| - * nor a `student_id` from the API, nor the literal string `me`). *
|
| - * `NOT_FOUND` if Classroom cannot find any record of the given student or
|
| - * `invitation_id`. May also be returned if the student exists, but the
|
| - * requesting user does not have access to see that student.
|
| + * Returns a specific guardian invitation.
|
| + *
|
| + * This method returns the following error codes:
|
| + *
|
| + * * `PERMISSION_DENIED` if the requesting user is not permitted to view
|
| + * guardian invitations for the student identified by the `student_id`, if
|
| + * guardians are not enabled for the domain in question, or for other
|
| + * access errors.
|
| + * * `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot
|
| + * be recognized (it is not an email address, nor a `student_id` from the
|
| + * API, nor the literal string `me`).
|
| + * * `NOT_FOUND` if Classroom cannot find any record of the given student or
|
| + * `invitation_id`. May also be returned if the student exists, but the
|
| + * requesting user does not have access to see that student.
|
| *
|
| * Request parameters:
|
| *
|
| @@ -2271,41 +2567,56 @@ class UserProfilesGuardianInvitationsResourceApi {
|
|
|
| /**
|
| * Returns a list of guardian invitations that the requesting user is
|
| - * permitted to view, filtered by the parameters provided. This method returns
|
| - * the following error codes: * `PERMISSION_DENIED` if a `student_id` is
|
| - * specified, and the requesting user is not permitted to view guardian
|
| - * invitations for that student, if `"-"` is specified as the `student_id` and
|
| - * the user is not a domain administrator, if guardians are not enabled for
|
| - * the domain in question, or for other access errors. * `INVALID_ARGUMENT` if
|
| - * a `student_id` is specified, but its format cannot be recognized (it is not
|
| - * an email address, nor a `student_id` from the API, nor the literal string
|
| - * `me`). May also be returned if an invalid `page_token` or `state` is
|
| - * provided. * `NOT_FOUND` if a `student_id` is specified, and its format can
|
| - * be recognized, but Classroom has no record of that student.
|
| + * permitted to view, filtered by the parameters provided.
|
| + *
|
| + * This method returns the following error codes:
|
| + *
|
| + * * `PERMISSION_DENIED` if a `student_id` is specified, and the requesting
|
| + * user is not permitted to view guardian invitations for that student, if
|
| + * `"-"` is specified as the `student_id` and the user is not a domain
|
| + * administrator, if guardians are not enabled for the domain in question,
|
| + * or for other access errors.
|
| + * * `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot
|
| + * be recognized (it is not an email address, nor a `student_id` from the
|
| + * API, nor the literal string `me`). May also be returned if an invalid
|
| + * `page_token` or `state` is provided.
|
| + * * `NOT_FOUND` if a `student_id` is specified, and its format can be
|
| + * recognized, but Classroom has no record of that student.
|
| *
|
| * Request parameters:
|
| *
|
| * [studentId] - The ID of the student whose guardian invitations are to be
|
| - * returned. The identifier can be one of the following: * the numeric
|
| - * identifier for the user * the email address of the user * the string
|
| - * literal `"me"`, indicating the requesting user * the string literal `"-"`,
|
| - * indicating that results should be returned for all students that the
|
| - * requesting user is permitted to view guardian invitations.
|
| + * returned.
|
| + * The identifier can be one of the following:
|
| + *
|
| + * * the numeric identifier for the user
|
| + * * the email address of the user
|
| + * * the string literal `"me"`, indicating the requesting user
|
| + * * the string literal `"-"`, indicating that results should be returned for
|
| + * all students that the requesting user is permitted to view guardian
|
| + * invitations.
|
| + *
|
| + * [pageSize] - Maximum number of items to return. Zero or unspecified
|
| + * indicates that the
|
| + * server may assign a maximum.
|
| + *
|
| + * The server may return fewer than the specified number of results.
|
| *
|
| * [invitedEmailAddress] - If specified, only results with the specified
|
| - * `invited_email_address` will be returned.
|
| + * `invited_email_address`
|
| + * will be returned.
|
| *
|
| * [states] - If specified, only results with the specified `state` values
|
| - * will be returned. Otherwise, results with a `state` of `PENDING` will be
|
| - * returned.
|
| + * will be
|
| + * returned. Otherwise, results with a `state` of `PENDING` will be returned.
|
| *
|
| - * [pageToken] - nextPageToken value returned from a previous list call,
|
| - * indicating that the subsequent page of results should be returned. The list
|
| - * request must be otherwise identical to the one that resulted in this token.
|
| + * [pageToken] - nextPageToken
|
| + * value returned from a previous
|
| + * list call,
|
| + * indicating that the subsequent page of results should be returned.
|
| *
|
| - * [pageSize] - Maximum number of items to return. Zero or unspecified
|
| - * indicates that the server may assign a maximum. The server may return fewer
|
| - * than the specified number of results.
|
| + * The list request
|
| + * must be otherwise identical to the one that resulted in this token.
|
| *
|
| * Completes with a [ListGuardianInvitationsResponse].
|
| *
|
| @@ -2315,7 +2626,7 @@ class UserProfilesGuardianInvitationsResourceApi {
|
| * If the used [http.Client] completes with an error when making a REST call,
|
| * this method will complete with the same error.
|
| */
|
| - async.Future<ListGuardianInvitationsResponse> list(core.String studentId, {core.String invitedEmailAddress, core.List<core.String> states, core.String pageToken, core.int pageSize}) {
|
| + async.Future<ListGuardianInvitationsResponse> list(core.String studentId, {core.int pageSize, core.String invitedEmailAddress, core.List<core.String> states, core.String pageToken}) {
|
| var _url = null;
|
| var _queryParams = new core.Map();
|
| var _uploadMedia = null;
|
| @@ -2326,6 +2637,9 @@ class UserProfilesGuardianInvitationsResourceApi {
|
| if (studentId == null) {
|
| throw new core.ArgumentError("Parameter studentId is required.");
|
| }
|
| + if (pageSize != null) {
|
| + _queryParams["pageSize"] = ["${pageSize}"];
|
| + }
|
| if (invitedEmailAddress != null) {
|
| _queryParams["invitedEmailAddress"] = [invitedEmailAddress];
|
| }
|
| @@ -2335,9 +2649,6 @@ class UserProfilesGuardianInvitationsResourceApi {
|
| if (pageToken != null) {
|
| _queryParams["pageToken"] = [pageToken];
|
| }
|
| - if (pageSize != null) {
|
| - _queryParams["pageSize"] = ["${pageSize}"];
|
| - }
|
|
|
| _url = 'v1/userProfiles/' + commons.Escaper.ecapeVariable('$studentId') + '/guardianInvitations';
|
|
|
| @@ -2352,19 +2663,24 @@ class UserProfilesGuardianInvitationsResourceApi {
|
| }
|
|
|
| /**
|
| - * Modifies a guardian invitation. Currently, the only valid modification is
|
| - * to change the `state` from `PENDING` to `COMPLETE`. This has the effect of
|
| - * withdrawing the invitation. This method returns the following error codes:
|
| + * Modifies a guardian invitation.
|
| + *
|
| + * Currently, the only valid modification is to change the `state` from
|
| + * `PENDING` to `COMPLETE`. This has the effect of withdrawing the invitation.
|
| + *
|
| + * This method returns the following error codes:
|
| + *
|
| * * `PERMISSION_DENIED` if the current user does not have permission to
|
| * manage guardians, if guardians are not enabled for the domain in question
|
| - * or for other access errors. * `FAILED_PRECONDITION` if the guardian link is
|
| - * not in the `PENDING` state. * `INVALID_ARGUMENT` if the format of the
|
| - * student ID provided cannot be recognized (it is not an email address, nor a
|
| - * `user_id` from this API), or if the passed `GuardianInvitation` has a
|
| - * `state` other than `COMPLETE`, or if it modifies fields other than `state`.
|
| + * or for other access errors.
|
| + * * `FAILED_PRECONDITION` if the guardian link is not in the `PENDING` state.
|
| + * * `INVALID_ARGUMENT` if the format of the student ID provided
|
| + * cannot be recognized (it is not an email address, nor a `user_id` from
|
| + * this API), or if the passed `GuardianInvitation` has a `state` other than
|
| + * `COMPLETE`, or if it modifies fields other than `state`.
|
| * * `NOT_FOUND` if the student ID provided is a valid student ID, but
|
| - * Classroom has no record of that student, or if the `id` field does not
|
| - * refer to a guardian invitation known to Classroom.
|
| + * Classroom has no record of that student, or if the `id` field does not
|
| + * refer to a guardian invitation known to Classroom.
|
| *
|
| * [request] - The metadata request object.
|
| *
|
| @@ -2377,8 +2693,13 @@ class UserProfilesGuardianInvitationsResourceApi {
|
| *
|
| * [updateMask] - Mask that identifies which fields on the course to update.
|
| * This field is required to do an update. The update will fail if invalid
|
| - * fields are specified. The following fields are valid: * `state` When set in
|
| - * a query parameter, this field should be specified as `updateMask=,,...`
|
| + * fields are specified. The following fields are valid:
|
| + *
|
| + * * `state`
|
| + *
|
| + * When set in a query parameter, this field should be specified as
|
| + *
|
| + * `updateMask=<field1>,<field2>,...`
|
| *
|
| * Completes with a [GuardianInvitation].
|
| *
|
| @@ -2431,24 +2752,33 @@ class UserProfilesGuardiansResourceApi {
|
| _requester = client;
|
|
|
| /**
|
| - * Deletes a guardian. The guardian will no longer receive guardian
|
| - * notifications and the guardian will no longer be accessible via the API.
|
| - * This method returns the following error codes: * `PERMISSION_DENIED` if no
|
| - * user that matches the provided `student_id` is visible to the requesting
|
| - * user, if the requesting user is not permitted to manage guardians for the
|
| - * student identified by the `student_id`, if guardians are not enabled for
|
| - * the domain in question, or for other access errors. * `INVALID_ARGUMENT` if
|
| - * a `student_id` is specified, but its format cannot be recognized (it is not
|
| - * an email address, nor a `student_id` from the API). * `NOT_FOUND` if the
|
| - * requesting user is permitted to modify guardians for the requested
|
| - * `student_id`, but no `Guardian` record exists for that student with the
|
| - * provided `guardian_id`.
|
| + * Deletes a guardian.
|
| + *
|
| + * The guardian will no longer receive guardian notifications and the guardian
|
| + * will no longer be accessible via the API.
|
| + *
|
| + * This method returns the following error codes:
|
| + *
|
| + * * `PERMISSION_DENIED` if no user that matches the provided `student_id`
|
| + * is visible to the requesting user, if the requesting user is not
|
| + * permitted to manage guardians for the student identified by the
|
| + * `student_id`, if guardians are not enabled for the domain in question,
|
| + * or for other access errors.
|
| + * * `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot
|
| + * be recognized (it is not an email address, nor a `student_id` from the
|
| + * API).
|
| + * * `NOT_FOUND` if the requesting user is permitted to modify guardians for
|
| + * the requested `student_id`, but no `Guardian` record exists for that
|
| + * student with the provided `guardian_id`.
|
| *
|
| * Request parameters:
|
| *
|
| * [studentId] - The student whose guardian is to be deleted. One of the
|
| - * following: * the numeric identifier for the user * the email address of the
|
| - * user * the string literal `"me"`, indicating the requesting user
|
| + * following:
|
| + *
|
| + * * the numeric identifier for the user
|
| + * * the email address of the user
|
| + * * the string literal `"me"`, indicating the requesting user
|
| *
|
| * [guardianId] - The `id` field from a `Guardian`.
|
| *
|
| @@ -2488,23 +2818,30 @@ class UserProfilesGuardiansResourceApi {
|
| }
|
|
|
| /**
|
| - * Returns a specific guardian. This method returns the following error codes:
|
| - * * `PERMISSION_DENIED` if no user that matches the provided `student_id` is
|
| - * visible to the requesting user, if the requesting user is not permitted to
|
| - * view guardian information for the student identified by the `student_id`,
|
| - * if guardians are not enabled for the domain in question, or for other
|
| - * access errors. * `INVALID_ARGUMENT` if a `student_id` is specified, but its
|
| - * format cannot be recognized (it is not an email address, nor a `student_id`
|
| - * from the API, nor the literal string `me`). * `NOT_FOUND` if the requesting
|
| - * user is permitted to view guardians for the requested `student_id`, but no
|
| - * `Guardian` record exists for that student that matches the provided
|
| - * `guardian_id`.
|
| + * Returns a specific guardian.
|
| + *
|
| + * This method returns the following error codes:
|
| + *
|
| + * * `PERMISSION_DENIED` if no user that matches the provided `student_id`
|
| + * is visible to the requesting user, if the requesting user is not
|
| + * permitted to view guardian information for the student identified by the
|
| + * `student_id`, if guardians are not enabled for the domain in question,
|
| + * or for other access errors.
|
| + * * `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot
|
| + * be recognized (it is not an email address, nor a `student_id` from the
|
| + * API, nor the literal string `me`).
|
| + * * `NOT_FOUND` if the requesting user is permitted to view guardians for
|
| + * the requested `student_id`, but no `Guardian` record exists for that
|
| + * student that matches the provided `guardian_id`.
|
| *
|
| * Request parameters:
|
| *
|
| * [studentId] - The student whose guardian is being requested. One of the
|
| - * following: * the numeric identifier for the user * the email address of the
|
| - * user * the string literal `"me"`, indicating the requesting user
|
| + * following:
|
| + *
|
| + * * the numeric identifier for the user
|
| + * * the email address of the user
|
| + * * the string literal `"me"`, indicating the requesting user
|
| *
|
| * [guardianId] - The `id` field from a `Guardian`.
|
| *
|
| @@ -2544,42 +2881,56 @@ class UserProfilesGuardiansResourceApi {
|
| }
|
|
|
| /**
|
| - * Returns a list of guardians that the requesting user is permitted to view,
|
| - * restricted to those that match the request. To list guardians for any
|
| - * student that the requesting user may view guardians for, use the literal
|
| - * character `-` for the student ID. This method returns the following error
|
| - * codes: * `PERMISSION_DENIED` if a `student_id` is specified, and the
|
| - * requesting user is not permitted to view guardian information for that
|
| - * student, if `"-"` is specified as the `student_id` and the user is not a
|
| - * domain administrator, if guardians are not enabled for the domain in
|
| - * question, if the `invited_email_address` filter is set by a user who is not
|
| - * a domain administrator, or for other access errors. * `INVALID_ARGUMENT` if
|
| - * a `student_id` is specified, but its format cannot be recognized (it is not
|
| - * an email address, nor a `student_id` from the API, nor the literal string
|
| - * `me`). May also be returned if an invalid `page_token` is provided. *
|
| - * `NOT_FOUND` if a `student_id` is specified, and its format can be
|
| - * recognized, but Classroom has no record of that student.
|
| + * Returns a list of guardians that the requesting user is permitted to
|
| + * view, restricted to those that match the request.
|
| + *
|
| + * To list guardians for any student that the requesting user may view
|
| + * guardians for, use the literal character `-` for the student ID.
|
| + *
|
| + * This method returns the following error codes:
|
| + *
|
| + * * `PERMISSION_DENIED` if a `student_id` is specified, and the requesting
|
| + * user is not permitted to view guardian information for that student, if
|
| + * `"-"` is specified as the `student_id` and the user is not a domain
|
| + * administrator, if guardians are not enabled for the domain in question,
|
| + * if the `invited_email_address` filter is set by a user who is not a
|
| + * domain administrator, or for other access errors.
|
| + * * `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot
|
| + * be recognized (it is not an email address, nor a `student_id` from the
|
| + * API, nor the literal string `me`). May also be returned if an invalid
|
| + * `page_token` is provided.
|
| + * * `NOT_FOUND` if a `student_id` is specified, and its format can be
|
| + * recognized, but Classroom has no record of that student.
|
| *
|
| * Request parameters:
|
| *
|
| * [studentId] - Filter results by the student who the guardian is linked to.
|
| - * The identifier can be one of the following: * the numeric identifier for
|
| - * the user * the email address of the user * the string literal `"me"`,
|
| - * indicating the requesting user * the string literal `"-"`, indicating that
|
| - * results should be returned for all students that the requesting user has
|
| - * access to view.
|
| + * The identifier can be one of the following:
|
| + *
|
| + * * the numeric identifier for the user
|
| + * * the email address of the user
|
| + * * the string literal `"me"`, indicating the requesting user
|
| + * * the string literal `"-"`, indicating that results should be returned for
|
| + * all students that the requesting user has access to view.
|
| + *
|
| + * [pageSize] - Maximum number of items to return. Zero or unspecified
|
| + * indicates that the
|
| + * server may assign a maximum.
|
| + *
|
| + * The server may return fewer than the specified number of results.
|
| *
|
| * [invitedEmailAddress] - Filter results by the email address that the
|
| - * original invitation was sent to, resulting in this guardian link. This
|
| - * filter can only be used by domain administrators.
|
| + * original invitation was sent
|
| + * to, resulting in this guardian link.
|
| + * This filter can only be used by domain administrators.
|
| *
|
| - * [pageToken] - nextPageToken value returned from a previous list call,
|
| - * indicating that the subsequent page of results should be returned. The list
|
| - * request must be otherwise identical to the one that resulted in this token.
|
| + * [pageToken] - nextPageToken
|
| + * value returned from a previous
|
| + * list call,
|
| + * indicating that the subsequent page of results should be returned.
|
| *
|
| - * [pageSize] - Maximum number of items to return. Zero or unspecified
|
| - * indicates that the server may assign a maximum. The server may return fewer
|
| - * than the specified number of results.
|
| + * The list request
|
| + * must be otherwise identical to the one that resulted in this token.
|
| *
|
| * Completes with a [ListGuardiansResponse].
|
| *
|
| @@ -2589,7 +2940,7 @@ class UserProfilesGuardiansResourceApi {
|
| * If the used [http.Client] completes with an error when making a REST call,
|
| * this method will complete with the same error.
|
| */
|
| - async.Future<ListGuardiansResponse> list(core.String studentId, {core.String invitedEmailAddress, core.String pageToken, core.int pageSize}) {
|
| + async.Future<ListGuardiansResponse> list(core.String studentId, {core.int pageSize, core.String invitedEmailAddress, core.String pageToken}) {
|
| var _url = null;
|
| var _queryParams = new core.Map();
|
| var _uploadMedia = null;
|
| @@ -2600,15 +2951,15 @@ class UserProfilesGuardiansResourceApi {
|
| if (studentId == null) {
|
| throw new core.ArgumentError("Parameter studentId is required.");
|
| }
|
| + if (pageSize != null) {
|
| + _queryParams["pageSize"] = ["${pageSize}"];
|
| + }
|
| if (invitedEmailAddress != null) {
|
| _queryParams["invitedEmailAddress"] = [invitedEmailAddress];
|
| }
|
| if (pageToken != null) {
|
| _queryParams["pageToken"] = [pageToken];
|
| }
|
| - if (pageSize != null) {
|
| - _queryParams["pageSize"] = ["${pageSize}"];
|
| - }
|
|
|
| _url = 'v1/userProfiles/' + commons.Escaper.ecapeVariable('$studentId') + '/guardians';
|
|
|
| @@ -2629,8 +2980,8 @@ class UserProfilesGuardiansResourceApi {
|
| /** Additional details for assignments. */
|
| class Assignment {
|
| /**
|
| - * Drive folder where attachments from student submissions are placed. This is
|
| - * only populated for course teachers.
|
| + * Drive folder where attachments from student submissions are placed.
|
| + * This is only populated for course teachers.
|
| */
|
| DriveFolder studentWorkFolder;
|
|
|
| @@ -2654,12 +3005,14 @@ class Assignment {
|
| /** Student work for an assignment. */
|
| class AssignmentSubmission {
|
| /**
|
| - * Attachments added by the student. Drive files that correspond to materials
|
| - * with a share mode of STUDENT_COPY may not exist yet if the student has not
|
| - * accessed the assignment in Classroom. Some attachment metadata is only
|
| - * populated if the requesting user has permission to access it. Identifier
|
| - * and alternate_link fields are always available, but others (e.g. title) may
|
| - * not be.
|
| + * Attachments added by the student.
|
| + * Drive files that correspond to materials with a share mode of
|
| + * STUDENT_COPY may not exist yet if the student has not accessed the
|
| + * assignment in Classroom.
|
| + *
|
| + * Some attachment metadata is only populated if the requesting user has
|
| + * permission to access it. Identifier and alternate_link fields are always
|
| + * available, but others (e.g. title) may not be.
|
| */
|
| core.List<Attachment> attachments;
|
|
|
| @@ -2681,8 +3034,9 @@ class AssignmentSubmission {
|
| }
|
|
|
| /**
|
| - * Attachment added to student assignment work. When creating attachments,
|
| - * setting the `form` field is not supported.
|
| + * Attachment added to student assignment work.
|
| + *
|
| + * When creating attachments, setting the `form` field is not supported.
|
| */
|
| class Attachment {
|
| /** Google Drive file attachment. */
|
| @@ -2731,104 +3085,163 @@ class Attachment {
|
|
|
| /** A Course in Classroom. */
|
| class Course {
|
| - /** Absolute link to this course in the Classroom web UI. Read-only. */
|
| + /**
|
| + * Absolute link to this course in the Classroom web UI.
|
| + *
|
| + * Read-only.
|
| + */
|
| core.String alternateLink;
|
| /**
|
| * The email address of a Google group containing all members of the course.
|
| * This group does not accept email and can only be used for permissions.
|
| + *
|
| * Read-only.
|
| */
|
| core.String courseGroupEmail;
|
| /**
|
| * Sets of materials that appear on the "about" page of this course.
|
| + *
|
| * Read-only.
|
| */
|
| core.List<CourseMaterialSet> courseMaterialSets;
|
| /**
|
| - * State of the course. If unspecified, the default state is `PROVISIONED`.
|
| + * State of the course.
|
| + * If unspecified, the default state is `PROVISIONED`.
|
| * Possible string values are:
|
| - * - "COURSE_STATE_UNSPECIFIED" : A COURSE_STATE_UNSPECIFIED.
|
| - * - "ACTIVE" : A ACTIVE.
|
| - * - "ARCHIVED" : A ARCHIVED.
|
| - * - "PROVISIONED" : A PROVISIONED.
|
| - * - "DECLINED" : A DECLINED.
|
| + * - "COURSE_STATE_UNSPECIFIED" : No course state. No returned Course message
|
| + * will use this value.
|
| + * - "ACTIVE" : The course is active.
|
| + * - "ARCHIVED" : The course has been archived. You cannot modify it except to
|
| + * change it
|
| + * to a different state.
|
| + * - "PROVISIONED" : The course has been created, but not yet activated. It is
|
| + * accessible by
|
| + * the primary teacher and domain administrators, who may modify it or
|
| + * change it to the `ACTIVE` or `DECLINED` states.
|
| + * A course may only be changed to `PROVISIONED` if it is in the `DECLINED`
|
| + * state.
|
| + * - "DECLINED" : The course has been created, but declined. It is accessible
|
| + * by the
|
| + * course owner and domain administrators, though it will not be
|
| + * displayed in the web UI. You cannot modify the course except to change it
|
| + * to the `PROVISIONED` state.
|
| + * A course may only be changed to `DECLINED` if it is in the `PROVISIONED`
|
| + * state.
|
| + * - "SUSPENDED" : The course has been suspended. You cannot modify the
|
| + * course, and only the
|
| + * user identified by the `owner_id` can view the course.
|
| + * A course may be placed in this state if it potentially violates the
|
| + * Terms of Service.
|
| */
|
| core.String courseState;
|
| /**
|
| - * Creation time of the course. Specifying this field in a course update mask
|
| - * results in an error. Read-only.
|
| + * Creation time of the course.
|
| + * Specifying this field in a course update mask results in an error.
|
| + *
|
| + * Read-only.
|
| */
|
| core.String creationTime;
|
| /**
|
| - * Optional description. For example, "We'll be learning about the structure
|
| - * of living creatures from a combination of textbooks, guest lectures, and
|
| - * lab work. Expect to be excited!" If set, this field must be a valid UTF-8
|
| - * string and no longer than 30,000 characters.
|
| + * Optional description.
|
| + * For example, "We'll be learning about the structure of living
|
| + * creatures from a combination of textbooks, guest lectures, and lab work.
|
| + * Expect to be excited!"
|
| + * If set, this field must be a valid UTF-8 string and no longer than 30,000
|
| + * characters.
|
| */
|
| core.String description;
|
| /**
|
| - * Optional heading for the description. For example, "Welcome to 10th Grade
|
| - * Biology." If set, this field must be a valid UTF-8 string and no longer
|
| - * than 3600 characters.
|
| + * Optional heading for the description.
|
| + * For example, "Welcome to 10th Grade Biology."
|
| + * If set, this field must be a valid UTF-8 string and no longer than 3600
|
| + * characters.
|
| */
|
| core.String descriptionHeading;
|
| /**
|
| - * Enrollment code to use when joining this course. Specifying this field in a
|
| - * course update mask results in an error. Read-only.
|
| + * Enrollment code to use when joining this course.
|
| + * Specifying this field in a course update mask results in an error.
|
| + *
|
| + * Read-only.
|
| */
|
| core.String enrollmentCode;
|
| /**
|
| * Whether or not guardian notifications are enabled for this course.
|
| + *
|
| * Read-only.
|
| */
|
| core.bool guardiansEnabled;
|
| /**
|
| - * Identifier for this course assigned by Classroom. When creating a course,
|
| - * you may optionally set this identifier to an alias string in the request to
|
| - * create a corresponding alias. The `id` is still assigned by Classroom and
|
| - * cannot be updated after the course is created. Specifying this field in a
|
| - * course update mask results in an error.
|
| + * Identifier for this course assigned by Classroom.
|
| + *
|
| + * When
|
| + * creating a course,
|
| + * you may optionally set this identifier to an
|
| + * alias string in the
|
| + * request to create a corresponding alias. The `id` is still assigned by
|
| + * Classroom and cannot be updated after the course is created.
|
| + *
|
| + * Specifying this field in a course update mask results in an error.
|
| */
|
| core.String id;
|
| /**
|
| - * Name of the course. For example, "10th Grade Biology". The name is
|
| - * required. It must be between 1 and 750 characters and a valid UTF-8 string.
|
| + * Name of the course.
|
| + * For example, "10th Grade Biology".
|
| + * The name is required. It must be between 1 and 750 characters and a valid
|
| + * UTF-8 string.
|
| */
|
| core.String name;
|
| /**
|
| - * The identifier of the owner of a course. When specified as a parameter of a
|
| - * create course request, this field is required. The identifier can be one of
|
| - * the following: * the numeric identifier for the user * the email address of
|
| - * the user * the string literal `"me"`, indicating the requesting user This
|
| - * must be set in a create request. Specifying this field in a course update
|
| - * mask results in an `INVALID_ARGUMENT` error.
|
| + * The identifier of the owner of a course.
|
| + *
|
| + * When specified as a parameter of a
|
| + * create course request, this
|
| + * field is required.
|
| + * The identifier can be one of the following:
|
| + *
|
| + * * the numeric identifier for the user
|
| + * * the email address of the user
|
| + * * the string literal `"me"`, indicating the requesting user
|
| + *
|
| + * This must be set in a create request. Specifying this field in a course
|
| + * update mask results in an `INVALID_ARGUMENT` error.
|
| */
|
| core.String ownerId;
|
| /**
|
| - * Optional room location. For example, "301". If set, this field must be a
|
| - * valid UTF-8 string and no longer than 650 characters.
|
| + * Optional room location.
|
| + * For example, "301".
|
| + * If set, this field must be a valid UTF-8 string and no longer than 650
|
| + * characters.
|
| */
|
| core.String room;
|
| /**
|
| - * Section of the course. For example, "Period 2". If set, this field must be
|
| - * a valid UTF-8 string and no longer than 2800 characters.
|
| + * Section of the course.
|
| + * For example, "Period 2".
|
| + * If set, this field must be a valid UTF-8 string and no longer than 2800
|
| + * characters.
|
| */
|
| core.String section;
|
| /**
|
| * Information about a Drive Folder that is shared with all teachers of the
|
| - * course. This field will only be set for teachers of the course and domain
|
| - * administrators. Read-only.
|
| + * course.
|
| + *
|
| + * This field will only be set for teachers of the course and domain
|
| + * administrators.
|
| + *
|
| + * Read-only.
|
| */
|
| DriveFolder teacherFolder;
|
| /**
|
| * The email address of a Google group containing all teachers of the course.
|
| * This group does not accept email and can only be used for permissions.
|
| + *
|
| * Read-only.
|
| */
|
| core.String teacherGroupEmail;
|
| /**
|
| - * Time of the most recent update to this course. Specifying this field in a
|
| - * course update mask results in an error. Read-only.
|
| + * Time of the most recent update to this course.
|
| + * Specifying this field in a course update mask results in an error.
|
| + *
|
| + * Read-only.
|
| */
|
| core.String updateTime;
|
|
|
| @@ -2946,24 +3359,32 @@ class Course {
|
| }
|
|
|
| /**
|
| - * Alternative identifier for a course. An alias uniquely identifies a course.
|
| - * It must be unique within one of the following scopes: * domain: A
|
| - * domain-scoped alias is visible to all users within the alias creator's domain
|
| - * and can be created only by a domain admin. A domain-scoped alias is often
|
| - * used when a course has an identifier external to Classroom. * project: A
|
| - * project-scoped alias is visible to any request from an application using the
|
| - * Developer Console project ID that created the alias and can be created by any
|
| - * project. A project-scoped alias is often used when an application has
|
| - * alternative identifiers. A random value can also be used to avoid duplicate
|
| - * courses in the event of transmission failures, as retrying a request will
|
| - * return `ALREADY_EXISTS` if a previous one has succeeded.
|
| + * Alternative identifier for a course.
|
| + *
|
| + * An alias uniquely identifies a course. It must be unique within one of the
|
| + * following scopes:
|
| + *
|
| + * * domain: A domain-scoped alias is visible to all users within the alias
|
| + * creator's domain and can be created only by a domain admin. A domain-scoped
|
| + * alias is often used when a course has an identifier external to Classroom.
|
| + *
|
| + * * project: A project-scoped alias is visible to any request from an
|
| + * application using the Developer Console project ID that created the alias
|
| + * and can be created by any project. A project-scoped alias is often used when
|
| + * an application has alternative identifiers. A random value can also be used
|
| + * to avoid duplicate courses in the event of transmission failures, as retrying
|
| + * a request will return `ALREADY_EXISTS` if a previous one has succeeded.
|
| */
|
| class CourseAlias {
|
| /**
|
| * Alias string. The format of the string indicates the desired alias scoping.
|
| - * * `d:` indicates a domain-scoped alias. Example: `d:math_101` * `p:`
|
| - * indicates a project-scoped alias. Example: `p:abc123` This field has a
|
| - * maximum length of 256 characters.
|
| + *
|
| + * * `d:<name>` indicates a domain-scoped alias.
|
| + * Example: `d:math_101`
|
| + * * `p:<name>` indicates a project-scoped alias.
|
| + * Example: `p:abc123`
|
| + *
|
| + * This field has a maximum length of 256 characters.
|
| */
|
| core.String alias;
|
|
|
| @@ -3031,9 +3452,9 @@ class CourseMaterial {
|
| }
|
|
|
| /**
|
| - * A set of materials that appears on the "About" page of the course. These
|
| - * materials might include a syllabus, schedule, or other background information
|
| - * relating to the course as a whole.
|
| + * A set of materials that appears on the "About" page of the course.
|
| + * These materials might include a syllabus, schedule, or other background
|
| + * information relating to the course as a whole.
|
| */
|
| class CourseMaterialSet {
|
| /** Materials attached to this set. */
|
| @@ -3067,28 +3488,45 @@ class CourseMaterialSet {
|
| /** Course work created by a teacher for students of the course. */
|
| class CourseWork {
|
| /**
|
| - * Absolute link to this course work in the Classroom web UI. This is only
|
| - * populated if `state` is `PUBLISHED`. Read-only.
|
| + * Absolute link to this course work in the Classroom web UI.
|
| + * This is only populated if `state` is `PUBLISHED`.
|
| + *
|
| + * Read-only.
|
| */
|
| core.String alternateLink;
|
| /**
|
| - * Assignment details. This is populated only when `work_type` is
|
| - * `ASSIGNMENT`. Read-only.
|
| + * Assignment details.
|
| + * This is populated only when `work_type` is `ASSIGNMENT`.
|
| + *
|
| + * Read-only.
|
| */
|
| Assignment assignment;
|
| /**
|
| * Whether this course work item is associated with the Developer Console
|
| - * project making the request. See google.classroom.Work.CreateCourseWork for
|
| - * more details. Read-only.
|
| + * project making the request.
|
| + *
|
| + * See google.classroom.Work.CreateCourseWork for more
|
| + * details.
|
| + *
|
| + * Read-only.
|
| */
|
| core.bool associatedWithDeveloper;
|
| - /** Identifier of the course. Read-only. */
|
| + /**
|
| + * Identifier of the course.
|
| + *
|
| + * Read-only.
|
| + */
|
| core.String courseId;
|
| - /** Timestamp when this course work was created. Read-only. */
|
| + /**
|
| + * Timestamp when this course work was created.
|
| + *
|
| + * Read-only.
|
| + */
|
| core.String creationTime;
|
| /**
|
| - * Optional description of this course work. If set, the description must be a
|
| - * valid UTF-8 string containing no more than 30,000 characters.
|
| + * Optional description of this course work.
|
| + * If set, the description must be a valid UTF-8 string containing no more
|
| + * than 30,000 characters.
|
| */
|
| core.String description;
|
| /**
|
| @@ -3098,65 +3536,87 @@ class CourseWork {
|
| Date dueDate;
|
| /**
|
| * Optional time of day, in UTC, that submissions for this this course work
|
| - * are due. This must be specified if `due_date` is specified.
|
| + * are due.
|
| + * This must be specified if `due_date` is specified.
|
| */
|
| TimeOfDay dueTime;
|
| /**
|
| * Classroom-assigned identifier of this course work, unique per course.
|
| + *
|
| * Read-only.
|
| */
|
| core.String id;
|
| /**
|
| - * Additional materials. CourseWork must have no more than 20 material items.
|
| + * Additional materials.
|
| + *
|
| + * CourseWork must have no more than 20 material items.
|
| */
|
| core.List<Material> materials;
|
| /**
|
| - * Maximum grade for this course work. If zero or unspecified, this assignment
|
| - * is considered ungraded. This must be a non-negative integer value.
|
| + * Maximum grade for this course work.
|
| + * If zero or unspecified, this assignment is considered ungraded.
|
| + * This must be a non-negative integer value.
|
| */
|
| core.double maxPoints;
|
| /**
|
| - * Multiple choice question details. For read operations, this field is
|
| - * populated only when `work_type` is `MULTIPLE_CHOICE_QUESTION`. For write
|
| - * operations, this field must be specified when creating course work with a
|
| - * `work_type` of `MULTIPLE_CHOICE_QUESTION`, and it must not be set
|
| - * otherwise.
|
| + * Multiple choice question details.
|
| + * For read operations, this field is populated only when `work_type` is
|
| + * `MULTIPLE_CHOICE_QUESTION`.
|
| + * For write operations, this field must be specified when creating course
|
| + * work with a `work_type` of `MULTIPLE_CHOICE_QUESTION`, and it must not be
|
| + * set otherwise.
|
| */
|
| MultipleChoiceQuestion multipleChoiceQuestion;
|
| /**
|
| - * Status of this course work. If unspecified, the default state is `DRAFT`.
|
| + * Status of this course work.
|
| + * If unspecified, the default state is `DRAFT`.
|
| * Possible string values are:
|
| - * - "COURSE_WORK_STATE_UNSPECIFIED" : A COURSE_WORK_STATE_UNSPECIFIED.
|
| - * - "PUBLISHED" : A PUBLISHED.
|
| - * - "DRAFT" : A DRAFT.
|
| - * - "DELETED" : A DELETED.
|
| + * - "COURSE_WORK_STATE_UNSPECIFIED" : No state specified. This is never
|
| + * returned.
|
| + * - "PUBLISHED" : Status for work that has been published.
|
| + * This is the default state.
|
| + * - "DRAFT" : Status for work that is not yet published.
|
| + * Work in this state is visible only to course teachers and domain
|
| + * administrators.
|
| + * - "DELETED" : Status for work that was published but is now deleted.
|
| + * Work in this state is visible only to course teachers and domain
|
| + * administrators.
|
| + * Work in this state is deleted after some time.
|
| */
|
| core.String state;
|
| /**
|
| - * Setting to determine when students are allowed to modify submissions. If
|
| - * unspecified, the default value is `MODIFIABLE_UNTIL_TURNED_IN`.
|
| + * Setting to determine when students are allowed to modify submissions.
|
| + * If unspecified, the default value is `MODIFIABLE_UNTIL_TURNED_IN`.
|
| * Possible string values are:
|
| - * - "SUBMISSION_MODIFICATION_MODE_UNSPECIFIED" : A
|
| - * SUBMISSION_MODIFICATION_MODE_UNSPECIFIED.
|
| - * - "MODIFIABLE_UNTIL_TURNED_IN" : A MODIFIABLE_UNTIL_TURNED_IN.
|
| - * - "MODIFIABLE" : A MODIFIABLE.
|
| + * - "SUBMISSION_MODIFICATION_MODE_UNSPECIFIED" : No modification mode
|
| + * specified. This is never returned.
|
| + * - "MODIFIABLE_UNTIL_TURNED_IN" : Submisisons can be modified before being
|
| + * turned in.
|
| + * - "MODIFIABLE" : Submisisons can be modified at any time.
|
| */
|
| core.String submissionModificationMode;
|
| /**
|
| - * Title of this course work. The title must be a valid UTF-8 string
|
| - * containing between 1 and 3000 characters.
|
| + * Title of this course work.
|
| + * The title must be a valid UTF-8 string containing between 1 and 3000
|
| + * characters.
|
| */
|
| core.String title;
|
| - /** Timestamp of the most recent change to this course work. Read-only. */
|
| + /**
|
| + * Timestamp of the most recent change to this course work.
|
| + *
|
| + * Read-only.
|
| + */
|
| core.String updateTime;
|
| /**
|
| - * Type of this course work. The type is set when the course work is created
|
| - * and cannot be changed.
|
| + * Type of this course work.
|
| + *
|
| + * The type is set when the course work is created and cannot be changed.
|
| * Possible string values are:
|
| - * - "COURSE_WORK_TYPE_UNSPECIFIED" : A COURSE_WORK_TYPE_UNSPECIFIED.
|
| - * - "ASSIGNMENT" : A ASSIGNMENT.
|
| - * - "SHORT_ANSWER_QUESTION" : A SHORT_ANSWER_QUESTION.
|
| - * - "MULTIPLE_CHOICE_QUESTION" : A MULTIPLE_CHOICE_QUESTION.
|
| + * - "COURSE_WORK_TYPE_UNSPECIFIED" : No work type specified. This is never
|
| + * returned.
|
| + * - "ASSIGNMENT" : An assignment.
|
| + * - "SHORT_ANSWER_QUESTION" : A short answer question.
|
| + * - "MULTIPLE_CHOICE_QUESTION" : A multiple-choice question.
|
| */
|
| core.String workType;
|
|
|
| @@ -3275,12 +3735,12 @@ class CourseWork {
|
|
|
| /**
|
| * Represents a whole calendar date, e.g. date of birth. The time of day and
|
| - * time zone are either specified elsewhere or are not significant. The date is
|
| - * relative to the Proleptic Gregorian Calendar. The day may be 0 to represent a
|
| - * year and month where the day is not significant, e.g. credit card expiration
|
| - * date. The year may be 0 to represent a month and day independent of year,
|
| - * e.g. anniversary date. Related types are google.type.TimeOfDay and
|
| - * `google.protobuf.Timestamp`.
|
| + * time zone are either specified elsewhere or are not significant. The date
|
| + * is relative to the Proleptic Gregorian Calendar. The day may be 0 to
|
| + * represent a year and month where the day is not significant, e.g. credit card
|
| + * expiration date. The year may be 0 to represent a month and day independent
|
| + * of year, e.g. anniversary date. Related types are google.type.TimeOfDay
|
| + * and `google.protobuf.Timestamp`.
|
| */
|
| class Date {
|
| /**
|
| @@ -3291,8 +3751,8 @@ class Date {
|
| /** Month of year. Must be from 1 to 12. */
|
| core.int month;
|
| /**
|
| - * Year of date. Must be from 1 to 9999, or 0 if specifying a date without a
|
| - * year.
|
| + * Year of date. Must be from 1 to 9999, or 0 if specifying a date without
|
| + * a year.
|
| */
|
| core.int year;
|
|
|
| @@ -3327,13 +3787,25 @@ class Date {
|
|
|
| /** Representation of a Google Drive file. */
|
| class DriveFile {
|
| - /** URL that can be used to access the Drive item. Read-only. */
|
| + /**
|
| + * URL that can be used to access the Drive item.
|
| + *
|
| + * Read-only.
|
| + */
|
| core.String alternateLink;
|
| /** Drive API resource ID. */
|
| core.String id;
|
| - /** URL of a thumbnail image of the Drive item. Read-only. */
|
| + /**
|
| + * URL of a thumbnail image of the Drive item.
|
| + *
|
| + * Read-only.
|
| + */
|
| core.String thumbnailUrl;
|
| - /** Title of the Drive item. Read-only. */
|
| + /**
|
| + * Title of the Drive item.
|
| + *
|
| + * Read-only.
|
| + */
|
| core.String title;
|
|
|
| DriveFile();
|
| @@ -3373,11 +3845,19 @@ class DriveFile {
|
|
|
| /** Representation of a Google Drive folder. */
|
| class DriveFolder {
|
| - /** URL that can be used to access the Drive folder. Read-only. */
|
| + /**
|
| + * URL that can be used to access the Drive folder.
|
| + *
|
| + * Read-only.
|
| + */
|
| core.String alternateLink;
|
| /** Drive API resource ID. */
|
| core.String id;
|
| - /** Title of the Drive folder. Read-only. */
|
| + /**
|
| + * Title of the Drive folder.
|
| + *
|
| + * Read-only.
|
| + */
|
| core.String title;
|
|
|
| DriveFolder();
|
| @@ -3411,10 +3891,14 @@ class DriveFolder {
|
|
|
| /**
|
| * A generic empty message that you can re-use to avoid defining duplicated
|
| - * empty messages in your APIs. A typical example is to use it as the request or
|
| - * the response type of an API method. For instance: service Foo { rpc
|
| - * Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON
|
| - * representation for `Empty` is empty JSON object `{}`.
|
| + * empty messages in your APIs. A typical example is to use it as the request
|
| + * or the response type of an API method. For instance:
|
| + *
|
| + * service Foo {
|
| + * rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
|
| + * }
|
| + *
|
| + * The JSON representation for `Empty` is empty JSON object `{}`.
|
| */
|
| class Empty {
|
|
|
| @@ -3434,14 +3918,24 @@ class Form {
|
| /** URL of the form. */
|
| core.String formUrl;
|
| /**
|
| - * URL of the form responses document. Only set if respsonses have been
|
| - * recorded and only when the requesting user is an editor of the form.
|
| + * URL of the form responses document.
|
| + * Only set if respsonses have been recorded and only when the
|
| + * requesting user is an editor of the form.
|
| + *
|
| * Read-only.
|
| */
|
| core.String responseUrl;
|
| - /** URL of a thumbnail image of the Form. Read-only. */
|
| + /**
|
| + * URL of a thumbnail image of the Form.
|
| + *
|
| + * Read-only.
|
| + */
|
| core.String thumbnailUrl;
|
| - /** Title of the Form. Read-only. */
|
| + /**
|
| + * Title of the Form.
|
| + *
|
| + * Read-only.
|
| + */
|
| core.String title;
|
|
|
| Form();
|
| @@ -3484,8 +3978,10 @@ class GlobalPermission {
|
| /**
|
| * Permission value.
|
| * Possible string values are:
|
| - * - "PERMISSION_UNSPECIFIED" : A PERMISSION_UNSPECIFIED.
|
| - * - "CREATE_COURSE" : A CREATE_COURSE.
|
| + * - "PERMISSION_UNSPECIFIED" : No permission is specified. This is not
|
| + * returned and is not a
|
| + * valid value.
|
| + * - "CREATE_COURSE" : User is permitted to create a course.
|
| */
|
| core.String permission;
|
|
|
| @@ -3516,8 +4012,8 @@ class Guardian {
|
| /** User profile for the guardian. */
|
| UserProfile guardianProfile;
|
| /**
|
| - * The email address to which the initial guardian invitation was sent. This
|
| - * field is only visible to domain administrators.
|
| + * The email address to which the initial guardian invitation was sent.
|
| + * This field is only visible to domain administrators.
|
| */
|
| core.String invitedEmailAddress;
|
| /** Identifier for the student to whom the guardian relationship applies. */
|
| @@ -3563,22 +4059,31 @@ class Guardian {
|
| * email address.
|
| */
|
| class GuardianInvitation {
|
| - /** The time that this invitation was created. Read-only. */
|
| + /**
|
| + * The time that this invitation was created.
|
| + *
|
| + * Read-only.
|
| + */
|
| core.String creationTime;
|
| - /** Unique identifier for this invitation. Read-only. */
|
| + /**
|
| + * Unique identifier for this invitation.
|
| + *
|
| + * Read-only.
|
| + */
|
| core.String invitationId;
|
| /**
|
| - * Email address that the invitation was sent to. This field is only visible
|
| - * to domain administrators.
|
| + * Email address that the invitation was sent to.
|
| + * This field is only visible to domain administrators.
|
| */
|
| core.String invitedEmailAddress;
|
| /**
|
| * The state that this invitation is in.
|
| * Possible string values are:
|
| - * - "GUARDIAN_INVITATION_STATE_UNSPECIFIED" : A
|
| - * GUARDIAN_INVITATION_STATE_UNSPECIFIED.
|
| - * - "PENDING" : A PENDING.
|
| - * - "COMPLETE" : A COMPLETE.
|
| + * - "GUARDIAN_INVITATION_STATE_UNSPECIFIED" : Should never be returned.
|
| + * - "PENDING" : The invitation is active and awaiting a response.
|
| + * - "COMPLETE" : The invitation is no longer active. It may have been
|
| + * accepted, declined,
|
| + * withdrawn or it may have expired.
|
| */
|
| core.String state;
|
| /** ID of the student (in standard format) */
|
| @@ -3629,21 +4134,30 @@ class GuardianInvitation {
|
| class Invitation {
|
| /** Identifier of the course to invite the user to. */
|
| core.String courseId;
|
| - /** Identifier assigned by Classroom. Read-only. */
|
| + /**
|
| + * Identifier assigned by Classroom.
|
| + *
|
| + * Read-only.
|
| + */
|
| core.String id;
|
| /**
|
| - * Role to invite the user to have. Must not be `COURSE_ROLE_UNSPECIFIED`.
|
| + * Role to invite the user to have.
|
| + * Must not be `COURSE_ROLE_UNSPECIFIED`.
|
| * Possible string values are:
|
| - * - "COURSE_ROLE_UNSPECIFIED" : A COURSE_ROLE_UNSPECIFIED.
|
| - * - "STUDENT" : A STUDENT.
|
| - * - "TEACHER" : A TEACHER.
|
| + * - "COURSE_ROLE_UNSPECIFIED" : No course role.
|
| + * - "STUDENT" : Student in the course.
|
| + * - "TEACHER" : Teacher of the course.
|
| */
|
| core.String role;
|
| /**
|
| - * Identifier of the invited user. When specified as a parameter of a request,
|
| - * this identifier can be set to one of the following: * the numeric
|
| - * identifier for the user * the email address of the user * the string
|
| - * literal `"me"`, indicating the requesting user
|
| + * Identifier of the invited user.
|
| + *
|
| + * When specified as a parameter of a request, this identifier can be set to
|
| + * one of the following:
|
| + *
|
| + * * the numeric identifier for the user
|
| + * * the email address of the user
|
| + * * the string literal `"me"`, indicating the requesting user
|
| */
|
| core.String userId;
|
|
|
| @@ -3684,13 +4198,21 @@ class Invitation {
|
|
|
| /** URL item. */
|
| class Link {
|
| - /** URL of a thumbnail image of the target URL. Read-only. */
|
| + /**
|
| + * URL of a thumbnail image of the target URL.
|
| + *
|
| + * Read-only.
|
| + */
|
| core.String thumbnailUrl;
|
| - /** Title of the target of the URL. Read-only. */
|
| + /**
|
| + * Title of the target of the URL.
|
| + *
|
| + * Read-only.
|
| + */
|
| core.String title;
|
| /**
|
| - * URL to link to. This must be a valid UTF-8 string containing between 1 and
|
| - * 2024 characters.
|
| + * URL to link to.
|
| + * This must be a valid UTF-8 string containing between 1 and 2024 characters.
|
| */
|
| core.String url;
|
|
|
| @@ -3858,8 +4380,8 @@ class ListGuardianInvitationsResponse {
|
| /** Response when listing guardians. */
|
| class ListGuardiansResponse {
|
| /**
|
| - * Guardians on this page of results that met the criteria specified in the
|
| - * request.
|
| + * Guardians on this page of results that met the criteria specified in
|
| + * the request.
|
| */
|
| core.List<Guardian> guardians;
|
| /**
|
| @@ -4024,8 +4546,9 @@ class ListTeachersResponse {
|
| }
|
|
|
| /**
|
| - * Material attached to course work. When creating attachments, setting the
|
| - * `form` field is not supported.
|
| + * Material attached to course work.
|
| + *
|
| + * When creating attachments, setting the `form` field is not supported.
|
| */
|
| class Material {
|
| /** Google Drive file material. */
|
| @@ -4033,8 +4556,8 @@ class Material {
|
| /** Google Forms material. */
|
| Form form;
|
| /**
|
| - * Link material. On creation, will be upgraded to a more appropriate type if
|
| - * possible, and this will be reflected in the response.
|
| + * Link material. On creation, will be upgraded to a more appropriate type
|
| + * if possible, and this will be reflected in the response.
|
| */
|
| Link link;
|
| /** YouTube video material. */
|
| @@ -4078,8 +4601,10 @@ class Material {
|
| /** Request to modify the attachments of a student submission. */
|
| class ModifyAttachmentsRequest {
|
| /**
|
| - * Attachments to add. A student submission may not have more than 20
|
| - * attachments. Form attachments are not supported.
|
| + * Attachments to add.
|
| + * A student submission may not have more than 20 attachments.
|
| + *
|
| + * Form attachments are not supported.
|
| */
|
| core.List<Attachment> addAttachments;
|
|
|
| @@ -4146,14 +4671,24 @@ class MultipleChoiceSubmission {
|
|
|
| /** Details of the user's name. */
|
| class Name {
|
| - /** The user's last name. Read-only. */
|
| + /**
|
| + * The user's last name.
|
| + *
|
| + * Read-only.
|
| + */
|
| core.String familyName;
|
| /**
|
| * The user's full name formed by concatenating the first and last name
|
| - * values. Read-only.
|
| + * values.
|
| + *
|
| + * Read-only.
|
| */
|
| core.String fullName;
|
| - /** The user's first name. Read-only. */
|
| + /**
|
| + * The user's first name.
|
| + *
|
| + * Read-only.
|
| + */
|
| core.String givenName;
|
|
|
| Name();
|
| @@ -4220,10 +4755,11 @@ class SharedDriveFile {
|
| /**
|
| * Mechanism by which students access the Drive item.
|
| * Possible string values are:
|
| - * - "UNKNOWN_SHARE_MODE" : A UNKNOWN_SHARE_MODE.
|
| - * - "VIEW" : A VIEW.
|
| - * - "EDIT" : A EDIT.
|
| - * - "STUDENT_COPY" : A STUDENT_COPY.
|
| + * - "UNKNOWN_SHARE_MODE" : No sharing mode specified. This should never be
|
| + * returned.
|
| + * - "VIEW" : Students can view the shared file.
|
| + * - "EDIT" : Students can edit the shared file.
|
| + * - "STUDENT_COPY" : Students have a personal copy of the shared file.
|
| */
|
| core.String shareMode;
|
|
|
| @@ -4274,20 +4810,34 @@ class ShortAnswerSubmission {
|
|
|
| /** Student in a course. */
|
| class Student {
|
| - /** Identifier of the course. Read-only. */
|
| + /**
|
| + * Identifier of the course.
|
| + *
|
| + * Read-only.
|
| + */
|
| core.String courseId;
|
| - /** Global user information for the student. Read-only. */
|
| + /**
|
| + * Global user information for the student.
|
| + *
|
| + * Read-only.
|
| + */
|
| UserProfile profile;
|
| /**
|
| * Information about a Drive Folder for this student's work in this course.
|
| - * Only visible to the student and domain administrators. Read-only.
|
| + * Only visible to the student and domain administrators.
|
| + *
|
| + * Read-only.
|
| */
|
| DriveFolder studentWorkFolder;
|
| /**
|
| - * Identifier of the user. When specified as a parameter of a request, this
|
| - * identifier can be one of the following: * the numeric identifier for the
|
| - * user * the email address of the user * the string literal `"me"`,
|
| - * indicating the requesting user
|
| + * Identifier of the user.
|
| + *
|
| + * When specified as a parameter of a request, this identifier can be one of
|
| + * the following:
|
| + *
|
| + * * the numeric identifier for the user
|
| + * * the email address of the user
|
| + * * the string literal `"me"`, indicating the requesting user
|
| */
|
| core.String userId;
|
|
|
| @@ -4327,79 +4877,122 @@ class Student {
|
| }
|
|
|
| /**
|
| - * Student submission for course work. StudentSubmission items are generated
|
| - * when a CourseWork item is created. StudentSubmissions that have never been
|
| - * accessed (i.e. with `state` = NEW) may not have a creation time or update
|
| - * time.
|
| + * Student submission for course work.
|
| + *
|
| + * StudentSubmission items are generated when a CourseWork item is created.
|
| + *
|
| + * StudentSubmissions that have never been accessed (i.e. with `state` = NEW)
|
| + * may not have a creation time or update time.
|
| */
|
| class StudentSubmission {
|
| - /** Absolute link to the submission in the Classroom web UI. Read-only. */
|
| + /**
|
| + * Absolute link to the submission in the Classroom web UI.
|
| + *
|
| + * Read-only.
|
| + */
|
| core.String alternateLink;
|
| /**
|
| - * Optional grade. If unset, no grade was set. This must be a non-negative
|
| - * integer value. This may be modified only by course teachers.
|
| + * Optional grade. If unset, no grade was set.
|
| + * This must be a non-negative integer value.
|
| + *
|
| + * This may be modified only by course teachers.
|
| */
|
| core.double assignedGrade;
|
| /** Submission content when course_work_type is ASSIGNMENT . */
|
| AssignmentSubmission assignmentSubmission;
|
| /**
|
| * Whether this student submission is associated with the Developer Console
|
| - * project making the request. See google.classroom.Work.CreateCourseWork for
|
| - * more details. Read-only.
|
| + * project making the request.
|
| + *
|
| + * See google.classroom.Work.CreateCourseWork for more
|
| + * details.
|
| + *
|
| + * Read-only.
|
| */
|
| core.bool associatedWithDeveloper;
|
| - /** Identifier of the course. Read-only. */
|
| + /**
|
| + * Identifier of the course.
|
| + *
|
| + * Read-only.
|
| + */
|
| core.String courseId;
|
| - /** Identifier for the course work this corresponds to. Read-only. */
|
| + /**
|
| + * Identifier for the course work this corresponds to.
|
| + *
|
| + * Read-only.
|
| + */
|
| core.String courseWorkId;
|
| /**
|
| - * Type of course work this submission is for. Read-only.
|
| + * Type of course work this submission is for.
|
| + *
|
| + * Read-only.
|
| * Possible string values are:
|
| - * - "COURSE_WORK_TYPE_UNSPECIFIED" : A COURSE_WORK_TYPE_UNSPECIFIED.
|
| - * - "ASSIGNMENT" : A ASSIGNMENT.
|
| - * - "SHORT_ANSWER_QUESTION" : A SHORT_ANSWER_QUESTION.
|
| - * - "MULTIPLE_CHOICE_QUESTION" : A MULTIPLE_CHOICE_QUESTION.
|
| + * - "COURSE_WORK_TYPE_UNSPECIFIED" : No work type specified. This is never
|
| + * returned.
|
| + * - "ASSIGNMENT" : An assignment.
|
| + * - "SHORT_ANSWER_QUESTION" : A short answer question.
|
| + * - "MULTIPLE_CHOICE_QUESTION" : A multiple-choice question.
|
| */
|
| core.String courseWorkType;
|
| /**
|
| - * Creation time of this submission. This may be unset if the student has not
|
| - * accessed this item. Read-only.
|
| + * Creation time of this submission.
|
| + * This may be unset if the student has not accessed this item.
|
| + *
|
| + * Read-only.
|
| */
|
| core.String creationTime;
|
| /**
|
| - * Optional pending grade. If unset, no grade was set. This must be a
|
| - * non-negative integer value. This is only visible to and modifiable by
|
| - * course teachers.
|
| + * Optional pending grade. If unset, no grade was set.
|
| + * This must be a non-negative integer value.
|
| + *
|
| + * This is only visible to and modifiable by course teachers.
|
| */
|
| core.double draftGrade;
|
| /**
|
| - * Classroom-assigned Identifier for the student submission. This is unique
|
| - * among submissions for the relevant course work. Read-only.
|
| + * Classroom-assigned Identifier for the student submission.
|
| + * This is unique among submissions for the relevant course work.
|
| + *
|
| + * Read-only.
|
| */
|
| core.String id;
|
| - /** Whether this submission is late. Read-only. */
|
| + /**
|
| + * Whether this submission is late.
|
| + *
|
| + * Read-only.
|
| + */
|
| core.bool late;
|
| /** Submission content when course_work_type is MULTIPLE_CHOICE_QUESTION. */
|
| MultipleChoiceSubmission multipleChoiceSubmission;
|
| /** Submission content when course_work_type is SHORT_ANSWER_QUESTION. */
|
| ShortAnswerSubmission shortAnswerSubmission;
|
| /**
|
| - * State of this submission. Read-only.
|
| + * State of this submission.
|
| + *
|
| + * Read-only.
|
| * Possible string values are:
|
| - * - "SUBMISSION_STATE_UNSPECIFIED" : A SUBMISSION_STATE_UNSPECIFIED.
|
| - * - "NEW" : A NEW.
|
| - * - "CREATED" : A CREATED.
|
| - * - "TURNED_IN" : A TURNED_IN.
|
| - * - "RETURNED" : A RETURNED.
|
| - * - "RECLAIMED_BY_STUDENT" : A RECLAIMED_BY_STUDENT.
|
| + * - "SUBMISSION_STATE_UNSPECIFIED" : No state specified. This should never be
|
| + * returned.
|
| + * - "NEW" : The student has never accessed this submission. Attachments are
|
| + * not
|
| + * returned and timestamps is not set.
|
| + * - "CREATED" : Has been created.
|
| + * - "TURNED_IN" : Has been turned in to the teacher.
|
| + * - "RETURNED" : Has been returned to the student.
|
| + * - "RECLAIMED_BY_STUDENT" : Student chose to "unsubmit" the assignment.
|
| */
|
| core.String state;
|
| /**
|
| - * Last update time of this submission. This may be unset if the student has
|
| - * not accessed this item. Read-only.
|
| + * Last update time of this submission.
|
| + * This may be unset if the student has not accessed this item.
|
| + *
|
| + * Read-only.
|
| */
|
| core.String updateTime;
|
| - /** Identifier for the student that owns this submission. Read-only. */
|
| + /**
|
| + * Identifier for the student that owns this submission.
|
| + *
|
| + * Read-only.
|
| + */
|
| core.String userId;
|
|
|
| StudentSubmission();
|
| @@ -4511,15 +5104,27 @@ class StudentSubmission {
|
|
|
| /** Teacher of a course. */
|
| class Teacher {
|
| - /** Identifier of the course. Read-only. */
|
| + /**
|
| + * Identifier of the course.
|
| + *
|
| + * Read-only.
|
| + */
|
| core.String courseId;
|
| - /** Global user information for the teacher. Read-only. */
|
| + /**
|
| + * Global user information for the teacher.
|
| + *
|
| + * Read-only.
|
| + */
|
| UserProfile profile;
|
| /**
|
| - * Identifier of the user. When specified as a parameter of a request, this
|
| - * identifier can be one of the following: * the numeric identifier for the
|
| - * user * the email address of the user * the string literal `"me"`,
|
| - * indicating the requesting user
|
| + * Identifier of the user.
|
| + *
|
| + * When specified as a parameter of a request, this identifier can be one of
|
| + * the following:
|
| + *
|
| + * * the numeric identifier for the user
|
| + * * the email address of the user
|
| + * * the string literal `"me"`, indicating the requesting user
|
| */
|
| core.String userId;
|
|
|
| @@ -4554,7 +5159,7 @@ class Teacher {
|
|
|
| /**
|
| * Represents a time of day. The date and time zone are either not significant
|
| - * or are specified elsewhere. An API may chose to allow leap seconds. Related
|
| + * or are specified elsewhere. An API may choose to allow leap seconds. Related
|
| * types are google.type.Date and `google.protobuf.Timestamp`.
|
| */
|
| class TimeOfDay {
|
| @@ -4624,15 +5229,35 @@ class TurnInStudentSubmissionRequest {
|
|
|
| /** Global information for a user. */
|
| class UserProfile {
|
| - /** Email address of the user. Read-only. */
|
| + /**
|
| + * Email address of the user.
|
| + *
|
| + * Read-only.
|
| + */
|
| core.String emailAddress;
|
| - /** Identifier of the user. Read-only. */
|
| + /**
|
| + * Identifier of the user.
|
| + *
|
| + * Read-only.
|
| + */
|
| core.String id;
|
| - /** Name of the user. Read-only. */
|
| + /**
|
| + * Name of the user.
|
| + *
|
| + * Read-only.
|
| + */
|
| Name name;
|
| - /** Global permissions of the user. Read-only. */
|
| + /**
|
| + * Global permissions of the user.
|
| + *
|
| + * Read-only.
|
| + */
|
| core.List<GlobalPermission> permissions;
|
| - /** URL of user's profile photo. Read-only. */
|
| + /**
|
| + * URL of user's profile photo.
|
| + *
|
| + * Read-only.
|
| + */
|
| core.String photoUrl;
|
|
|
| UserProfile();
|
| @@ -4678,13 +5303,25 @@ class UserProfile {
|
|
|
| /** YouTube video item. */
|
| class YouTubeVideo {
|
| - /** URL that can be used to view the YouTube video. Read-only. */
|
| + /**
|
| + * URL that can be used to view the YouTube video.
|
| + *
|
| + * Read-only.
|
| + */
|
| core.String alternateLink;
|
| /** YouTube API resource ID. */
|
| core.String id;
|
| - /** URL of a thumbnail image of the YouTube video. Read-only. */
|
| + /**
|
| + * URL of a thumbnail image of the YouTube video.
|
| + *
|
| + * Read-only.
|
| + */
|
| core.String thumbnailUrl;
|
| - /** Title of the YouTube video. Read-only. */
|
| + /**
|
| + * Title of the YouTube video.
|
| + *
|
| + * Read-only.
|
| + */
|
| core.String title;
|
|
|
| YouTubeVideo();
|
|
|
Chromium Code Reviews
Issue 2779563003:
Api-roll 47: 2017-03-27 (Closed)
