Google_Service_Classroom_Courses_Resource Class Reference

The "courses" collection of methods. More...

Inheritance diagram for Google_Service_Classroom_Courses_Resource:

Public Member Functions
	call ($name, $arguments, $expected_class=null)
	TODO: This function needs simplifying.
	create (Google_Service_Classroom_Course $postBody, $optParams=array())
	Creates a course.
	delete ($id, $optParams=array())
	Deletes a course.
	get ($id, $optParams=array())
	Returns a course.
	listCourses ($optParams=array())
	Returns a list of courses that the requesting user is permitted to view, restricted to those that match the request.
	patch ($id, Google_Service_Classroom_Course $postBody, $optParams=array())
	Updates one or more fields in a course.
	update ($id, Google_Service_Classroom_Course $postBody, $optParams=array())
	Updates a course.

Protected Member Functions
	convertToArrayAndStripNulls ($o)

Detailed Description

The "courses" collection of methods.

Typical usage is: $classroomService = new Google_Service_Classroom(...); $courses = $classroomService->courses;

Member Function Documentation

call()

Google_Service_Resource::call ( $name, $arguments, $expected_class = null )

inherited

TODO: This function needs simplifying.

Parameters

$name
$arguments
$expected_class	- optional, the expected class name

Return values

Google_Http_Request|expected_class

Exceptions

Google_Exception

create()

Google_Service_Classroom_Courses_Resource::create	(	Google_Service_Classroom_Course	$postBody,
			$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

Google_Course	$postBody
array	$optParams	Optional parameters.

Return values

Google_Service_Classroom_Course

delete()

Google_Service_Classroom_Courses_Resource::delete	(		$id,
			$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

string	$id	Identifier of the course to delete. This identifier can be either the Classroom-assigned identifier or an alias.
array	$optParams	Optional parameters.

Return values

Google_Service_Classroom_Empty

get()

Google_Service_Classroom_Courses_Resource::get	(		$id,
			$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

string	$id	Identifier of the course to return. This identifier can be either the Classroom-assigned identifier or an alias.
array	$optParams	Optional parameters.

Return values

Google_Service_Classroom_Course

listCourses()

Google_Service_Classroom_Courses_Resource::listCourses

(

$optParams = array()

)

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. (courses.listCourses)

Parameters

array

$optParams

Optional parameters.

@opt_param 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 @opt_param 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. @opt_param 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 @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.

Return values

Google_Service_Classroom_ListCoursesResponse

patch()

Google_Service_Classroom_Courses_Resource::patch	(		$id,
		Google_Service_Classroom_Course	$postBody,
			$optParams = array() )

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

string	$id	Identifier of the course to update. This identifier can be either the Classroom-assigned identifier or an alias.
Google_Course	$postBody
array	$optParams	Optional parameters.

@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 When set in a query parameter, this field should be specified as updateMask=,,...

Return values

Google_Service_Classroom_Course

update()

Google_Service_Classroom_Courses_Resource::update	(		$id,
		Google_Service_Classroom_Course	$postBody,
			$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

string	$id	Identifier of the course to update. This identifier can be either the Classroom-assigned identifier or an alias.
Google_Course	$postBody
array	$optParams	Optional parameters.

Return values

Google_Service_Classroom_Course

---

The documentation for this class was generated from the following file:

• lib/google/src/Google/Service/Classroom.php