1. class
  2. Google
  3. \
  4. Service
  5. \
  6. Classroom
  7. \
  8. Resource
  9. \
  10. CoursesTeachers

CoursesTeachers

class CoursesTeachers extends Resource (View source)

The "teachers" collection of methods.

Typical usage is:

 $classroomService = new Google\Service\Classroom(...);
 $teachers = $classroomService->courses_teachers;

Methods

Teacher
create(string $courseId, Teacher $postBody, array $optParams = [])

Creates a teacher of a course. Domain administrators are permitted to directly add users within their domain as teachers to courses within their domain. Non- admin users should send an Invitation instead. 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 InactiveCourseOwner * ALREADY_EXISTS if the user is already a teacher or student in the course. (teachers.create)

ClassroomEmpty
delete(string $courseId, string $userId, array $optParams = [])

Removes the specified teacher from the specified 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. FAILED_PRECONDITION if the requested ID belongs to the owner of the course Drive folder. * FAILED_PRECONDITION if the course no longer has an active owner. (teachers.delete)

Teacher
get(string $courseId, string $userId, array $optParams = [])

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.

ListTeachersResponse
listCoursesTeachers(string $courseId, array $optParams = [])

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.

Details

at line 55
Teacher create(string $courseId, Teacher $postBody, array $optParams = [])

Creates a teacher of a course. Domain administrators are permitted to directly add users within their domain as teachers to courses within their domain. Non- admin users should send an Invitation instead. 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 InactiveCourseOwner * 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.
Teacher $postBody
array $optParams

Optional parameters.

Return Value

Teacher

Exceptions

Exception

at line 81
ClassroomEmpty delete(string $courseId, string $userId, array $optParams = [])

Removes the specified teacher from the specified 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. FAILED_PRECONDITION if the requested ID belongs to the owner of the course Drive folder. * FAILED_PRECONDITION if the course no longer has an active owner. (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 Value

ClassroomEmpty

Exceptions

Exception

at line 104
Teacher get(string $courseId, string $userId, array $optParams = [])

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 Value

Teacher

Exceptions

Exception

at line 130
ListTeachersResponse listCoursesTeachers(string $courseId, array $optParams = [])

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.

Return Value

ListTeachersResponse

Exceptions

Exception