The "students" collection of methods.
More...
|
| call ($name, $arguments, $expected_class=null) |
| TODO: This function needs simplifying.
|
|
| create ($courseId, Google_Service_Classroom_Student $postBody, $optParams=array()) |
| Adds a user as a student of a course.
|
|
| delete ($courseId, $userId, $optParams=array()) |
| Deletes a student of a course.
|
|
| get ($courseId, $userId, $optParams=array()) |
| Returns a student of a course.
|
|
| listCoursesStudents ($courseId, $optParams=array()) |
| Returns a list of students of this course that the requester is permitted to view.
|
|
|
| convertToArrayAndStripNulls ($o) |
|
The "students" collection of methods.
Typical usage is: $classroomService = new Google_Service_Classroom(...); $students = $classroomService->students;
◆ 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
-
◆ create()
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)
- Parameters
-
string | $courseId | Identifier of the course to create the student in. This identifier can be either the Classroom-assigned identifier or an alias. |
Google_Student | $postBody | |
array | $optParams | Optional parameters. |
@opt_param string enrollmentCode Enrollment code of the course to create the student in. This code is required if userId corresponds to the requesting user; it may be omitted if the requesting user has administrative permissions to create students for any user.
- Return values
-
◆ delete()
Google_Service_Classroom_CoursesStudents_Resource::delete |
( |
| $courseId, |
|
|
| $userId, |
|
|
| $optParams = array() ) |
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)
- Parameters
-
string | $courseId | Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. |
string | $userId | Identifier of the student 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
-
◆ get()
Google_Service_Classroom_CoursesStudents_Resource::get |
( |
| $courseId, |
|
|
| $userId, |
|
|
| $optParams = array() ) |
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)
- Parameters
-
string | $courseId | Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. |
string | $userId | Identifier of the student 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
-
◆ listCoursesStudents()
Google_Service_Classroom_CoursesStudents_Resource::listCoursesStudents |
( |
| $courseId, |
|
|
| $optParams = array() ) |
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)
- 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
-
The documentation for this class was generated from the following file:
- lib/google/src/Google/Service/Classroom.php