Class Google_Service_Classroom_Courses_Resource
The "courses" collection of methods. Typical usage is:
$classroomService = new Google_Service_Classroom(...);
$courses = $classroomService->courses;
-
Google_Service_Resource
-
Google_Service_Classroom_Courses_Resource
Located at Classroom.php
Methods summary
public
Google_Service_Classroom_Course
|
#
create( Google_Service_Classroom_Course $postBody, array $optParams = array() )
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. (courses.create)
Parameters
- $postBody
- $optParams
- Optional parameters.
Returns
|
public
Google_Service_Classroom_ClassroomEmpty
|
#
delete( string $id, array $optParams = array() )
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. (courses.delete)
Parameters
- $id
- Identifier of the course to delete. This identifier can be either the
Classroom-assigned identifier or an alias.
- $optParams
- Optional parameters.
Returns
|
public
Google_Service_Classroom_Course
|
#
get( string $id, array $optParams = array() )
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. (courses.get)
Parameters
- $id
- Identifier of the course to return. This identifier can be either the
Classroom-assigned identifier or an alias.
- $optParams
- Optional parameters.
Returns
|
public
Google_Service_Classroom_ListCoursesResponse
|
#
listCourses( array $optParams = array() )
Returns a list of courses that the requesting user is permitted to view,
restricted to those that match the request. Returned courses are ordered by
creation time, with the most recently created coming first.
Returns a list of courses that the requesting user is permitted to view,
restricted to those that match the request. Returned courses are ordered by
creation time, with the most recently created coming first.
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. (courses.listCourses)
Parameters
- $optParams
- Optional parameters.
Returns
Opt_param
int 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.
string 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
string courseStates Restricts returned courses to those in one of the specified
states The default value is ACTIVE, ARCHIVED, PROVISIONED, DECLINED.
string 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
string 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.
|
public
Google_Service_Classroom_Course
|
#
patch( string $id, Google_Service_Classroom_Course $postBody, array $optParams = array() )
Updates one or more fields in a course.
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 (courses.patch)
Parameters
- $id
- Identifier of the course to update. This identifier can be either the
Classroom-assigned identifier or an alias.
- $postBody
- $optParams
- Optional parameters.
Returns
Opt_param
string 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 *
ownerId Note: patches to ownerId are treated as being effective
immediately, but in practice it may take some time for the ownership transfer of
all affected resources to complete. When set in a query parameter, this field
should be specified as updateMask=,,...
|
public
Google_Service_Classroom_Course
|
#
update( string $id, Google_Service_Classroom_Course $postBody, array $optParams = array() )
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 (courses.update)
Parameters
- $id
- Identifier of the course to update. This identifier can be either the
Classroom-assigned identifier or an alias.
- $postBody
- $optParams
- Optional parameters.
Returns
|