Class Google_Service_Classroom_CoursesAliases_Resource
The "aliases" collection of methods. Typical usage is:
$classroomService = new Google_Service_Classroom(...);
$aliases = $classroomService->aliases;
-
Google_Service_Resource
-
Google_Service_Classroom_CoursesAliases_Resource
Located at Classroom.php
Methods summary
public
Google_Service_Classroom_CourseAlias
|
#
create( string $courseId, Google_Service_Classroom_CourseAlias $postBody, array $optParams = array() )
Creates an alias for a course.
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. *
FAILED_PRECONDITION if the alias requested does not make sense for
the requesting user or course (for example, if a user not in a domain attempts
to access a domain-scoped alias). (aliases.create)
Parameters
- $courseId
- Identifier of the course to alias. This identifier can be either the
Classroom-assigned identifier or an alias.
- $postBody
- $optParams
- Optional parameters.
Returns
|
public
Google_Service_Classroom_ClassroomEmpty
|
#
delete( string $courseId, string $alias, array $optParams = array() )
Deletes an alias of a course.
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. * FAILED_PRECONDITION if the alias requested does not make
sense for the requesting user or course (for example, if a user not in a domain
attempts to delete a domain-scoped alias). (aliases.delete)
Parameters
- $courseId
- Identifier of the course whose alias should be deleted. This identifier can be
either the Classroom-assigned identifier or an alias.
- $alias
- Alias to delete. This may not be the Classroom-assigned identifier.
- $optParams
- Optional parameters.
Returns
|
public
Google_Service_Classroom_ListCourseAliasesResponse
|
#
listCoursesAliases( string $courseId, array $optParams = array() )
Returns a list of aliases for a course.
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
- $courseId
- The identifier of the course. This identifier can be either the
Classroom-assigned identifier or an alias.
- $optParams
- Optional parameters.
Returns
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.
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.
|