Overview

Classes

  • Google_Service_Classroom
  • Google_Service_Classroom_Announcement
  • Google_Service_Classroom_Assignment
  • Google_Service_Classroom_AssignmentSubmission
  • Google_Service_Classroom_Attachment
  • Google_Service_Classroom_ClassroomEmpty
  • Google_Service_Classroom_CloudPubsubTopic
  • Google_Service_Classroom_Course
  • Google_Service_Classroom_CourseAlias
  • Google_Service_Classroom_CourseMaterial
  • Google_Service_Classroom_CourseMaterialSet
  • Google_Service_Classroom_CourseRosterChangesInfo
  • Google_Service_Classroom_Courses_Resource
  • Google_Service_Classroom_CoursesAliases_Resource
  • Google_Service_Classroom_CoursesAnnouncements_Resource
  • Google_Service_Classroom_CoursesCourseWork_Resource
  • Google_Service_Classroom_CoursesCourseWorkStudentSubmissions_Resource
  • Google_Service_Classroom_CoursesStudents_Resource
  • Google_Service_Classroom_CoursesTeachers_Resource
  • Google_Service_Classroom_CoursesTopics_Resource
  • Google_Service_Classroom_CourseWork
  • Google_Service_Classroom_CourseWorkChangesInfo
  • Google_Service_Classroom_Date
  • Google_Service_Classroom_DriveFile
  • Google_Service_Classroom_DriveFolder
  • Google_Service_Classroom_Feed
  • Google_Service_Classroom_Form
  • Google_Service_Classroom_GlobalPermission
  • Google_Service_Classroom_GradeHistory
  • Google_Service_Classroom_Guardian
  • Google_Service_Classroom_GuardianInvitation
  • Google_Service_Classroom_IndividualStudentsOptions
  • Google_Service_Classroom_Invitation
  • Google_Service_Classroom_Invitations_Resource
  • Google_Service_Classroom_Link
  • Google_Service_Classroom_ListAnnouncementsResponse
  • Google_Service_Classroom_ListCourseAliasesResponse
  • Google_Service_Classroom_ListCoursesResponse
  • Google_Service_Classroom_ListCourseWorkResponse
  • Google_Service_Classroom_ListGuardianInvitationsResponse
  • Google_Service_Classroom_ListGuardiansResponse
  • Google_Service_Classroom_ListInvitationsResponse
  • Google_Service_Classroom_ListStudentsResponse
  • Google_Service_Classroom_ListStudentSubmissionsResponse
  • Google_Service_Classroom_ListTeachersResponse
  • Google_Service_Classroom_ListTopicResponse
  • Google_Service_Classroom_Material
  • Google_Service_Classroom_ModifyAnnouncementAssigneesRequest
  • Google_Service_Classroom_ModifyAttachmentsRequest
  • Google_Service_Classroom_ModifyCourseWorkAssigneesRequest
  • Google_Service_Classroom_ModifyIndividualStudentsOptions
  • Google_Service_Classroom_MultipleChoiceQuestion
  • Google_Service_Classroom_MultipleChoiceSubmission
  • Google_Service_Classroom_Name
  • Google_Service_Classroom_ReclaimStudentSubmissionRequest
  • Google_Service_Classroom_Registration
  • Google_Service_Classroom_Registrations_Resource
  • Google_Service_Classroom_ReturnStudentSubmissionRequest
  • Google_Service_Classroom_SharedDriveFile
  • Google_Service_Classroom_ShortAnswerSubmission
  • Google_Service_Classroom_StateHistory
  • Google_Service_Classroom_Student
  • Google_Service_Classroom_StudentSubmission
  • Google_Service_Classroom_SubmissionHistory
  • Google_Service_Classroom_Teacher
  • Google_Service_Classroom_TimeOfDay
  • Google_Service_Classroom_Topic
  • Google_Service_Classroom_TurnInStudentSubmissionRequest
  • Google_Service_Classroom_UserProfile
  • Google_Service_Classroom_UserProfiles_Resource
  • Google_Service_Classroom_UserProfilesGuardianInvitations_Resource
  • Google_Service_Classroom_UserProfilesGuardians_Resource
  • Google_Service_Classroom_YouTubeVideo
  • Overview
  • Class
  • Tree

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
Extended by 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

Google_Service_Classroom_CourseAlias
Google_Service_Classroom_CourseAlias
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

Google_Service_Classroom_ClassroomEmpty
Google_Service_Classroom_ClassroomEmpty
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

Google_Service_Classroom_ListCourseAliasesResponse
Google_Service_Classroom_ListCourseAliasesResponse

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.
© 2020 Google Inc.
Google Classroom API documentation generated by ApiGen 2.8.0