1. class
  2. Google
  3. \
  4. Service
  5. \
  6. Classroom
  7. \
  8. Resource
  9. \
  10. CoursesAliases

CoursesAliases

class CoursesAliases extends Resource (View source)

The "aliases" collection of methods.

Typical usage is:

 $classroomService = new Google\Service\Classroom(...);
 $aliases = $classroomService->courses_aliases;

Methods

CourseAlias
create(string $courseId, CourseAlias $postBody, array $optParams = [])

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).

ClassroomEmpty
delete(string $courseId, string $alias, array $optParams = [])

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)

ListCourseAliasesResponse
listCoursesAliases(string $courseId, array $optParams = [])

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)

Details

at line 50
CourseAlias create(string $courseId, CourseAlias $postBody, array $optParams = [])

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

string $courseId

Identifier of the course to alias. This identifier can be either the Classroom-assigned identifier or an alias.
CourseAlias $postBody
array $optParams

Optional parameters.

Return Value

CourseAlias

Exceptions

Exception

at line 73
ClassroomEmpty delete(string $courseId, string $alias, array $optParams = [])

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

string $courseId

Identifier of the course whose alias should be deleted. This identifier can be either the Classroom-assigned identifier or an alias.
string $alias

Alias to delete. This may not be the Classroom-assigned identifier.
array $optParams

Optional parameters.

Return Value

ClassroomEmpty

Exceptions

Exception

at line 99
ListCourseAliasesResponse listCoursesAliases(string $courseId, array $optParams = [])

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 $courseId

The identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
array $optParams

Optional parameters.

Return Value

ListCourseAliasesResponse

Exceptions

Exception