Documentation

Google_Service_Classroom_Resource_CoursesStudents extends Google_Service_Resource
in package

Application

The "students" collection of methods.

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

$client : Google_Client
$methods : array<string|int, mixed>
$resourceName : string
$rootUrl : string
$serviceName : string
$servicePath : string
$stackParameters : mixed
__construct() : mixed
call() : Google_Http_Request|expectedClass: TODO: This function needs simplifying.
create() : Google_Service_Classroom_Student: 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)
createRequestUri() : string: Parse/expand request parameters and create a fully qualified request uri.
delete() : Google_Service_Classroom_ClassroomEmpty: 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.
get() : Google_Service_Classroom_Student: 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.
listCoursesStudents() : Google_Service_Classroom_ListStudentsResponse: 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.
convertToArrayAndStripNulls() : mixed

$client


    private
        Google_Client
    $client

$methods


    private
        array<string|int, mixed>
    $methods

$resourceName


    private
        string
    $resourceName

$rootUrl


    private
        string
    $rootUrl

$serviceName


    private
        string
    $serviceName

$servicePath


    private
        string
    $servicePath

$stackParameters


    private
        mixed
    $stackParameters
     = array('alt' => array('type' => 'string', 'location' => 'query'), 'fields' => array('type' => 'string', 'location' => 'query'), 'trace' => array('type' => 'string', 'location' => 'query'), 'userIp' => array('type' => 'string', 'location' => 'query'), 'quotaUser' => array('type' => 'string', 'location' => 'query'), 'data' => array('type' => 'string', 'location' => 'body'), 'mimeType' => array('type' => 'string', 'location' => 'header'), 'uploadType' => array('type' => 'string', 'location' => 'query'), 'mediaUpload' => array('type' => 'complex', 'location' => 'query'), 'prettyPrint' => array('type' => 'string', 'location' => 'query'))

__construct()


    public
                __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed

Parameters

$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed

Return values

mixed —

call()

TODO: This function needs simplifying.


    public
                call( $name,  $arguments[,  $expectedClass = null ]) : Google_Http_Request|expectedClass

Parameters

$name :

$arguments :

$expectedClass : = null

optional, the expected class name

Return values

Google_Http_Request|expectedClass —

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)


    public
                create(string $courseId, Google_Service_Classroom_Student $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Classroom_Student

Parameters

$courseId : string: Identifier of the course to create the student in. This identifier can be either the Classroom-assigned identifier or an alias.
$postBody : Google_Service_Classroom_Student
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Classroom_Student —

createRequestUri()

Parse/expand request parameters and create a fully qualified request uri.


    public
                createRequestUri(string $restPath, array<string|int, mixed> $params) : string

Parameters

$restPath : string
$params : array<string|int, mixed>

Return values

string —

$requestUrl

delete()

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.


    public
                delete(string $courseId, string $userId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Classroom_ClassroomEmpty

(students.delete)

Parameters

$courseId : string: Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
$userId : string: 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
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Classroom_ClassroomEmpty —

get()

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.


    public
                get(string $courseId, string $userId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Classroom_Student

(students.get)

Parameters

$courseId : string: Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
$userId : string: 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
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Classroom_Student —

listCoursesStudents()

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.


    public
                listCoursesStudents(string $courseId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Classroom_ListStudentsResponse

(students.listCoursesStudents)

Parameters

$courseId : string: Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Classroom_ListStudentsResponse —

convertToArrayAndStripNulls()


    protected
                convertToArrayAndStripNulls(mixed $o) : mixed

Parameters

$o : mixed

Return values

mixed —