Documentation

Google_Service_Classroom_Resource_CoursesCourseWorkMaterials extends Google_Service_Resource
in package

The "courseWorkMaterials" collection of methods.

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

Table of Contents

$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_CourseWorkMaterial
Creates a course work material. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course, create course work material in the requested course, share a Drive attachment, or for access errors. * `INVALID_ARGUMENT` if the request is malformed or if more than 20 * materials are provided. * `NOT_FOUND` if the requested course does not exist. * `FAILED_PRECONDITION` for the following request error: * AttachmentNotVisible (courseWorkMaterials.create)
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
delete()  : Google_Service_Classroom_ClassroomEmpty
Deletes a course work material. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work material item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project did not create the corresponding course work material, if the requesting user is not permitted to delete the requested course or for access errors. * `FAILED_PRECONDITION` if the requested course work material has already been deleted. * `NOT_FOUND` if no course exists with the requested ID.
get()  : Google_Service_Classroom_CourseWorkMaterial
Returns a course work material. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work material, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course or course work material does not exist.
listCoursesCourseWorkMaterials()  : Google_Service_Classroom_ListCourseWorkMaterialResponse
Returns a list of course work material that the requester is permitted to view. Course students may only view `PUBLISHED` course work material. Course teachers and domain administrators may view all course work material. 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. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist.
patch()  : Google_Service_Classroom_CourseWorkMaterial
Updates one or more fields of a course work material. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project for access errors. * `INVALID_ARGUMENT` if the request is malformed.
convertToArrayAndStripNulls()  : mixed

Properties

$methods

private array<string|int, mixed> $methods

$resourceName

private string $resourceName

$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'))

Methods

__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
Tags
throws
Google_Exception
Return values
Google_Http_Request|expectedClass —

create()

Creates a course work material. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course, create course work material in the requested course, share a Drive attachment, or for access errors. * `INVALID_ARGUMENT` if the request is malformed or if more than 20 * materials are provided. * `NOT_FOUND` if the requested course does not exist. * `FAILED_PRECONDITION` for the following request error: * AttachmentNotVisible (courseWorkMaterials.create)

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

Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.

$postBody : Google_Service_Classroom_CourseWorkMaterial
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_Classroom_CourseWorkMaterial —

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>
Tags
static
Return values
string —

$requestUrl

delete()

Deletes a course work material. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work material item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project did not create the corresponding course work material, if the requesting user is not permitted to delete the requested course or for access errors. * `FAILED_PRECONDITION` if the requested course work material has already been deleted. * `NOT_FOUND` if no course exists with the requested ID.

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

(courseWorkMaterials.delete)

Parameters
$courseId : string

Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.

$id : string

Identifier of the course work material to delete. This identifier is a Classroom-assigned identifier.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_Classroom_ClassroomEmpty —

get()

Returns a course work material. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work material, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course or course work material does not exist.

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

(courseWorkMaterials.get)

Parameters
$courseId : string

Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.

$id : string

Identifier of the course work material.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_Classroom_CourseWorkMaterial —

listCoursesCourseWorkMaterials()

Returns a list of course work material that the requester is permitted to view. Course students may only view `PUBLISHED` course work material. Course teachers and domain administrators may view all course work material. 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. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist.

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

(courseWorkMaterials.listCoursesCourseWorkMaterials)

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.

Tags
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

string orderBy Optional sort ordering for results. A comma- separated list of fields with an optional sort direction keyword. Supported field is updateTime. Supported direction keywords are asc and desc. If not specified, updateTime desc is the default behavior. Examples: updateTime asc, updateTime

opt_param

string courseWorkMaterialStates Restriction on the work status to return. Only course work material that matches is returned. If unspecified, items with a work status of PUBLISHED is returned.

opt_param

string materialLink Optional filtering for course work material with at least one link material whose URL partially matches the provided string.

opt_param

string materialDriveId Optional filtering for course work material with at least one Drive material whose ID matches the provided string. If material_link is also specified, course work material must have materials matching both filters.

opt_param

int pageSize Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results.

Return values
Google_Service_Classroom_ListCourseWorkMaterialResponse —

patch()

Updates one or more fields of a course work material. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project for access errors. * `INVALID_ARGUMENT` if the request is malformed.

public patch(string $courseId, string $id, Google_Service_Classroom_CourseWorkMaterial $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Classroom_CourseWorkMaterial
  • FAILED_PRECONDITION if the requested course work material has already been deleted. * NOT_FOUND if the requested course or course work material does not exist (courseWorkMaterials.patch)
Parameters
$courseId : string

Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.

$id : string

Identifier of the course work material.

$postBody : Google_Service_Classroom_CourseWorkMaterial
$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string updateMask Mask that identifies which fields on the course work material to update. This field is required to do an update. The update fails if invalid fields are specified. If a field supports empty values, it can be cleared by specifying it in the update mask and not in the course work material object. If a field that does not support empty values is included in the update mask and not set in the course work material object, an INVALID_ARGUMENT error is returned. The following fields may be specified by teachers: * title * description * state * scheduled_time * topic_id

Return values
Google_Service_Classroom_CourseWorkMaterial —

convertToArrayAndStripNulls()

protected convertToArrayAndStripNulls(mixed $o) : mixed
Parameters
$o : mixed
Return values
mixed —

Search results