Moodle PHP Documentation 4.4
Moodle 4.4.1 (Build: 20240610) (db07c09afc5)
Google_Service_Classroom_CoursesAliases_Resource Class Reference

The "aliases" collection of methods. More...

Inheritance diagram for Google_Service_Classroom_CoursesAliases_Resource:
Google_Service_Resource

Public Member Functions

 call ($name, $arguments, $expected_class=null)
 TODO: This function needs simplifying.
 
 create ($courseId, Google_Service_Classroom_CourseAlias $postBody, $optParams=array())
 Creates an alias for a course.
 
 delete ($courseId, $alias, $optParams=array())
 Deletes an alias of a course.
 
 listCoursesAliases ($courseId, $optParams=array())
 Returns a list of aliases for a course.
 

Protected Member Functions

 convertToArrayAndStripNulls ($o)
 

Detailed Description

The "aliases" collection of methods.

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

Member Function Documentation

◆ 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
Google_Exception

◆ create()

Google_Service_Classroom_CoursesAliases_Resource::create ( $courseId,
Google_Service_Classroom_CourseAlias $postBody,
$optParams = array() )

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)
Parameters
string$courseIdIdentifier of the course to alias. This identifier can be either the Classroom-assigned identifier or an alias.
Google_CourseAlias$postBody
array$optParamsOptional parameters.
Return values
Google_Service_Classroom_CourseAlias

◆ delete()

Google_Service_Classroom_CoursesAliases_Resource::delete ( $courseId,
$alias,
$optParams = array() )

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)
Parameters
string$courseIdIdentifier of the course whose alias should be deleted. This identifier can be either the Classroom-assigned identifier or an alias.
string$aliasAlias to delete. This may not be the Classroom-assigned identifier.
array$optParamsOptional parameters.
Return values
Google_Service_Classroom_Empty

◆ listCoursesAliases()

Google_Service_Classroom_CoursesAliases_Resource::listCoursesAliases ( $courseId,
$optParams = array() )

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)

Parameters
string$courseIdThe identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
array$optParamsOptional 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 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_ListCourseAliasesResponse

The documentation for this class was generated from the following file: