Copyright | (c) 2015-2016 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
- Service Configuration
- OAuth Scopes
- API Declaration
- Resources
- classroom.courses.aliases.create
- classroom.courses.aliases.delete
- classroom.courses.aliases.list
- classroom.courses.courseWork.create
- classroom.courses.courseWork.get
- classroom.courses.courseWork.list
- classroom.courses.courseWork.studentSubmissions.get
- classroom.courses.courseWork.studentSubmissions.list
- classroom.courses.courseWork.studentSubmissions.modifyAttachments
- classroom.courses.courseWork.studentSubmissions.patch
- classroom.courses.courseWork.studentSubmissions.reclaim
- classroom.courses.courseWork.studentSubmissions.return
- classroom.courses.courseWork.studentSubmissions.turnIn
- classroom.courses.create
- classroom.courses.delete
- classroom.courses.get
- classroom.courses.list
- classroom.courses.patch
- classroom.courses.students.create
- classroom.courses.students.delete
- classroom.courses.students.get
- classroom.courses.students.list
- classroom.courses.teachers.create
- classroom.courses.teachers.delete
- classroom.courses.teachers.get
- classroom.courses.teachers.list
- classroom.courses.update
- classroom.invitations.accept
- classroom.invitations.create
- classroom.invitations.delete
- classroom.invitations.get
- classroom.invitations.list
- classroom.userProfiles.get
- Types
- ListCourseAliasesResponse
- CourseWork
- DriveFile
- ReturnStudentSubmissionRequest
- ReclaimStudentSubmissionRequest
- ListCourseWorkResponse
- Empty
- GlobalPermission
- Link
- AssignmentSubmission
- ModifyAttachmentsRequest
- ListStudentSubmissionsResponse
- Material
- MultipleChoiceSubmission
- ListInvitationsResponse
- CourseMaterial
- ShortAnswerSubmission
- Invitation
- Attachment
- StudentSubmission
- Date
- YouTubeVideo
- Teacher
- CourseMaterialSet
- Name
- ListCoursesResponse
- TurnInStudentSubmissionRequest
- UserProFile
- DriveFolder
- MultipleChoiceQuestion
- Course
- TimeOfDay'
- Assignment
- ListStudentsResponse
- SharedDriveFile
- CourseAlias
- Form
- ListTeachersResponse
- Student
Manages classes, rosters, and invitations in Google Classroom.
- classroomService :: ServiceConfig
- classroomRostersReadOnlyScope :: Proxy '["https://www.googleapis.com/auth/classroom.rosters.readonly"]
- classroomCoursesScope :: Proxy '["https://www.googleapis.com/auth/classroom.courses"]
- classroomCourseworkStudentsReadOnlyScope :: Proxy '["https://www.googleapis.com/auth/classroom.coursework.students.readonly"]
- classroomProFileEmailsScope :: Proxy '["https://www.googleapis.com/auth/classroom.profile.emails"]
- classroomProFilePhotosScope :: Proxy '["https://www.googleapis.com/auth/classroom.profile.photos"]
- classroomCourseworkMeScope :: Proxy '["https://www.googleapis.com/auth/classroom.coursework.me"]
- classroomCourseWorkReadOnlyScope :: Proxy '["https://www.googleapis.com/auth/classroom.course-work.readonly"]
- classroomStudentSubmissionsStudentsReadOnlyScope :: Proxy '["https://www.googleapis.com/auth/classroom.student-submissions.students.readonly"]
- classroomRostersScope :: Proxy '["https://www.googleapis.com/auth/classroom.rosters"]
- classroomCoursesReadOnlyScope :: Proxy '["https://www.googleapis.com/auth/classroom.courses.readonly"]
- classroomCourseworkStudentsScope :: Proxy '["https://www.googleapis.com/auth/classroom.coursework.students"]
- classroomCourseworkMeReadOnlyScope :: Proxy '["https://www.googleapis.com/auth/classroom.coursework.me.readonly"]
- classroomStudentSubmissionsMeReadOnlyScope :: Proxy '["https://www.googleapis.com/auth/classroom.student-submissions.me.readonly"]
- type ClassroomAPI = InvitationsListResource :<|> (InvitationsAcceptResource :<|> (InvitationsGetResource :<|> (InvitationsCreateResource :<|> (InvitationsDeleteResource :<|> (CoursesCourseWorkStudentSubmissionsReturnResource :<|> (CoursesCourseWorkStudentSubmissionsListResource :<|> (CoursesCourseWorkStudentSubmissionsReclaimResource :<|> (CoursesCourseWorkStudentSubmissionsPatchResource :<|> (CoursesCourseWorkStudentSubmissionsGetResource :<|> (CoursesCourseWorkStudentSubmissionsTurnInResource :<|> (CoursesCourseWorkStudentSubmissionsModifyAttachmentsResource :<|> (CoursesCourseWorkListResource :<|> (CoursesCourseWorkGetResource :<|> (CoursesCourseWorkCreateResource :<|> (CoursesTeachersListResource :<|> (CoursesTeachersGetResource :<|> (CoursesTeachersCreateResource :<|> (CoursesTeachersDeleteResource :<|> (CoursesAliasesListResource :<|> (CoursesAliasesCreateResource :<|> (CoursesAliasesDeleteResource :<|> (CoursesStudentsListResource :<|> (CoursesStudentsGetResource :<|> (CoursesStudentsCreateResource :<|> (CoursesStudentsDeleteResource :<|> (CoursesListResource :<|> (CoursesPatchResource :<|> (CoursesGetResource :<|> (CoursesCreateResource :<|> (CoursesDeleteResource :<|> (CoursesUpdateResource :<|> UserProFilesGetResource)))))))))))))))))))))))))))))))
- module Network.Google.Resource.Classroom.Courses.Aliases.Create
- module Network.Google.Resource.Classroom.Courses.Aliases.Delete
- module Network.Google.Resource.Classroom.Courses.Aliases.List
- module Network.Google.Resource.Classroom.Courses.CourseWork.Create
- module Network.Google.Resource.Classroom.Courses.CourseWork.Get
- module Network.Google.Resource.Classroom.Courses.CourseWork.List
- module Network.Google.Resource.Classroom.Courses.CourseWork.StudentSubmissions.Get
- module Network.Google.Resource.Classroom.Courses.CourseWork.StudentSubmissions.List
- module Network.Google.Resource.Classroom.Courses.CourseWork.StudentSubmissions.ModifyAttachments
- module Network.Google.Resource.Classroom.Courses.CourseWork.StudentSubmissions.Patch
- module Network.Google.Resource.Classroom.Courses.CourseWork.StudentSubmissions.Reclaim
- module Network.Google.Resource.Classroom.Courses.CourseWork.StudentSubmissions.Return
- module Network.Google.Resource.Classroom.Courses.CourseWork.StudentSubmissions.TurnIn
- module Network.Google.Resource.Classroom.Courses.Create
- module Network.Google.Resource.Classroom.Courses.Delete
- module Network.Google.Resource.Classroom.Courses.Get
- module Network.Google.Resource.Classroom.Courses.List
- module Network.Google.Resource.Classroom.Courses.Patch
- module Network.Google.Resource.Classroom.Courses.Students.Create
- module Network.Google.Resource.Classroom.Courses.Students.Delete
- module Network.Google.Resource.Classroom.Courses.Students.Get
- module Network.Google.Resource.Classroom.Courses.Students.List
- module Network.Google.Resource.Classroom.Courses.Teachers.Create
- module Network.Google.Resource.Classroom.Courses.Teachers.Delete
- module Network.Google.Resource.Classroom.Courses.Teachers.Get
- module Network.Google.Resource.Classroom.Courses.Teachers.List
- module Network.Google.Resource.Classroom.Courses.Update
- module Network.Google.Resource.Classroom.Invitations.Accept
- module Network.Google.Resource.Classroom.Invitations.Create
- module Network.Google.Resource.Classroom.Invitations.Delete
- module Network.Google.Resource.Classroom.Invitations.Get
- module Network.Google.Resource.Classroom.Invitations.List
- module Network.Google.Resource.Classroom.UserProFiles.Get
- data ListCourseAliasesResponse
- listCourseAliasesResponse :: ListCourseAliasesResponse
- lcarNextPageToken :: Lens' ListCourseAliasesResponse (Maybe Text)
- lcarAliases :: Lens' ListCourseAliasesResponse [CourseAlias]
- data CourseWork
- courseWork :: CourseWork
- cwCreationTime :: Lens' CourseWork (Maybe Text)
- cwState :: Lens' CourseWork (Maybe Text)
- cwMaterials :: Lens' CourseWork [Material]
- cwCourseId :: Lens' CourseWork (Maybe Text)
- cwMaxPoints :: Lens' CourseWork (Maybe Double)
- cwWorkType :: Lens' CourseWork (Maybe Text)
- cwDueTime :: Lens' CourseWork (Maybe TimeOfDay')
- cwAssociatedWithDeveloper :: Lens' CourseWork (Maybe Bool)
- cwUpdateTime :: Lens' CourseWork (Maybe Text)
- cwMultipleChoiceQuestion :: Lens' CourseWork (Maybe MultipleChoiceQuestion)
- cwId :: Lens' CourseWork (Maybe Text)
- cwSubmissionModificationMode :: Lens' CourseWork (Maybe Text)
- cwDueDate :: Lens' CourseWork (Maybe Date)
- cwTitle :: Lens' CourseWork (Maybe Text)
- cwAlternateLink :: Lens' CourseWork (Maybe Text)
- cwAssignment :: Lens' CourseWork (Maybe Assignment)
- cwDescription :: Lens' CourseWork (Maybe Text)
- data DriveFile
- driveFile :: DriveFile
- dfThumbnailURL :: Lens' DriveFile (Maybe Text)
- dfId :: Lens' DriveFile (Maybe Text)
- dfTitle :: Lens' DriveFile (Maybe Text)
- dfAlternateLink :: Lens' DriveFile (Maybe Text)
- data ReturnStudentSubmissionRequest
- returnStudentSubmissionRequest :: ReturnStudentSubmissionRequest
- data ReclaimStudentSubmissionRequest
- reclaimStudentSubmissionRequest :: ReclaimStudentSubmissionRequest
- data ListCourseWorkResponse
- listCourseWorkResponse :: ListCourseWorkResponse
- lcwrCourseWork :: Lens' ListCourseWorkResponse [CourseWork]
- lcwrNextPageToken :: Lens' ListCourseWorkResponse (Maybe Text)
- data Empty
- empty :: Empty
- data GlobalPermission
- globalPermission :: GlobalPermission
- gpPermission :: Lens' GlobalPermission (Maybe Text)
- data Link
- link :: Link
- lThumbnailURL :: Lens' Link (Maybe Text)
- lURL :: Lens' Link (Maybe Text)
- lTitle :: Lens' Link (Maybe Text)
- data AssignmentSubmission
- assignmentSubmission :: AssignmentSubmission
- asAttachments :: Lens' AssignmentSubmission [Attachment]
- data ModifyAttachmentsRequest
- modifyAttachmentsRequest :: ModifyAttachmentsRequest
- marAddAttachments :: Lens' ModifyAttachmentsRequest [Attachment]
- data ListStudentSubmissionsResponse
- listStudentSubmissionsResponse :: ListStudentSubmissionsResponse
- lssrNextPageToken :: Lens' ListStudentSubmissionsResponse (Maybe Text)
- lssrStudentSubmissions :: Lens' ListStudentSubmissionsResponse [StudentSubmission]
- data Material
- material :: Material
- mDriveFile :: Lens' Material (Maybe SharedDriveFile)
- mLink :: Lens' Material (Maybe Link)
- mYouTubeVideo :: Lens' Material (Maybe YouTubeVideo)
- mForm :: Lens' Material (Maybe Form)
- data MultipleChoiceSubmission
- multipleChoiceSubmission :: MultipleChoiceSubmission
- mcsAnswer :: Lens' MultipleChoiceSubmission (Maybe Text)
- data ListInvitationsResponse
- listInvitationsResponse :: ListInvitationsResponse
- lirNextPageToken :: Lens' ListInvitationsResponse (Maybe Text)
- lirInvitations :: Lens' ListInvitationsResponse [Invitation]
- data CourseMaterial
- courseMaterial :: CourseMaterial
- cmDriveFile :: Lens' CourseMaterial (Maybe DriveFile)
- cmLink :: Lens' CourseMaterial (Maybe Link)
- cmYouTubeVideo :: Lens' CourseMaterial (Maybe YouTubeVideo)
- cmForm :: Lens' CourseMaterial (Maybe Form)
- data ShortAnswerSubmission
- shortAnswerSubmission :: ShortAnswerSubmission
- sasAnswer :: Lens' ShortAnswerSubmission (Maybe Text)
- data Invitation
- invitation :: Invitation
- iCourseId :: Lens' Invitation (Maybe Text)
- iUserId :: Lens' Invitation (Maybe Text)
- iRole :: Lens' Invitation (Maybe Text)
- iId :: Lens' Invitation (Maybe Text)
- data Attachment
- attachment :: Attachment
- aDriveFile :: Lens' Attachment (Maybe DriveFile)
- aLink :: Lens' Attachment (Maybe Link)
- aYouTubeVideo :: Lens' Attachment (Maybe YouTubeVideo)
- aForm :: Lens' Attachment (Maybe Form)
- data StudentSubmission
- studentSubmission :: StudentSubmission
- ssCreationTime :: Lens' StudentSubmission (Maybe Text)
- ssLate :: Lens' StudentSubmission (Maybe Bool)
- ssState :: Lens' StudentSubmission (Maybe Text)
- ssCourseId :: Lens' StudentSubmission (Maybe Text)
- ssMultipleChoiceSubmission :: Lens' StudentSubmission (Maybe MultipleChoiceSubmission)
- ssAssignmentSubmission :: Lens' StudentSubmission (Maybe AssignmentSubmission)
- ssShortAnswerSubmission :: Lens' StudentSubmission (Maybe ShortAnswerSubmission)
- ssAssociatedWithDeveloper :: Lens' StudentSubmission (Maybe Bool)
- ssUserId :: Lens' StudentSubmission (Maybe Text)
- ssUpdateTime :: Lens' StudentSubmission (Maybe Text)
- ssCourseWorkType :: Lens' StudentSubmission (Maybe Text)
- ssAssignedGrade :: Lens' StudentSubmission (Maybe Double)
- ssId :: Lens' StudentSubmission (Maybe Text)
- ssDraftGrade :: Lens' StudentSubmission (Maybe Double)
- ssAlternateLink :: Lens' StudentSubmission (Maybe Text)
- ssCourseWorkId :: Lens' StudentSubmission (Maybe Text)
- data Date
- date :: Date
- dDay :: Lens' Date (Maybe Int32)
- dYear :: Lens' Date (Maybe Int32)
- dMonth :: Lens' Date (Maybe Int32)
- data YouTubeVideo
- youTubeVideo :: YouTubeVideo
- ytvThumbnailURL :: Lens' YouTubeVideo (Maybe Text)
- ytvId :: Lens' YouTubeVideo (Maybe Text)
- ytvTitle :: Lens' YouTubeVideo (Maybe Text)
- ytvAlternateLink :: Lens' YouTubeVideo (Maybe Text)
- data Teacher
- teacher :: Teacher
- tCourseId :: Lens' Teacher (Maybe Text)
- tProFile :: Lens' Teacher (Maybe UserProFile)
- tUserId :: Lens' Teacher (Maybe Text)
- data CourseMaterialSet
- courseMaterialSet :: CourseMaterialSet
- cmsMaterials :: Lens' CourseMaterialSet [CourseMaterial]
- cmsTitle :: Lens' CourseMaterialSet (Maybe Text)
- data Name
- name :: Name
- nGivenName :: Lens' Name (Maybe Text)
- nFullName :: Lens' Name (Maybe Text)
- nFamilyName :: Lens' Name (Maybe Text)
- data ListCoursesResponse
- listCoursesResponse :: ListCoursesResponse
- lcrNextPageToken :: Lens' ListCoursesResponse (Maybe Text)
- lcrCourses :: Lens' ListCoursesResponse [Course]
- data TurnInStudentSubmissionRequest
- turnInStudentSubmissionRequest :: TurnInStudentSubmissionRequest
- data UserProFile
- userProFile :: UserProFile
- upfPhotoURL :: Lens' UserProFile (Maybe Text)
- upfName :: Lens' UserProFile (Maybe Name)
- upfEmailAddress :: Lens' UserProFile (Maybe Text)
- upfId :: Lens' UserProFile (Maybe Text)
- upfPermissions :: Lens' UserProFile [GlobalPermission]
- data DriveFolder
- driveFolder :: DriveFolder
- dId :: Lens' DriveFolder (Maybe Text)
- dTitle :: Lens' DriveFolder (Maybe Text)
- dAlternateLink :: Lens' DriveFolder (Maybe Text)
- data MultipleChoiceQuestion
- multipleChoiceQuestion :: MultipleChoiceQuestion
- mcqChoices :: Lens' MultipleChoiceQuestion [Text]
- data Course
- course :: Course
- cCreationTime :: Lens' Course (Maybe Text)
- cRoom :: Lens' Course (Maybe Text)
- cCourseMaterialSets :: Lens' Course [CourseMaterialSet]
- cTeacherGroupEmail :: Lens' Course (Maybe Text)
- cTeacherFolder :: Lens' Course (Maybe DriveFolder)
- cCourseState :: Lens' Course (Maybe Text)
- cEnrollmentCode :: Lens' Course (Maybe Text)
- cUpdateTime :: Lens' Course (Maybe Text)
- cOwnerId :: Lens' Course (Maybe Text)
- cName :: Lens' Course (Maybe Text)
- cId :: Lens' Course (Maybe Text)
- cAlternateLink :: Lens' Course (Maybe Text)
- cCourseGroupEmail :: Lens' Course (Maybe Text)
- cDescription :: Lens' Course (Maybe Text)
- cDescriptionHeading :: Lens' Course (Maybe Text)
- cSection :: Lens' Course (Maybe Text)
- data TimeOfDay'
- timeOfDay :: TimeOfDay'
- todNanos :: Lens' TimeOfDay' (Maybe Int32)
- todHours :: Lens' TimeOfDay' (Maybe Int32)
- todMinutes :: Lens' TimeOfDay' (Maybe Int32)
- todSeconds :: Lens' TimeOfDay' (Maybe Int32)
- data Assignment
- assignment :: Assignment
- aStudentWorkFolder :: Lens' Assignment (Maybe DriveFolder)
- data ListStudentsResponse
- listStudentsResponse :: ListStudentsResponse
- lsrNextPageToken :: Lens' ListStudentsResponse (Maybe Text)
- lsrStudents :: Lens' ListStudentsResponse [Student]
- data SharedDriveFile
- sharedDriveFile :: SharedDriveFile
- sdfDriveFile :: Lens' SharedDriveFile (Maybe DriveFile)
- sdfShareMode :: Lens' SharedDriveFile (Maybe Text)
- data CourseAlias
- courseAlias :: CourseAlias
- caAlias :: Lens' CourseAlias (Maybe Text)
- data Form
- form :: Form
- fThumbnailURL :: Lens' Form (Maybe Text)
- fFormURL :: Lens' Form (Maybe Text)
- fTitle :: Lens' Form (Maybe Text)
- fResponseURL :: Lens' Form (Maybe Text)
- data ListTeachersResponse
- listTeachersResponse :: ListTeachersResponse
- ltrNextPageToken :: Lens' ListTeachersResponse (Maybe Text)
- ltrTeachers :: Lens' ListTeachersResponse [Teacher]
- data Student
- student :: Student
- sCourseId :: Lens' Student (Maybe Text)
- sProFile :: Lens' Student (Maybe UserProFile)
- sStudentWorkFolder :: Lens' Student (Maybe DriveFolder)
- sUserId :: Lens' Student (Maybe Text)
Service Configuration
classroomService :: ServiceConfig Source #
Default request referring to version v1
of the Google Classroom API. This contains the host and root path used as a starting point for constructing service requests.
OAuth Scopes
classroomRostersReadOnlyScope :: Proxy '["https://www.googleapis.com/auth/classroom.rosters.readonly"] Source #
View your Google Classroom class rosters
classroomCoursesScope :: Proxy '["https://www.googleapis.com/auth/classroom.courses"] Source #
Manage your Google Classroom classes
classroomCourseworkStudentsReadOnlyScope :: Proxy '["https://www.googleapis.com/auth/classroom.coursework.students.readonly"] Source #
View course work and grades for students in the Google Classroom classes you teach or administer
classroomProFileEmailsScope :: Proxy '["https://www.googleapis.com/auth/classroom.profile.emails"] Source #
View the email addresses of people in your classes
classroomProFilePhotosScope :: Proxy '["https://www.googleapis.com/auth/classroom.profile.photos"] Source #
View the profile photos of people in your classes
classroomCourseworkMeScope :: Proxy '["https://www.googleapis.com/auth/classroom.coursework.me"] Source #
Manage your course work and view your grades in Google Classroom
classroomCourseWorkReadOnlyScope :: Proxy '["https://www.googleapis.com/auth/classroom.course-work.readonly"] Source #
View instructions for teacher-assigned work in your Google Classroom classes
classroomStudentSubmissionsStudentsReadOnlyScope :: Proxy '["https://www.googleapis.com/auth/classroom.student-submissions.students.readonly"] Source #
View course work and grades for students in the Google Classroom classes you teach or administer
classroomRostersScope :: Proxy '["https://www.googleapis.com/auth/classroom.rosters"] Source #
Manage your Google Classroom class rosters
classroomCoursesReadOnlyScope :: Proxy '["https://www.googleapis.com/auth/classroom.courses.readonly"] Source #
View your Google Classroom classes
classroomCourseworkStudentsScope :: Proxy '["https://www.googleapis.com/auth/classroom.coursework.students"] Source #
Manage course work and grades for students in the Google Classroom classes you teach and view the course work and grades for classes you administer
classroomCourseworkMeReadOnlyScope :: Proxy '["https://www.googleapis.com/auth/classroom.coursework.me.readonly"] Source #
View your course work and grades in Google Classroom
classroomStudentSubmissionsMeReadOnlyScope :: Proxy '["https://www.googleapis.com/auth/classroom.student-submissions.me.readonly"] Source #
View your course work and grades in Google Classroom
API Declaration
type ClassroomAPI = InvitationsListResource :<|> (InvitationsAcceptResource :<|> (InvitationsGetResource :<|> (InvitationsCreateResource :<|> (InvitationsDeleteResource :<|> (CoursesCourseWorkStudentSubmissionsReturnResource :<|> (CoursesCourseWorkStudentSubmissionsListResource :<|> (CoursesCourseWorkStudentSubmissionsReclaimResource :<|> (CoursesCourseWorkStudentSubmissionsPatchResource :<|> (CoursesCourseWorkStudentSubmissionsGetResource :<|> (CoursesCourseWorkStudentSubmissionsTurnInResource :<|> (CoursesCourseWorkStudentSubmissionsModifyAttachmentsResource :<|> (CoursesCourseWorkListResource :<|> (CoursesCourseWorkGetResource :<|> (CoursesCourseWorkCreateResource :<|> (CoursesTeachersListResource :<|> (CoursesTeachersGetResource :<|> (CoursesTeachersCreateResource :<|> (CoursesTeachersDeleteResource :<|> (CoursesAliasesListResource :<|> (CoursesAliasesCreateResource :<|> (CoursesAliasesDeleteResource :<|> (CoursesStudentsListResource :<|> (CoursesStudentsGetResource :<|> (CoursesStudentsCreateResource :<|> (CoursesStudentsDeleteResource :<|> (CoursesListResource :<|> (CoursesPatchResource :<|> (CoursesGetResource :<|> (CoursesCreateResource :<|> (CoursesDeleteResource :<|> (CoursesUpdateResource :<|> UserProFilesGetResource))))))))))))))))))))))))))))))) Source #
Represents the entirety of the methods and resources available for the Google Classroom API service.
Resources
classroom.courses.aliases.create
classroom.courses.aliases.delete
classroom.courses.aliases.list
classroom.courses.courseWork.create
classroom.courses.courseWork.get
classroom.courses.courseWork.list
classroom.courses.courseWork.studentSubmissions.get
classroom.courses.courseWork.studentSubmissions.list
classroom.courses.courseWork.studentSubmissions.modifyAttachments
classroom.courses.courseWork.studentSubmissions.patch
classroom.courses.courseWork.studentSubmissions.reclaim
classroom.courses.courseWork.studentSubmissions.return
classroom.courses.courseWork.studentSubmissions.turnIn
classroom.courses.create
classroom.courses.delete
classroom.courses.get
classroom.courses.list
classroom.courses.patch
classroom.courses.students.create
classroom.courses.students.delete
classroom.courses.students.get
classroom.courses.students.list
classroom.courses.teachers.create
classroom.courses.teachers.delete
classroom.courses.teachers.get
classroom.courses.teachers.list
classroom.courses.update
classroom.invitations.accept
classroom.invitations.create
classroom.invitations.delete
classroom.invitations.get
classroom.invitations.list
classroom.userProfiles.get
Types
ListCourseAliasesResponse
data ListCourseAliasesResponse Source #
Response when listing course aliases.
See: listCourseAliasesResponse
smart constructor.
listCourseAliasesResponse :: ListCourseAliasesResponse Source #
Creates a value of ListCourseAliasesResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lcarNextPageToken :: Lens' ListCourseAliasesResponse (Maybe Text) Source #
Token identifying the next page of results to return. If empty, no further results are available.
lcarAliases :: Lens' ListCourseAliasesResponse [CourseAlias] Source #
The course aliases.
CourseWork
data CourseWork Source #
Course work created by a teacher for students of the course.
See: courseWork
smart constructor.
courseWork :: CourseWork Source #
Creates a value of CourseWork
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
cwCreationTime :: Lens' CourseWork (Maybe Text) Source #
Timestamp when this course work was created. Read-only.
cwState :: Lens' CourseWork (Maybe Text) Source #
Status of this course work.. If unspecified, the default state is `DRAFT`.
cwMaterials :: Lens' CourseWork [Material] Source #
Additional materials.
cwCourseId :: Lens' CourseWork (Maybe Text) Source #
Identifier of the course. Read-only.
cwMaxPoints :: Lens' CourseWork (Maybe Double) Source #
Maximum grade for this course work. If zero or unspecified, this assignment is considered ungraded. This must be an integer value.
cwWorkType :: Lens' CourseWork (Maybe Text) Source #
Type of this course work. The type is set when the course work is created and cannot be changed. When creating course work, this must be `ASSIGNMENT`.
cwDueTime :: Lens' CourseWork (Maybe TimeOfDay') Source #
Optional time of day, in UTC, that submissions for this this course work are due. This must be specified if `due_date` is specified.
cwAssociatedWithDeveloper :: Lens' CourseWork (Maybe Bool) Source #
Whether this course work item is associated with the Developer Console project making the request. See google.classroom.Work.CreateCourseWork for more details. Read-only.
cwUpdateTime :: Lens' CourseWork (Maybe Text) Source #
Timestamp of the most recent change to this course work. Read-only.
cwMultipleChoiceQuestion :: Lens' CourseWork (Maybe MultipleChoiceQuestion) Source #
Multiple choice question details. This is populated only when `work_type` is `MULTIPLE_CHOICE_QUESTION`.
cwId :: Lens' CourseWork (Maybe Text) Source #
Classroom-assigned identifier of this course work, unique per course. Read-only.
cwSubmissionModificationMode :: Lens' CourseWork (Maybe Text) Source #
Setting to determine when students are allowed to modify submissions. If unspecified, the default value is `MODIFIABLE_UNTIL_TURNED_IN`.
cwDueDate :: Lens' CourseWork (Maybe Date) Source #
Optional date, in UTC, that submissions for this this course work are due. This must be specified if `due_time` is specified.
cwTitle :: Lens' CourseWork (Maybe Text) Source #
Title of this course work. The title must be a valid UTF-8 string containing between 1 and 3000 characters.
cwAlternateLink :: Lens' CourseWork (Maybe Text) Source #
Absolute link to this course work in the Classroom web UI. This is only populated if `state` is `PUBLISHED`. Read-only.
cwAssignment :: Lens' CourseWork (Maybe Assignment) Source #
Assignment details. This is populated only when `work_type` is `ASSIGNMENT`.
cwDescription :: Lens' CourseWork (Maybe Text) Source #
Optional description of this course work. If set, the description must be a valid UTF-8 string containing no more than 30,000 characters.
DriveFile
Representation of a Google Drive file.
See: driveFile
smart constructor.
driveFile :: DriveFile Source #
Creates a value of DriveFile
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dfThumbnailURL :: Lens' DriveFile (Maybe Text) Source #
URL of a thumbnail image of the Drive item. Read-only.
dfAlternateLink :: Lens' DriveFile (Maybe Text) Source #
URL that can be used to access the Drive item. Read-only.
ReturnStudentSubmissionRequest
data ReturnStudentSubmissionRequest Source #
Request to return a student submission.
See: returnStudentSubmissionRequest
smart constructor.
returnStudentSubmissionRequest :: ReturnStudentSubmissionRequest Source #
Creates a value of ReturnStudentSubmissionRequest
with the minimum fields required to make a request.
ReclaimStudentSubmissionRequest
data ReclaimStudentSubmissionRequest Source #
Request to reclaim a student submission.
See: reclaimStudentSubmissionRequest
smart constructor.
reclaimStudentSubmissionRequest :: ReclaimStudentSubmissionRequest Source #
Creates a value of ReclaimStudentSubmissionRequest
with the minimum fields required to make a request.
ListCourseWorkResponse
data ListCourseWorkResponse Source #
Response when listing course work.
See: listCourseWorkResponse
smart constructor.
listCourseWorkResponse :: ListCourseWorkResponse Source #
Creates a value of ListCourseWorkResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lcwrCourseWork :: Lens' ListCourseWorkResponse [CourseWork] Source #
Course work items that match the request.
lcwrNextPageToken :: Lens' ListCourseWorkResponse (Maybe Text) Source #
Token identifying the next page of results to return. If empty, no further results are available.
Empty
A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
See: empty
smart constructor.
GlobalPermission
data GlobalPermission Source #
Global user permission description.
See: globalPermission
smart constructor.
globalPermission :: GlobalPermission Source #
Creates a value of GlobalPermission
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
gpPermission :: Lens' GlobalPermission (Maybe Text) Source #
Permission value.
Link
URL item.
See: link
smart constructor.
Creates a value of Link
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lThumbnailURL :: Lens' Link (Maybe Text) Source #
URL of a thumbnail image of the target URL. Read-only.
lURL :: Lens' Link (Maybe Text) Source #
URL to link to. This must be a valid UTF-8 string containing between 1 and 2024 characters.
AssignmentSubmission
data AssignmentSubmission Source #
Student work for an assignment.
See: assignmentSubmission
smart constructor.
assignmentSubmission :: AssignmentSubmission Source #
Creates a value of AssignmentSubmission
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
asAttachments :: Lens' AssignmentSubmission [Attachment] Source #
Attachments added by the student. Drive files that correspond to materials with a share mode of SUBMISSION_COPY may not exist yet if the student has not accessed the assignment in Classroom. Some attachment metadata is only populated if the requesting user has permission to access it. Identifier and alternate_link fields are available, but others (e.g. title) may not be.
ModifyAttachmentsRequest
data ModifyAttachmentsRequest Source #
Request to modify the attachments of a student submission.
See: modifyAttachmentsRequest
smart constructor.
modifyAttachmentsRequest :: ModifyAttachmentsRequest Source #
Creates a value of ModifyAttachmentsRequest
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
marAddAttachments :: Lens' ModifyAttachmentsRequest [Attachment] Source #
Attachments to add. This may only contain link attachments.
ListStudentSubmissionsResponse
data ListStudentSubmissionsResponse Source #
Response when listing student submissions.
See: listStudentSubmissionsResponse
smart constructor.
listStudentSubmissionsResponse :: ListStudentSubmissionsResponse Source #
Creates a value of ListStudentSubmissionsResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lssrNextPageToken :: Lens' ListStudentSubmissionsResponse (Maybe Text) Source #
Token identifying the next page of results to return. If empty, no further results are available.
lssrStudentSubmissions :: Lens' ListStudentSubmissionsResponse [StudentSubmission] Source #
Student work that matches the request.
Material
Material attached to course work. When creating attachments, only the Link field may be specified.
See: material
smart constructor.
Creates a value of Material
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
mDriveFile :: Lens' Material (Maybe SharedDriveFile) Source #
Google Drive file material.
mYouTubeVideo :: Lens' Material (Maybe YouTubeVideo) Source #
YouTube video material.
MultipleChoiceSubmission
data MultipleChoiceSubmission Source #
Student work for a multiple-choice question.
See: multipleChoiceSubmission
smart constructor.
multipleChoiceSubmission :: MultipleChoiceSubmission Source #
Creates a value of MultipleChoiceSubmission
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ListInvitationsResponse
data ListInvitationsResponse Source #
Response when listing invitations.
See: listInvitationsResponse
smart constructor.
listInvitationsResponse :: ListInvitationsResponse Source #
Creates a value of ListInvitationsResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lirNextPageToken :: Lens' ListInvitationsResponse (Maybe Text) Source #
Token identifying the next page of results to return. If empty, no further results are available.
lirInvitations :: Lens' ListInvitationsResponse [Invitation] Source #
Invitations that match the list request.
CourseMaterial
data CourseMaterial Source #
A material attached to a course as part of a material set.
See: courseMaterial
smart constructor.
courseMaterial :: CourseMaterial Source #
Creates a value of CourseMaterial
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
cmDriveFile :: Lens' CourseMaterial (Maybe DriveFile) Source #
Google Drive file attachment.
cmYouTubeVideo :: Lens' CourseMaterial (Maybe YouTubeVideo) Source #
Youtube video attachment.
ShortAnswerSubmission
data ShortAnswerSubmission Source #
Student work for a short answer question.
See: shortAnswerSubmission
smart constructor.
shortAnswerSubmission :: ShortAnswerSubmission Source #
Creates a value of ShortAnswerSubmission
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
sasAnswer :: Lens' ShortAnswerSubmission (Maybe Text) Source #
Student response to a short-answer question.
Invitation
data Invitation Source #
An invitation to join a course.
See: invitation
smart constructor.
invitation :: Invitation Source #
Creates a value of Invitation
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
iUserId :: Lens' Invitation (Maybe Text) Source #
Identifier of the invited user. When specified as a parameter of a request, this identifier can be set to one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user
iRole :: Lens' Invitation (Maybe Text) Source #
Role to invite the user to have. Must not be `COURSE_ROLE_UNSPECIFIED`.
Attachment
data Attachment Source #
Attachment added to student assignment work. When creating attachments, only the Link field may be specified.
See: attachment
smart constructor.
attachment :: Attachment Source #
Creates a value of Attachment
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
aDriveFile :: Lens' Attachment (Maybe DriveFile) Source #
Google Drive file attachment.
aYouTubeVideo :: Lens' Attachment (Maybe YouTubeVideo) Source #
Youtube video attachment.
StudentSubmission
data StudentSubmission Source #
Student submission for course work. StudentSubmission items are generated when a CourseWork item is created. StudentSubmissions that have never been accessed (i.e. with `state` = NEW) may not have a creation time or update time.
See: studentSubmission
smart constructor.
studentSubmission :: StudentSubmission Source #
Creates a value of StudentSubmission
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ssCreationTime :: Lens' StudentSubmission (Maybe Text) Source #
Creation time of this submission.. This may be unset if the student has not accessed this item. Read-only.
ssCourseId :: Lens' StudentSubmission (Maybe Text) Source #
Identifier of the course. Read-only.
ssMultipleChoiceSubmission :: Lens' StudentSubmission (Maybe MultipleChoiceSubmission) Source #
Submission content when course_work_type is MUTIPLE_CHOICE_QUESTION.
ssAssignmentSubmission :: Lens' StudentSubmission (Maybe AssignmentSubmission) Source #
Submission content when course_work_type is ASSIGNMENT .
ssShortAnswerSubmission :: Lens' StudentSubmission (Maybe ShortAnswerSubmission) Source #
Submission content when course_work_type is SHORT_ANSWER_QUESTION.
ssAssociatedWithDeveloper :: Lens' StudentSubmission (Maybe Bool) Source #
Whether this student submission is associated with the Developer Console project making the request. See google.classroom.Work.CreateCourseWork for more details. Read-only.
ssUserId :: Lens' StudentSubmission (Maybe Text) Source #
Identifier for the student that owns this submission. Read-only.
ssUpdateTime :: Lens' StudentSubmission (Maybe Text) Source #
Last update time of this submission. This may be unset if the student has not accessed this item. Read-only.
ssCourseWorkType :: Lens' StudentSubmission (Maybe Text) Source #
Type of course work this submission is for. Read-only.
ssAssignedGrade :: Lens' StudentSubmission (Maybe Double) Source #
Optional grade. If unset, no grade was set. This must be an integer value. This may be modified only by course teachers.
ssId :: Lens' StudentSubmission (Maybe Text) Source #
Classroom-assigned Identifier for the student submission. This is unique among submissions for the relevant course work. Read-only.
ssDraftGrade :: Lens' StudentSubmission (Maybe Double) Source #
Optional pending grade. If unset, no grade was set. This must be an integer value. This is only visible to and modifiable by course teachers.
ssAlternateLink :: Lens' StudentSubmission (Maybe Text) Source #
Absolute link to the submission in the Classroom web UI. Read-only.
ssCourseWorkId :: Lens' StudentSubmission (Maybe Text) Source #
Identifier for the course work this corresponds to. Read-only.
Date
Represents a whole calendar date, e.g. date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the Proleptic Gregorian Calendar. The day may be 0 to represent a year and month where the day is not significant, e.g. credit card expiration date. The year may be 0 to represent a month and day independent of year, e.g. anniversary date. Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.
See: date
smart constructor.
dDay :: Lens' Date (Maybe Int32) Source #
Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year/month where the day is not significant.
dYear :: Lens' Date (Maybe Int32) Source #
Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year.
YouTubeVideo
data YouTubeVideo Source #
YouTube video item.
See: youTubeVideo
smart constructor.
youTubeVideo :: YouTubeVideo Source #
Creates a value of YouTubeVideo
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ytvThumbnailURL :: Lens' YouTubeVideo (Maybe Text) Source #
URL of a thumbnail image of the YouTube video. Read-only.
ytvAlternateLink :: Lens' YouTubeVideo (Maybe Text) Source #
URL that can be used to view the YouTube video. Read-only.
Teacher
Teacher of a course.
See: teacher
smart constructor.
tProFile :: Lens' Teacher (Maybe UserProFile) Source #
Global user information for the teacher. Read-only.
tUserId :: Lens' Teacher (Maybe Text) Source #
Identifier of the user. When specified as a parameter of a request, this identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user
CourseMaterialSet
data CourseMaterialSet Source #
A set of materials that appears on the "About" page of the course. These materials might include a syllabus, schedule, or other background information relating to the course as a whole.
See: courseMaterialSet
smart constructor.
courseMaterialSet :: CourseMaterialSet Source #
Creates a value of CourseMaterialSet
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
cmsMaterials :: Lens' CourseMaterialSet [CourseMaterial] Source #
Materials attached to this set.
Name
Details of the user's name.
See: name
smart constructor.
Creates a value of Name
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
nFullName :: Lens' Name (Maybe Text) Source #
The user's full name formed by concatenating the first and last name values. Read-only.
ListCoursesResponse
data ListCoursesResponse Source #
Response when listing courses.
See: listCoursesResponse
smart constructor.
listCoursesResponse :: ListCoursesResponse Source #
Creates a value of ListCoursesResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lcrNextPageToken :: Lens' ListCoursesResponse (Maybe Text) Source #
Token identifying the next page of results to return. If empty, no further results are available.
lcrCourses :: Lens' ListCoursesResponse [Course] Source #
Courses that match the list request.
TurnInStudentSubmissionRequest
data TurnInStudentSubmissionRequest Source #
Request to turn in a student submission.
See: turnInStudentSubmissionRequest
smart constructor.
turnInStudentSubmissionRequest :: TurnInStudentSubmissionRequest Source #
Creates a value of TurnInStudentSubmissionRequest
with the minimum fields required to make a request.
UserProFile
data UserProFile Source #
Global information for a user.
See: userProFile
smart constructor.
userProFile :: UserProFile Source #
Creates a value of UserProFile
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
upfPhotoURL :: Lens' UserProFile (Maybe Text) Source #
URL of user's profile photo. Read-only.
upfEmailAddress :: Lens' UserProFile (Maybe Text) Source #
Email address of the user. Read-only.
upfPermissions :: Lens' UserProFile [GlobalPermission] Source #
Global permissions of the user. Read-only.
DriveFolder
data DriveFolder Source #
Representation of a Google Drive folder.
See: driveFolder
smart constructor.
driveFolder :: DriveFolder Source #
Creates a value of DriveFolder
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dAlternateLink :: Lens' DriveFolder (Maybe Text) Source #
URL that can be used to access the Drive folder. Read-only.
MultipleChoiceQuestion
data MultipleChoiceQuestion Source #
Additional details for multiple-choice questions.
See: multipleChoiceQuestion
smart constructor.
multipleChoiceQuestion :: MultipleChoiceQuestion Source #
Creates a value of MultipleChoiceQuestion
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
mcqChoices :: Lens' MultipleChoiceQuestion [Text] Source #
Possible choices.
Course
A Course in Classroom.
See: course
smart constructor.
Creates a value of Course
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
cCreationTime :: Lens' Course (Maybe Text) Source #
Creation time of the course. Specifying this field in a course update mask results in an error. Read-only.
cRoom :: Lens' Course (Maybe Text) Source #
Optional room location. For example, "301". If set, this field must be a valid UTF-8 string and no longer than 650 characters.
cCourseMaterialSets :: Lens' Course [CourseMaterialSet] Source #
Sets of materials that appear on the "about" page of this course. Read-only.
cTeacherGroupEmail :: Lens' Course (Maybe Text) Source #
The email address of a Google group containing all teachers of the course. This group does not accept email and can only be used for permissions. Read-only.
cTeacherFolder :: Lens' Course (Maybe DriveFolder) Source #
Information about a Drive Folder that is shared with all teachers of the course. This field will only be set for teachers of the course and domain administrators. Read-only.
cCourseState :: Lens' Course (Maybe Text) Source #
State of the course. If unspecified, the default state is `PROVISIONED`.
cEnrollmentCode :: Lens' Course (Maybe Text) Source #
Enrollment code to use when joining this course. Specifying this field in a course update mask results in an error. Read-only.
cUpdateTime :: Lens' Course (Maybe Text) Source #
Time of the most recent update to this course. Specifying this field in a course update mask results in an error. Read-only.
cOwnerId :: Lens' Course (Maybe Text) Source #
The identifier of the owner of a course. When specified as a parameter of a create course request, this field is required. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user This must be set in a create request. Specifying this field in a course update mask results in an `INVALID_ARGUMENT` error.
cName :: Lens' Course (Maybe Text) Source #
Name of the course. For example, "10th Grade Biology". The name is required. It must be between 1 and 750 characters and a valid UTF-8 string.
cId :: Lens' Course (Maybe Text) Source #
Identifier for this course assigned by Classroom. When creating a course, you may optionally set this identifier to an alias string in the request to create a corresponding alias. The `id` is still assigned by Classroom and cannot be updated after the course is created. Specifying this field in a course update mask results in an error.
cAlternateLink :: Lens' Course (Maybe Text) Source #
Absolute link to this course in the Classroom web UI. Read-only.
cCourseGroupEmail :: Lens' Course (Maybe Text) Source #
The email address of a Google group containing all members of the course. This group does not accept email and can only be used for permissions. Read-only.
cDescription :: Lens' Course (Maybe Text) Source #
Optional description. For example, "We'll be learning about the structure of living creatures from a combination of textbooks, guest lectures, and lab work. Expect to be excited!" If set, this field must be a valid UTF-8 string and no longer than 30,000 characters.
cDescriptionHeading :: Lens' Course (Maybe Text) Source #
Optional heading for the description. For example, "Welcome to 10th Grade Biology." If set, this field must be a valid UTF-8 string and no longer than 3600 characters.
cSection :: Lens' Course (Maybe Text) Source #
Section of the course. For example, "Period 2". If set, this field must be a valid UTF-8 string and no longer than 2800 characters.
TimeOfDay'
data TimeOfDay' Source #
Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may chose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`.
See: timeOfDay
smart constructor.
timeOfDay :: TimeOfDay' Source #
Creates a value of TimeOfDay
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
todNanos :: Lens' TimeOfDay' (Maybe Int32) Source #
Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
todHours :: Lens' TimeOfDay' (Maybe Int32) Source #
Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
todMinutes :: Lens' TimeOfDay' (Maybe Int32) Source #
Minutes of hour of day. Must be from 0 to 59.
todSeconds :: Lens' TimeOfDay' (Maybe Int32) Source #
Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
Assignment
data Assignment Source #
Additional details for assignments.
See: assignment
smart constructor.
assignment :: Assignment Source #
Creates a value of Assignment
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
aStudentWorkFolder :: Lens' Assignment (Maybe DriveFolder) Source #
Drive folder where attachments from student submissions are placed. This is only populated for course teachers.
ListStudentsResponse
data ListStudentsResponse Source #
Response when listing students.
See: listStudentsResponse
smart constructor.
listStudentsResponse :: ListStudentsResponse Source #
Creates a value of ListStudentsResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lsrNextPageToken :: Lens' ListStudentsResponse (Maybe Text) Source #
Token identifying the next page of results to return. If empty, no further results are available.
lsrStudents :: Lens' ListStudentsResponse [Student] Source #
Students who match the list request.
SharedDriveFile
data SharedDriveFile Source #
Drive file that is used as material for course work.
See: sharedDriveFile
smart constructor.
sharedDriveFile :: SharedDriveFile Source #
Creates a value of SharedDriveFile
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
sdfDriveFile :: Lens' SharedDriveFile (Maybe DriveFile) Source #
Drive file details.
sdfShareMode :: Lens' SharedDriveFile (Maybe Text) Source #
Mechanism by which students access the Drive item.
CourseAlias
data CourseAlias Source #
Alternative identifier for a course. An alias uniquely identifies a course. It must be unique within one of the following scopes: * domain: A domain-scoped alias is visible to all users within the alias creator's domain and can be created only by a domain admin. A domain-scoped alias is often used when a course has an identifier external to Classroom. * project: A project-scoped alias is visible to any request from an application using the Developer Console project ID that created the alias and can be created by any project. A project-scoped alias is often used when an application has alternative identifiers. A random value can also be used to avoid duplicate courses in the event of transmission failures, as retrying a request will return `ALREADY_EXISTS` if a previous one has succeeded.
See: courseAlias
smart constructor.
courseAlias :: CourseAlias Source #
Creates a value of CourseAlias
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
caAlias :: Lens' CourseAlias (Maybe Text) Source #
Alias string. The format of the string indicates the desired alias scoping. * `d:` indicates a domain-scoped alias. Example: `d:math_101` * `p:` indicates a project-scoped alias. Example: `p:abc123` This field has a maximum length of 256 characters.
Form
Google Forms item.
See: form
smart constructor.
Creates a value of Form
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
fResponseURL :: Lens' Form (Maybe Text) Source #
URL of the form responses document. Only set if respsonses have been recorded and only when the requesting user is an editor of the form. Read-only.
ListTeachersResponse
data ListTeachersResponse Source #
Response when listing teachers.
See: listTeachersResponse
smart constructor.
listTeachersResponse :: ListTeachersResponse Source #
Creates a value of ListTeachersResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ltrNextPageToken :: Lens' ListTeachersResponse (Maybe Text) Source #
Token identifying the next page of results to return. If empty, no further results are available.
ltrTeachers :: Lens' ListTeachersResponse [Teacher] Source #
Teachers who match the list request.
Student
Student in a course.
See: student
smart constructor.
Creates a value of Student
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
sProFile :: Lens' Student (Maybe UserProFile) Source #
Global user information for the student. Read-only.
sStudentWorkFolder :: Lens' Student (Maybe DriveFolder) Source #
Information about a Drive Folder for this student's work in this course. Only visible to the student and domain administrators. Read-only.