Search moodle.org's
Developer Documentation
Developer Documentation
See Release Notes
Long Term Support Release
- Bug fixes for general core bugs in 4.1.x will end 13 November 2023 (12 months).
- Bug fixes for security issues in 4.1.x will end 10 November 2025 (36 months).
- PHP version: minimum PHP 7.4.0 Note: minimum PHP version has increased since Moodle 4.0. PHP 8.0.x is supported too.
/lib/google/src/Google/Service/ -> Classroom.php (source)
Differences Between: [Versions 401 and 402] [Versions 401 and 403]
(no description)
| File Size: | 1533 lines (51 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
Defines 21 classes
Google_Service_Classroom:: (1 method):
__construct()
Google_Service_Classroom_Courses_Resource:: (6 methods):
create()
delete()
get()
listCourses()
patch()
update()
Google_Service_Classroom_CoursesAliases_Resource:: (3 methods):
create()
delete()
listCoursesAliases()
Google_Service_Classroom_CoursesStudents_Resource:: (4 methods):
create()
delete()
get()
listCoursesStudents()
Google_Service_Classroom_CoursesTeachers_Resource:: (4 methods):
create()
delete()
get()
listCoursesTeachers()
Google_Service_Classroom_Invitations_Resource:: (5 methods):
accept()
create()
delete()
get()
listInvitations()
Google_Service_Classroom_UserProfiles_Resource:: (1 method):
get()
Google_Service_Classroom_Course:: (24 methods):
setAlternateLink()
getAlternateLink()
setCourseState()
getCourseState()
setCreationTime()
getCreationTime()
setDescription()
getDescription()
setDescriptionHeading()
getDescriptionHeading()
setEnrollmentCode()
getEnrollmentCode()
setId()
getId()
setName()
getName()
setOwnerId()
getOwnerId()
setRoom()
getRoom()
setSection()
getSection()
setUpdateTime()
getUpdateTime()
Google_Service_Classroom_CourseAlias:: (2 methods):
setAlias()
getAlias()
Google_Service_Classroom_Empty:: (0 methods):
Google_Service_Classroom_GlobalPermission:: (2 methods):
setPermission()
getPermission()
Google_Service_Classroom_Invitation:: (8 methods):
setCourseId()
getCourseId()
setId()
getId()
setRole()
getRole()
setUserId()
getUserId()
Google_Service_Classroom_ListCourseAliasesResponse:: (4 methods):
setAliases()
getAliases()
setNextPageToken()
getNextPageToken()
Google_Service_Classroom_ListCoursesResponse:: (4 methods):
setCourses()
getCourses()
setNextPageToken()
getNextPageToken()
Google_Service_Classroom_ListInvitationsResponse:: (4 methods):
setInvitations()
getInvitations()
setNextPageToken()
getNextPageToken()
Google_Service_Classroom_ListStudentsResponse:: (4 methods):
setNextPageToken()
getNextPageToken()
setStudents()
getStudents()
Google_Service_Classroom_ListTeachersResponse:: (4 methods):
setNextPageToken()
getNextPageToken()
setTeachers()
getTeachers()
Google_Service_Classroom_Name:: (6 methods):
setFamilyName()
getFamilyName()
setFullName()
getFullName()
setGivenName()
getGivenName()
Google_Service_Classroom_Student:: (6 methods):
setCourseId()
getCourseId()
setProfile()
getProfile()
setUserId()
getUserId()
Google_Service_Classroom_Teacher:: (6 methods):
setCourseId()
getCourseId()
setProfile()
getProfile()
setUserId()
getUserId()
Google_Service_Classroom_UserProfile:: (10 methods):
setEmailAddress()
getEmailAddress()
setId()
getId()
setName()
getName()
setPermissions()
getPermissions()
setPhotoUrl()
getPhotoUrl()
Class: Google_Service_Classroom - X-Ref
Service definition for Classroom (v1).<p>
Google Classroom API</p>
<p>
For more information about this service, see the API
<a href="https://developers.google.com/classroom/" target="_blank">Documentation</a>
</p>
| __construct(Google_Client $client) X-Ref |
| Constructs the internal representation of the Classroom service. param: Google_Client $client |
Class: Google_Service_Classroom_Courses_Resource - X-Ref
The "courses" collection of methods.Typical usage is:
<code>
$classroomService = new Google_Service_Classroom(...);
$courses = $classroomService->courses;
</code>
| create(Google_Service_Classroom_Course $postBody, $optParams = array() X-Ref |
| 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) param: Google_Course $postBody param: array $optParams Optional parameters. return: Google_Service_Classroom_Course |
| delete($id, $optParams = array() X-Ref |
| 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) param: string $id Identifier of the course to delete. This identifier can be param: array $optParams Optional parameters. return: Google_Service_Classroom_Empty |
| get($id, $optParams = array() X-Ref |
| 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) param: string $id Identifier of the course to return. This identifier can be param: array $optParams Optional parameters. return: Google_Service_Classroom_Course |
| listCourses($optParams = array() X-Ref |
| 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) param: array $optParams Optional parameters. return: Google_Service_Classroom_ListCoursesResponse |
| patch($id, Google_Service_Classroom_Course $postBody, $optParams = array() X-Ref |
| 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) param: string $id Identifier of the course to update. This identifier can be param: Google_Course $postBody param: array $optParams Optional parameters. return: Google_Service_Classroom_Course |
| update($id, Google_Service_Classroom_Course $postBody, $optParams = array() X-Ref |
| 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) param: string $id Identifier of the course to update. This identifier can be param: Google_Course $postBody param: array $optParams Optional parameters. return: Google_Service_Classroom_Course |
Class: Google_Service_Classroom_CoursesAliases_Resource - X-Ref
The "aliases" collection of methods.Typical usage is:
<code>
$classroomService = new Google_Service_Classroom(...);
$aliases = $classroomService->aliases;
</code>
| create($courseId, Google_Service_Classroom_CourseAlias $postBody, $optParams = array() X-Ref |
| 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. (aliases.create) param: string $courseId Identifier of the course to alias. This identifier param: Google_CourseAlias $postBody param: array $optParams Optional parameters. return: Google_Service_Classroom_CourseAlias |
| delete($courseId, $alias, $optParams = array() X-Ref |
| 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. (aliases.delete) param: string $courseId Identifier of the course whose alias should be param: string $alias Alias to delete. This may not be the Classroom-assigned param: array $optParams Optional parameters. return: Google_Service_Classroom_Empty |
| listCoursesAliases($courseId, $optParams = array() X-Ref |
| 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. (aliases.listCoursesAliases) param: string $courseId The identifier of the course. This identifier can be param: array $optParams Optional parameters. return: Google_Service_Classroom_ListCourseAliasesResponse |
Class: Google_Service_Classroom_CoursesStudents_Resource - X-Ref
The "students" collection of methods.Typical usage is:
<code>
$classroomService = new Google_Service_Classroom(...);
$students = $classroomService->students;
</code>
| create($courseId, Google_Service_Classroom_Student $postBody, $optParams = array() X-Ref |
| 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. (students.create) param: string $courseId Identifier of the course to create the student in. param: Google_Student $postBody param: array $optParams Optional parameters. return: Google_Service_Classroom_Student |
| delete($courseId, $userId, $optParams = array() X-Ref |
| 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. (students.delete) param: string $courseId Identifier of the course. This identifier can be param: string $userId Identifier of the student to delete. The identifier can param: array $optParams Optional parameters. return: Google_Service_Classroom_Empty |
| get($courseId, $userId, $optParams = array() X-Ref |
| 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. (students.get) param: string $courseId Identifier of the course. This identifier can be param: string $userId Identifier of the student to return. The identifier can param: array $optParams Optional parameters. return: Google_Service_Classroom_Student |
| listCoursesStudents($courseId, $optParams = array() X-Ref |
| 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. (students.listCoursesStudents) param: string $courseId Identifier of the course. This identifier can be param: array $optParams Optional parameters. return: Google_Service_Classroom_ListStudentsResponse |
Class: Google_Service_Classroom_CoursesTeachers_Resource - X-Ref
The "teachers" collection of methods.Typical usage is:
<code>
$classroomService = new Google_Service_Classroom(...);
$teachers = $classroomService->teachers;
</code>
| create($courseId, Google_Service_Classroom_Teacher $postBody, $optParams = array() X-Ref |
| 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) param: string $courseId Identifier of the course. This identifier can be param: Google_Teacher $postBody param: array $optParams Optional parameters. return: Google_Service_Classroom_Teacher |
| delete($courseId, $userId, $optParams = array() X-Ref |
| 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) param: string $courseId Identifier of the course. This identifier can be param: string $userId Identifier of the teacher to delete. The identifier can param: array $optParams Optional parameters. return: Google_Service_Classroom_Empty |
| get($courseId, $userId, $optParams = array() X-Ref |
| 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) param: string $courseId Identifier of the course. This identifier can be param: string $userId Identifier of the teacher to return. The identifier can param: array $optParams Optional parameters. return: Google_Service_Classroom_Teacher |
| listCoursesTeachers($courseId, $optParams = array() X-Ref |
| 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) param: string $courseId Identifier of the course. This identifier can be param: array $optParams Optional parameters. return: Google_Service_Classroom_ListTeachersResponse |
Class: Google_Service_Classroom_Invitations_Resource - X-Ref
The "invitations" collection of methods.Typical usage is:
<code>
$classroomService = new Google_Service_Classroom(...);
$invitations = $classroomService->invitations;
</code>
| accept($id, $optParams = array() X-Ref |
| 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. (invitations.accept) param: string $id Identifier of the invitation to accept. param: array $optParams Optional parameters. return: Google_Service_Classroom_Empty |
| create(Google_Service_Classroom_Invitation $postBody, $optParams = array() X-Ref |
| 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. (invitations.create) param: Google_Invitation $postBody param: array $optParams Optional parameters. return: Google_Service_Classroom_Invitation |
| delete($id, $optParams = array() X-Ref |
| 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. (invitations.delete) param: string $id Identifier of the invitation to delete. param: array $optParams Optional parameters. return: Google_Service_Classroom_Empty |
| get($id, $optParams = array() X-Ref |
| 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. (invitations.get) param: string $id Identifier of the invitation to return. param: array $optParams Optional parameters. return: Google_Service_Classroom_Invitation |
| listInvitations($optParams = array() X-Ref |
| 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. (invitations.listInvitations) param: array $optParams Optional parameters. return: Google_Service_Classroom_ListInvitationsResponse |
Class: Google_Service_Classroom_UserProfiles_Resource - X-Ref
The "userProfiles" collection of methods.Typical usage is:
<code>
$classroomService = new Google_Service_Classroom(...);
$userProfiles = $classroomService->userProfiles;
</code>
| get($userId, $optParams = array() X-Ref |
| 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 or if no profile exists with the requested ID or for access errors. (userProfiles.get) param: string $userId Identifier of the profile to return. The identifier can param: array $optParams Optional parameters. return: Google_Service_Classroom_UserProfile |
Class: Google_Service_Classroom_Course - X-Ref
| setAlternateLink($alternateLink) X-Ref |
| No description |
| getAlternateLink() X-Ref |
| No description |
| setCourseState($courseState) X-Ref |
| No description |
| getCourseState() X-Ref |
| No description |
| setCreationTime($creationTime) X-Ref |
| No description |
| getCreationTime() X-Ref |
| No description |
| setDescription($description) X-Ref |
| No description |
| getDescription() X-Ref |
| No description |
| setDescriptionHeading($descriptionHeading) X-Ref |
| No description |
| getDescriptionHeading() X-Ref |
| No description |
| setEnrollmentCode($enrollmentCode) X-Ref |
| No description |
| getEnrollmentCode() X-Ref |
| No description |
| setId($id) X-Ref |
| No description |
| getId() X-Ref |
| No description |
| setName($name) X-Ref |
| No description |
| getName() X-Ref |
| No description |
| setOwnerId($ownerId) X-Ref |
| No description |
| getOwnerId() X-Ref |
| No description |
| setRoom($room) X-Ref |
| No description |
| getRoom() X-Ref |
| No description |
| setSection($section) X-Ref |
| No description |
| getSection() X-Ref |
| No description |
| setUpdateTime($updateTime) X-Ref |
| No description |
| getUpdateTime() X-Ref |
| No description |
Class: Google_Service_Classroom_Empty - X-Ref
Class: Google_Service_Classroom_Invitation - X-Ref
Class: Google_Service_Classroom_ListCourseAliasesResponse - X-Ref
| setAliases($aliases) X-Ref |
| No description |
| getAliases() X-Ref |
| No description |
| setNextPageToken($nextPageToken) X-Ref |
| No description |
| getNextPageToken() X-Ref |
| No description |
Class: Google_Service_Classroom_ListCoursesResponse - X-Ref
| setCourses($courses) X-Ref |
| No description |
| getCourses() X-Ref |
| No description |
| setNextPageToken($nextPageToken) X-Ref |
| No description |
| getNextPageToken() X-Ref |
| No description |
Class: Google_Service_Classroom_ListInvitationsResponse - X-Ref
| setInvitations($invitations) X-Ref |
| No description |
| getInvitations() X-Ref |
| No description |
| setNextPageToken($nextPageToken) X-Ref |
| No description |
| getNextPageToken() X-Ref |
| No description |
Class: Google_Service_Classroom_ListStudentsResponse - X-Ref
| setNextPageToken($nextPageToken) X-Ref |
| No description |
| getNextPageToken() X-Ref |
| No description |
| setStudents($students) X-Ref |
| No description |
| getStudents() X-Ref |
| No description |
Class: Google_Service_Classroom_ListTeachersResponse - X-Ref
| setNextPageToken($nextPageToken) X-Ref |
| No description |
| getNextPageToken() X-Ref |
| No description |
| setTeachers($teachers) X-Ref |
| No description |
| getTeachers() X-Ref |
| No description |
Class: Google_Service_Classroom_Name - X-Ref
| setFamilyName($familyName) X-Ref |
| No description |
| getFamilyName() X-Ref |
| No description |
| setFullName($fullName) X-Ref |
| No description |
| getFullName() X-Ref |
| No description |
| setGivenName($givenName) X-Ref |
| No description |
| getGivenName() X-Ref |
| No description |
Class: Google_Service_Classroom_Student - X-Ref
| setCourseId($courseId) X-Ref |
| No description |
| getCourseId() X-Ref |
| No description |
| setProfile(Google_Service_Classroom_UserProfile $profile) X-Ref |
| No description |
| getProfile() X-Ref |
| No description |
| setUserId($userId) X-Ref |
| No description |
| getUserId() X-Ref |
| No description |
Class: Google_Service_Classroom_Teacher - X-Ref
| setCourseId($courseId) X-Ref |
| No description |
| getCourseId() X-Ref |
| No description |
| setProfile(Google_Service_Classroom_UserProfile $profile) X-Ref |
| No description |
| getProfile() X-Ref |
| No description |
| setUserId($userId) X-Ref |
| No description |
| getUserId() X-Ref |
| No description |
Class: Google_Service_Classroom_UserProfile - X-Ref
| setEmailAddress($emailAddress) X-Ref |
| No description |
| getEmailAddress() X-Ref |
| No description |
| setId($id) X-Ref |
| No description |
| getId() X-Ref |
| No description |
| setName(Google_Service_Classroom_Name $name) X-Ref |
| No description |
| getName() X-Ref |
| No description |
| setPermissions($permissions) X-Ref |
| No description |
| getPermissions() X-Ref |
| No description |
| setPhotoUrl($photoUrl) X-Ref |
| No description |
| getPhotoUrl() X-Ref |
| No description |
