Google_Service_Classroom_CoursesTeachers_Resource Class Reference

The "teachers" collection of methods. More...

Inheritance diagram for Google_Service_Classroom_CoursesTeachers_Resource:

Public Member Functions
	call ($name, $arguments, $expected_class=null)
	TODO: This function needs simplifying.
	create ($courseId, Google_Service_Classroom_Teacher $postBody, $optParams=array())
	Creates a teacher of a course.
	delete ($courseId, $userId, $optParams=array())
	Deletes a teacher of a course.
	get ($courseId, $userId, $optParams=array())
	Returns a teacher of a course.
	listCoursesTeachers ($courseId, $optParams=array())
	Returns a list of teachers of this course that the requester is permitted to view.

Protected Member Functions
	convertToArrayAndStripNulls ($o)

Detailed Description

The "teachers" collection of methods.

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

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_CoursesTeachers_Resource::create	(		$courseId,
		Google_Service_Classroom_Teacher	$postBody,
			$optParams = array() )

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. (teachers.create)

Parameters

string	$courseId	Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
Google_Teacher	$postBody
array	$optParams	Optional parameters.

Return values

Google_Service_Classroom_Teacher

delete()

Google_Service_Classroom_CoursesTeachers_Resource::delete	(		$courseId,
			$userId,
			$optParams = array() )

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. (teachers.delete)

Parameters

string	$courseId	Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
string	$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
array	$optParams	Optional parameters.

Return values

Google_Service_Classroom_Empty

get()

Google_Service_Classroom_CoursesTeachers_Resource::get	(		$courseId,
			$userId,
			$optParams = array() )

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. (teachers.get)

Parameters

string	$courseId	Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
string	$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
array	$optParams	Optional parameters.

Return values

Google_Service_Classroom_Teacher

listCoursesTeachers()

Google_Service_Classroom_CoursesTeachers_Resource::listCoursesTeachers	(		$courseId,
			$optParams = array() )

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. (teachers.listCoursesTeachers)

Parameters

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

@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 int pageSize Maximum number of items to return. Zero means no maximum. The server may return fewer than the specified number of results.

Return values

Google_Service_Classroom_ListTeachersResponse

---

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

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