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.announcements.create
- classroom.courses.announcements.delete
- classroom.courses.announcements.get
- classroom.courses.announcements.list
- classroom.courses.announcements.modifyAssignees
- classroom.courses.announcements.patch
- classroom.courses.courseWork.create
- classroom.courses.courseWork.delete
- classroom.courses.courseWork.get
- classroom.courses.courseWork.list
- classroom.courses.courseWork.modifyAssignees
- classroom.courses.courseWork.patch
- 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.registrations.create
- classroom.registrations.delete
- classroom.userProfiles.get
- classroom.userProfiles.guardianInvitations.create
- classroom.userProfiles.guardianInvitations.get
- classroom.userProfiles.guardianInvitations.list
- classroom.userProfiles.guardianInvitations.patch
- classroom.userProfiles.guardians.delete
- classroom.userProfiles.guardians.get
- classroom.userProfiles.guardians.list
- Types
- ListCourseAliasesResponse
- CourseWork
- GradeHistoryGradeChangeType
- GradeHistory
- CourseWorkChangesInfo
- ModifyCourseWorkAssigneesRequest
- CourseCourseState
- DriveFile
- GuardianInvitation
- Feed
- ModifyAnnouncementAssigneesRequest
- ReturnStudentSubmissionRequest
- StateHistoryState
- ReclaimStudentSubmissionRequest
- CourseWorkWorkType
- ListCourseWorkResponse
- Empty
- ModifyCourseWorkAssigneesRequestAssigneeMode
- GuardianInvitationState
- SharedDriveFileShareMode
- GlobalPermission
- Link
- ModifyAnnouncementAssigneesRequestAssigneeMode
- IndividualStudentsOptions
- AssignmentSubmission
- ModifyAttachmentsRequest
- ListAnnouncementsResponse
- AnnouncementAssigneeMode
- CourseWorkState
- ListStudentSubmissionsResponse
- Material
- MultipleChoiceSubmission
- ListInvitationsResponse
- Guardian
- CourseMaterial
- StudentSubmissionState
- ShortAnswerSubmission
- AnnouncementState
- Invitation
- Attachment
- Announcement
- StudentSubmission
- ListGuardiansResponse
- Date
- YouTubeVideo
- Teacher
- CourseMaterialSet
- Name
- ListCoursesResponse
- TurnInStudentSubmissionRequest
- Xgafv
- UserProFile
- DriveFolder
- SubmissionHistory
- StateHistory
- MultipleChoiceQuestion
- Course
- InvitationRole
- StudentSubmissionCourseWorkType
- TimeOfDay'
- FeedFeedType
- ListGuardianInvitationsResponse
- Assignment
- ListStudentsResponse
- SharedDriveFile
- CourseAlias
- CourseRosterChangesInfo
- ModifyIndividualStudentsOptions
- CloudPubsubTopic
- GlobalPermissionPermission
- CourseWorkAssigneeMode
- Form
- ListTeachersResponse
- Student
- CourseWorkSubmissionModificationMode
- Registration
Manages classes, rosters, and invitations in Google Classroom.
Synopsis
- classroomService :: ServiceConfig
- classroomRostersReadOnlyScope :: Proxy '["https://www.googleapis.com/auth/classroom.rosters.readonly"]
- classroomCoursesScope :: Proxy '["https://www.googleapis.com/auth/classroom.courses"]
- classroomPushNotificationsScope :: Proxy '["https://www.googleapis.com/auth/classroom.push-notifications"]
- 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"]
- classroomAnnouncementsReadOnlyScope :: Proxy '["https://www.googleapis.com/auth/classroom.announcements.readonly"]
- classroomGuardianlinksStudentsScope :: Proxy '["https://www.googleapis.com/auth/classroom.guardianlinks.students"]
- classroomStudentSubmissionsStudentsReadOnlyScope :: Proxy '["https://www.googleapis.com/auth/classroom.student-submissions.students.readonly"]
- classroomGuardianlinksMeReadOnlyScope :: Proxy '["https://www.googleapis.com/auth/classroom.guardianlinks.me.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"]
- classroomAnnouncementsScope :: Proxy '["https://www.googleapis.com/auth/classroom.announcements"]
- classroomCourseworkMeReadOnlyScope :: Proxy '["https://www.googleapis.com/auth/classroom.coursework.me.readonly"]
- classroomStudentSubmissionsMeReadOnlyScope :: Proxy '["https://www.googleapis.com/auth/classroom.student-submissions.me.readonly"]
- classroomGuardianlinksStudentsReadOnlyScope :: Proxy '["https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly"]
- type ClassroomAPI = InvitationsListResource :<|> (InvitationsAcceptResource :<|> (InvitationsGetResource :<|> (InvitationsCreateResource :<|> (InvitationsDeleteResource :<|> (CoursesCourseWorkStudentSubmissionsReturnResource :<|> (CoursesCourseWorkStudentSubmissionsListResource :<|> (CoursesCourseWorkStudentSubmissionsReclaimResource :<|> (CoursesCourseWorkStudentSubmissionsPatchResource :<|> (CoursesCourseWorkStudentSubmissionsGetResource :<|> (CoursesCourseWorkStudentSubmissionsTurnInResource :<|> (CoursesCourseWorkStudentSubmissionsModifyAttachmentsResource :<|> (CoursesCourseWorkListResource :<|> (CoursesCourseWorkPatchResource :<|> (CoursesCourseWorkGetResource :<|> (CoursesCourseWorkCreateResource :<|> (CoursesCourseWorkModifyAssigneesResource :<|> (CoursesCourseWorkDeleteResource :<|> (CoursesTeachersListResource :<|> (CoursesTeachersGetResource :<|> (CoursesTeachersCreateResource :<|> (CoursesTeachersDeleteResource :<|> (CoursesAnnouncementsListResource :<|> (CoursesAnnouncementsPatchResource :<|> (CoursesAnnouncementsGetResource :<|> (CoursesAnnouncementsCreateResource :<|> (CoursesAnnouncementsModifyAssigneesResource :<|> (CoursesAnnouncementsDeleteResource :<|> (CoursesAliasesListResource :<|> (CoursesAliasesCreateResource :<|> (CoursesAliasesDeleteResource :<|> (CoursesStudentsListResource :<|> (CoursesStudentsGetResource :<|> (CoursesStudentsCreateResource :<|> (CoursesStudentsDeleteResource :<|> (CoursesListResource :<|> (CoursesPatchResource :<|> (CoursesGetResource :<|> (CoursesCreateResource :<|> (CoursesDeleteResource :<|> (CoursesUpdateResource :<|> (UserProFilesGuardiansListResource :<|> (UserProFilesGuardiansGetResource :<|> (UserProFilesGuardiansDeleteResource :<|> (UserProFilesGuardianInvitationsListResource :<|> (UserProFilesGuardianInvitationsPatchResource :<|> (UserProFilesGuardianInvitationsGetResource :<|> (UserProFilesGuardianInvitationsCreateResource :<|> (UserProFilesGetResource :<|> (RegistrationsCreateResource :<|> RegistrationsDeleteResource)))))))))))))))))))))))))))))))))))))))))))))))))
- 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.Announcements.Create
- module Network.Google.Resource.Classroom.Courses.Announcements.Delete
- module Network.Google.Resource.Classroom.Courses.Announcements.Get
- module Network.Google.Resource.Classroom.Courses.Announcements.List
- module Network.Google.Resource.Classroom.Courses.Announcements.ModifyAssignees
- module Network.Google.Resource.Classroom.Courses.Announcements.Patch
- module Network.Google.Resource.Classroom.Courses.CourseWork.Create
- module Network.Google.Resource.Classroom.Courses.CourseWork.Delete
- module Network.Google.Resource.Classroom.Courses.CourseWork.Get
- module Network.Google.Resource.Classroom.Courses.CourseWork.List
- module Network.Google.Resource.Classroom.Courses.CourseWork.ModifyAssignees
- module Network.Google.Resource.Classroom.Courses.CourseWork.Patch
- 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.Registrations.Create
- module Network.Google.Resource.Classroom.Registrations.Delete
- module Network.Google.Resource.Classroom.UserProFiles.Get
- module Network.Google.Resource.Classroom.UserProFiles.GuardianInvitations.Create
- module Network.Google.Resource.Classroom.UserProFiles.GuardianInvitations.Get
- module Network.Google.Resource.Classroom.UserProFiles.GuardianInvitations.List
- module Network.Google.Resource.Classroom.UserProFiles.GuardianInvitations.Patch
- module Network.Google.Resource.Classroom.UserProFiles.Guardians.Delete
- module Network.Google.Resource.Classroom.UserProFiles.Guardians.Get
- module Network.Google.Resource.Classroom.UserProFiles.Guardians.List
- data ListCourseAliasesResponse
- listCourseAliasesResponse :: ListCourseAliasesResponse
- lcarNextPageToken :: Lens' ListCourseAliasesResponse (Maybe Text)
- lcarAliases :: Lens' ListCourseAliasesResponse [CourseAlias]
- data CourseWork
- courseWork :: CourseWork
- cwCreationTime :: Lens' CourseWork (Maybe UTCTime)
- cwScheduledTime :: Lens' CourseWork (Maybe UTCTime)
- cwState :: Lens' CourseWork (Maybe CourseWorkState)
- cwAssigneeMode :: Lens' CourseWork (Maybe CourseWorkAssigneeMode)
- cwMaterials :: Lens' CourseWork [Material]
- cwCourseId :: Lens' CourseWork (Maybe Text)
- cwIndividualStudentsOptions :: Lens' CourseWork (Maybe IndividualStudentsOptions)
- cwMaxPoints :: Lens' CourseWork (Maybe Double)
- cwWorkType :: Lens' CourseWork (Maybe CourseWorkWorkType)
- cwDueTime :: Lens' CourseWork (Maybe TimeOfDay')
- cwAssociatedWithDeveloper :: Lens' CourseWork (Maybe Bool)
- cwUpdateTime :: Lens' CourseWork (Maybe UTCTime)
- cwMultipleChoiceQuestion :: Lens' CourseWork (Maybe MultipleChoiceQuestion)
- cwId :: Lens' CourseWork (Maybe Text)
- cwSubmissionModificationMode :: Lens' CourseWork (Maybe CourseWorkSubmissionModificationMode)
- cwDueDate :: Lens' CourseWork (Maybe Date)
- cwCreatorUserId :: Lens' CourseWork (Maybe Text)
- cwTitle :: Lens' CourseWork (Maybe Text)
- cwAlternateLink :: Lens' CourseWork (Maybe Text)
- cwAssignment :: Lens' CourseWork (Maybe Assignment)
- cwDescription :: Lens' CourseWork (Maybe Text)
- data GradeHistoryGradeChangeType
- data GradeHistory
- gradeHistory :: GradeHistory
- ghGradeTimestamp :: Lens' GradeHistory (Maybe UTCTime)
- ghMaxPoints :: Lens' GradeHistory (Maybe Double)
- ghPointsEarned :: Lens' GradeHistory (Maybe Double)
- ghActorUserId :: Lens' GradeHistory (Maybe Text)
- ghGradeChangeType :: Lens' GradeHistory (Maybe GradeHistoryGradeChangeType)
- data CourseWorkChangesInfo
- courseWorkChangesInfo :: CourseWorkChangesInfo
- cwciCourseId :: Lens' CourseWorkChangesInfo (Maybe Text)
- data ModifyCourseWorkAssigneesRequest
- modifyCourseWorkAssigneesRequest :: ModifyCourseWorkAssigneesRequest
- mcwarAssigneeMode :: Lens' ModifyCourseWorkAssigneesRequest (Maybe ModifyCourseWorkAssigneesRequestAssigneeMode)
- mcwarModifyIndividualStudentsOptions :: Lens' ModifyCourseWorkAssigneesRequest (Maybe ModifyIndividualStudentsOptions)
- data CourseCourseState
- 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 GuardianInvitation
- guardianInvitation :: GuardianInvitation
- giCreationTime :: Lens' GuardianInvitation (Maybe UTCTime)
- giStudentId :: Lens' GuardianInvitation (Maybe Text)
- giState :: Lens' GuardianInvitation (Maybe GuardianInvitationState)
- giInvitationId :: Lens' GuardianInvitation (Maybe Text)
- giInvitedEmailAddress :: Lens' GuardianInvitation (Maybe Text)
- data Feed
- feed :: Feed
- fCourseWorkChangesInfo :: Lens' Feed (Maybe CourseWorkChangesInfo)
- fFeedType :: Lens' Feed (Maybe FeedFeedType)
- fCourseRosterChangesInfo :: Lens' Feed (Maybe CourseRosterChangesInfo)
- data ModifyAnnouncementAssigneesRequest
- modifyAnnouncementAssigneesRequest :: ModifyAnnouncementAssigneesRequest
- maarAssigneeMode :: Lens' ModifyAnnouncementAssigneesRequest (Maybe ModifyAnnouncementAssigneesRequestAssigneeMode)
- maarModifyIndividualStudentsOptions :: Lens' ModifyAnnouncementAssigneesRequest (Maybe ModifyIndividualStudentsOptions)
- data ReturnStudentSubmissionRequest
- returnStudentSubmissionRequest :: ReturnStudentSubmissionRequest
- data StateHistoryState
- data ReclaimStudentSubmissionRequest
- reclaimStudentSubmissionRequest :: ReclaimStudentSubmissionRequest
- data CourseWorkWorkType
- data ListCourseWorkResponse
- listCourseWorkResponse :: ListCourseWorkResponse
- lcwrCourseWork :: Lens' ListCourseWorkResponse [CourseWork]
- lcwrNextPageToken :: Lens' ListCourseWorkResponse (Maybe Text)
- data Empty
- empty :: Empty
- data ModifyCourseWorkAssigneesRequestAssigneeMode
- data GuardianInvitationState
- data SharedDriveFileShareMode
- data GlobalPermission
- globalPermission :: GlobalPermission
- gpPermission :: Lens' GlobalPermission (Maybe GlobalPermissionPermission)
- data Link
- link :: Link
- lThumbnailURL :: Lens' Link (Maybe Text)
- lURL :: Lens' Link (Maybe Text)
- lTitle :: Lens' Link (Maybe Text)
- data ModifyAnnouncementAssigneesRequestAssigneeMode
- data IndividualStudentsOptions
- individualStudentsOptions :: IndividualStudentsOptions
- isoStudentIds :: Lens' IndividualStudentsOptions [Text]
- data AssignmentSubmission
- assignmentSubmission :: AssignmentSubmission
- asAttachments :: Lens' AssignmentSubmission [Attachment]
- data ModifyAttachmentsRequest
- modifyAttachmentsRequest :: ModifyAttachmentsRequest
- marAddAttachments :: Lens' ModifyAttachmentsRequest [Attachment]
- data ListAnnouncementsResponse
- listAnnouncementsResponse :: ListAnnouncementsResponse
- larNextPageToken :: Lens' ListAnnouncementsResponse (Maybe Text)
- larAnnouncements :: Lens' ListAnnouncementsResponse [Announcement]
- data AnnouncementAssigneeMode
- data CourseWorkState
- 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 Guardian
- guardian :: Guardian
- gStudentId :: Lens' Guardian (Maybe Text)
- gGuardianId :: Lens' Guardian (Maybe Text)
- gInvitedEmailAddress :: Lens' Guardian (Maybe Text)
- gGuardianProFile :: Lens' Guardian (Maybe UserProFile)
- 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 StudentSubmissionState
- data ShortAnswerSubmission
- shortAnswerSubmission :: ShortAnswerSubmission
- sasAnswer :: Lens' ShortAnswerSubmission (Maybe Text)
- data AnnouncementState
- data Invitation
- invitation :: Invitation
- iCourseId :: Lens' Invitation (Maybe Text)
- iUserId :: Lens' Invitation (Maybe Text)
- iRole :: Lens' Invitation (Maybe InvitationRole)
- 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 Announcement
- announcement :: Announcement
- aCreationTime :: Lens' Announcement (Maybe UTCTime)
- aScheduledTime :: Lens' Announcement (Maybe UTCTime)
- aState :: Lens' Announcement (Maybe AnnouncementState)
- aAssigneeMode :: Lens' Announcement (Maybe AnnouncementAssigneeMode)
- aText :: Lens' Announcement (Maybe Text)
- aMaterials :: Lens' Announcement [Material]
- aCourseId :: Lens' Announcement (Maybe Text)
- aIndividualStudentsOptions :: Lens' Announcement (Maybe IndividualStudentsOptions)
- aUpdateTime :: Lens' Announcement (Maybe UTCTime)
- aId :: Lens' Announcement (Maybe Text)
- aCreatorUserId :: Lens' Announcement (Maybe Text)
- aAlternateLink :: Lens' Announcement (Maybe Text)
- data StudentSubmission
- studentSubmission :: StudentSubmission
- ssCreationTime :: Lens' StudentSubmission (Maybe UTCTime)
- ssLate :: Lens' StudentSubmission (Maybe Bool)
- ssState :: Lens' StudentSubmission (Maybe StudentSubmissionState)
- 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 UTCTime)
- ssCourseWorkType :: Lens' StudentSubmission (Maybe StudentSubmissionCourseWorkType)
- ssSubmissionHistory :: Lens' StudentSubmission [SubmissionHistory]
- 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 ListGuardiansResponse
- listGuardiansResponse :: ListGuardiansResponse
- lgrNextPageToken :: Lens' ListGuardiansResponse (Maybe Text)
- lgrGuardians :: Lens' ListGuardiansResponse [Guardian]
- 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 Xgafv
- data UserProFile
- userProFile :: UserProFile
- upfPhotoURL :: Lens' UserProFile (Maybe Text)
- upfVerifiedTeacher :: Lens' UserProFile (Maybe Bool)
- 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 SubmissionHistory
- submissionHistory :: SubmissionHistory
- shGradeHistory :: Lens' SubmissionHistory (Maybe GradeHistory)
- shStateHistory :: Lens' SubmissionHistory (Maybe StateHistory)
- data StateHistory
- stateHistory :: StateHistory
- shState :: Lens' StateHistory (Maybe StateHistoryState)
- shActorUserId :: Lens' StateHistory (Maybe Text)
- shStateTimestamp :: Lens' StateHistory (Maybe UTCTime)
- data MultipleChoiceQuestion
- multipleChoiceQuestion :: MultipleChoiceQuestion
- mcqChoices :: Lens' MultipleChoiceQuestion [Text]
- data Course
- course :: Course
- couCreationTime :: Lens' Course (Maybe UTCTime)
- couRoom :: Lens' Course (Maybe Text)
- couCourseMaterialSets :: Lens' Course [CourseMaterialSet]
- couCalendarId :: Lens' Course (Maybe Text)
- couTeacherGroupEmail :: Lens' Course (Maybe Text)
- couTeacherFolder :: Lens' Course (Maybe DriveFolder)
- couCourseState :: Lens' Course (Maybe CourseCourseState)
- couGuardiansEnabled :: Lens' Course (Maybe Bool)
- couEnrollmentCode :: Lens' Course (Maybe Text)
- couUpdateTime :: Lens' Course (Maybe UTCTime)
- couOwnerId :: Lens' Course (Maybe Text)
- couName :: Lens' Course (Maybe Text)
- couId :: Lens' Course (Maybe Text)
- couAlternateLink :: Lens' Course (Maybe Text)
- couCourseGroupEmail :: Lens' Course (Maybe Text)
- couDescription :: Lens' Course (Maybe Text)
- couDescriptionHeading :: Lens' Course (Maybe Text)
- couSection :: Lens' Course (Maybe Text)
- data InvitationRole
- data StudentSubmissionCourseWorkType
- 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 FeedFeedType
- data ListGuardianInvitationsResponse
- listGuardianInvitationsResponse :: ListGuardianInvitationsResponse
- lgirNextPageToken :: Lens' ListGuardianInvitationsResponse (Maybe Text)
- lgirGuardianInvitations :: Lens' ListGuardianInvitationsResponse [GuardianInvitation]
- 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 SharedDriveFileShareMode)
- data CourseAlias
- courseAlias :: CourseAlias
- caAlias :: Lens' CourseAlias (Maybe Text)
- data CourseRosterChangesInfo
- courseRosterChangesInfo :: CourseRosterChangesInfo
- crciCourseId :: Lens' CourseRosterChangesInfo (Maybe Text)
- data ModifyIndividualStudentsOptions
- modifyIndividualStudentsOptions :: ModifyIndividualStudentsOptions
- misoAddStudentIds :: Lens' ModifyIndividualStudentsOptions [Text]
- misoRemoveStudentIds :: Lens' ModifyIndividualStudentsOptions [Text]
- data CloudPubsubTopic
- cloudPubsubTopic :: CloudPubsubTopic
- cptTopicName :: Lens' CloudPubsubTopic (Maybe Text)
- data GlobalPermissionPermission
- data CourseWorkAssigneeMode
- 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)
- data CourseWorkSubmissionModificationMode
- data Registration
- registration :: Registration
- rRegistrationId :: Lens' Registration (Maybe Text)
- rExpiryTime :: Lens' Registration (Maybe UTCTime)
- rFeed :: Lens' Registration (Maybe Feed)
- rCloudPubsubTopic :: Lens' Registration (Maybe CloudPubsubTopic)
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
classroomPushNotificationsScope :: Proxy '["https://www.googleapis.com/auth/classroom.push-notifications"] Source #
Receive notifications about your Google Classroom data
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
classroomAnnouncementsReadOnlyScope :: Proxy '["https://www.googleapis.com/auth/classroom.announcements.readonly"] Source #
View announcements in Google Classroom
classroomGuardianlinksStudentsScope :: Proxy '["https://www.googleapis.com/auth/classroom.guardianlinks.students"] Source #
View and manage guardians for students 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
classroomGuardianlinksMeReadOnlyScope :: Proxy '["https://www.googleapis.com/auth/classroom.guardianlinks.me.readonly"] Source #
View your Google Classroom guardians
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
classroomAnnouncementsScope :: Proxy '["https://www.googleapis.com/auth/classroom.announcements"] Source #
View and manage announcements in Google Classroom
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
classroomGuardianlinksStudentsReadOnlyScope :: Proxy '["https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly"] Source #
View guardians for students in your Google Classroom classes
API Declaration
type ClassroomAPI = InvitationsListResource :<|> (InvitationsAcceptResource :<|> (InvitationsGetResource :<|> (InvitationsCreateResource :<|> (InvitationsDeleteResource :<|> (CoursesCourseWorkStudentSubmissionsReturnResource :<|> (CoursesCourseWorkStudentSubmissionsListResource :<|> (CoursesCourseWorkStudentSubmissionsReclaimResource :<|> (CoursesCourseWorkStudentSubmissionsPatchResource :<|> (CoursesCourseWorkStudentSubmissionsGetResource :<|> (CoursesCourseWorkStudentSubmissionsTurnInResource :<|> (CoursesCourseWorkStudentSubmissionsModifyAttachmentsResource :<|> (CoursesCourseWorkListResource :<|> (CoursesCourseWorkPatchResource :<|> (CoursesCourseWorkGetResource :<|> (CoursesCourseWorkCreateResource :<|> (CoursesCourseWorkModifyAssigneesResource :<|> (CoursesCourseWorkDeleteResource :<|> (CoursesTeachersListResource :<|> (CoursesTeachersGetResource :<|> (CoursesTeachersCreateResource :<|> (CoursesTeachersDeleteResource :<|> (CoursesAnnouncementsListResource :<|> (CoursesAnnouncementsPatchResource :<|> (CoursesAnnouncementsGetResource :<|> (CoursesAnnouncementsCreateResource :<|> (CoursesAnnouncementsModifyAssigneesResource :<|> (CoursesAnnouncementsDeleteResource :<|> (CoursesAliasesListResource :<|> (CoursesAliasesCreateResource :<|> (CoursesAliasesDeleteResource :<|> (CoursesStudentsListResource :<|> (CoursesStudentsGetResource :<|> (CoursesStudentsCreateResource :<|> (CoursesStudentsDeleteResource :<|> (CoursesListResource :<|> (CoursesPatchResource :<|> (CoursesGetResource :<|> (CoursesCreateResource :<|> (CoursesDeleteResource :<|> (CoursesUpdateResource :<|> (UserProFilesGuardiansListResource :<|> (UserProFilesGuardiansGetResource :<|> (UserProFilesGuardiansDeleteResource :<|> (UserProFilesGuardianInvitationsListResource :<|> (UserProFilesGuardianInvitationsPatchResource :<|> (UserProFilesGuardianInvitationsGetResource :<|> (UserProFilesGuardianInvitationsCreateResource :<|> (UserProFilesGetResource :<|> (RegistrationsCreateResource :<|> RegistrationsDeleteResource))))))))))))))))))))))))))))))))))))))))))))))))) 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.announcements.create
classroom.courses.announcements.delete
classroom.courses.announcements.get
classroom.courses.announcements.list
classroom.courses.announcements.modifyAssignees
classroom.courses.announcements.patch
classroom.courses.courseWork.create
classroom.courses.courseWork.delete
classroom.courses.courseWork.get
classroom.courses.courseWork.list
classroom.courses.courseWork.modifyAssignees
classroom.courses.courseWork.patch
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.registrations.create
classroom.registrations.delete
classroom.userProfiles.get
classroom.userProfiles.guardianInvitations.create
classroom.userProfiles.guardianInvitations.get
classroom.userProfiles.guardianInvitations.list
classroom.userProfiles.guardianInvitations.patch
classroom.userProfiles.guardians.delete
classroom.userProfiles.guardians.get
classroom.userProfiles.guardians.list
Types
ListCourseAliasesResponse
data ListCourseAliasesResponse Source #
Response when listing course aliases.
See: listCourseAliasesResponse
smart constructor.
Instances
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.
Instances
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 UTCTime) Source #
Timestamp when this course work was created. Read-only.
cwScheduledTime :: Lens' CourseWork (Maybe UTCTime) Source #
Optional timestamp when this course work is scheduled to be published.
cwState :: Lens' CourseWork (Maybe CourseWorkState) Source #
Status of this course work. If unspecified, the default state is `DRAFT`.
cwAssigneeMode :: Lens' CourseWork (Maybe CourseWorkAssigneeMode) Source #
Assignee mode of the coursework. If unspecified, the default value is `ALL_STUDENTS`.
cwMaterials :: Lens' CourseWork [Material] Source #
Additional materials. CourseWork must have no more than 20 material items.
cwCourseId :: Lens' CourseWork (Maybe Text) Source #
Identifier of the course. Read-only.
cwIndividualStudentsOptions :: Lens' CourseWork (Maybe IndividualStudentsOptions) Source #
Identifiers of students with access to the coursework. This field is set only if `assigneeMode` is `INDIVIDUAL_STUDENTS`. If the `assigneeMode` is `INDIVIDUAL_STUDENTS`, then only students specified in this field will be assigned the coursework.
cwMaxPoints :: Lens' CourseWork (Maybe Double) Source #
Maximum grade for this course work. If zero or unspecified, this assignment is considered ungraded. This must be a non-negative integer value.
cwWorkType :: Lens' CourseWork (Maybe CourseWorkWorkType) Source #
Type of this course work. The type is set when the course work is created and cannot be changed.
cwDueTime :: Lens' CourseWork (Maybe TimeOfDay') Source #
Optional time of day, in UTC, that submissions for 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 UTCTime) Source #
Timestamp of the most recent change to this course work. Read-only.
cwMultipleChoiceQuestion :: Lens' CourseWork (Maybe MultipleChoiceQuestion) Source #
Multiple choice question details. For read operations, this field is populated only when `work_type` is `MULTIPLE_CHOICE_QUESTION`. For write operations, this field must be specified when creating course work with a `work_type` of `MULTIPLE_CHOICE_QUESTION`, and it must not be set otherwise.
cwId :: Lens' CourseWork (Maybe Text) Source #
Classroom-assigned identifier of this course work, unique per course. Read-only.
cwSubmissionModificationMode :: Lens' CourseWork (Maybe CourseWorkSubmissionModificationMode) 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 course work are due. This must be specified if `due_time` is specified.
cwCreatorUserId :: Lens' CourseWork (Maybe Text) Source #
Identifier for the user that created the coursework. Read-only.
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`. Read-only.
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.
GradeHistoryGradeChangeType
data GradeHistoryGradeChangeType Source #
The type of grade change at this time in the submission grade history.
UnknownGradeChangeType |
|
DraftGradePointsEarnedChange |
|
AssignedGradePointsEarnedChange |
|
MaxPointsChange |
|
Instances
GradeHistory
data GradeHistory Source #
The history of each grade on this submission.
See: gradeHistory
smart constructor.
Instances
gradeHistory :: GradeHistory Source #
Creates a value of GradeHistory
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ghGradeTimestamp :: Lens' GradeHistory (Maybe UTCTime) Source #
When the grade of the submission was changed.
ghMaxPoints :: Lens' GradeHistory (Maybe Double) Source #
The denominator of the grade at this time in the submission grade history.
ghPointsEarned :: Lens' GradeHistory (Maybe Double) Source #
The numerator of the grade at this time in the submission grade history.
ghActorUserId :: Lens' GradeHistory (Maybe Text) Source #
The teacher who made the grade change.
ghGradeChangeType :: Lens' GradeHistory (Maybe GradeHistoryGradeChangeType) Source #
The type of grade change at this time in the submission grade history.
CourseWorkChangesInfo
data CourseWorkChangesInfo Source #
Information about a `Feed` with a `feed_type` of `COURSE_WORK_CHANGES`.
See: courseWorkChangesInfo
smart constructor.
Instances
courseWorkChangesInfo :: CourseWorkChangesInfo Source #
Creates a value of CourseWorkChangesInfo
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
cwciCourseId :: Lens' CourseWorkChangesInfo (Maybe Text) Source #
The `course_id` of the course to subscribe to work changes for.
ModifyCourseWorkAssigneesRequest
data ModifyCourseWorkAssigneesRequest Source #
Request to modify assignee mode and options of a coursework.
See: modifyCourseWorkAssigneesRequest
smart constructor.
Instances
modifyCourseWorkAssigneesRequest :: ModifyCourseWorkAssigneesRequest Source #
Creates a value of ModifyCourseWorkAssigneesRequest
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
mcwarAssigneeMode :: Lens' ModifyCourseWorkAssigneesRequest (Maybe ModifyCourseWorkAssigneesRequestAssigneeMode) Source #
Mode of the coursework describing whether it will be assigned to all students or specified individual students.
mcwarModifyIndividualStudentsOptions :: Lens' ModifyCourseWorkAssigneesRequest (Maybe ModifyIndividualStudentsOptions) Source #
Set which students are assigned or not assigned to the coursework. Must be specified only when `assigneeMode` is `INDIVIDUAL_STUDENTS`.
CourseCourseState
data CourseCourseState Source #
State of the course. If unspecified, the default state is `PROVISIONED`.
CourseStateUnspecified |
|
Active |
|
Archived |
|
Provisioned |
|
Declined |
|
Suspended |
|
Instances
DriveFile
Representation of a Google Drive file.
See: driveFile
smart constructor.
Instances
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.
GuardianInvitation
data GuardianInvitation Source #
An invitation to become the guardian of a specified user, sent to a specified email address.
See: guardianInvitation
smart constructor.
Instances
guardianInvitation :: GuardianInvitation Source #
Creates a value of GuardianInvitation
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
giCreationTime :: Lens' GuardianInvitation (Maybe UTCTime) Source #
The time that this invitation was created. Read-only.
giStudentId :: Lens' GuardianInvitation (Maybe Text) Source #
ID of the student (in standard format)
giState :: Lens' GuardianInvitation (Maybe GuardianInvitationState) Source #
The state that this invitation is in.
giInvitationId :: Lens' GuardianInvitation (Maybe Text) Source #
Unique identifier for this invitation. Read-only.
giInvitedEmailAddress :: Lens' GuardianInvitation (Maybe Text) Source #
Email address that the invitation was sent to. This field is only visible to domain administrators.
Feed
A class of notifications that an application can register to receive. For example: "all roster changes for a domain".
See: feed
smart constructor.
Instances
Eq Feed Source # | |
Data Feed Source # | |
Defined in Network.Google.Classroom.Types.Product gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Feed -> c Feed # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Feed # dataTypeOf :: Feed -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Feed) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Feed) # gmapT :: (forall b. Data b => b -> b) -> Feed -> Feed # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Feed -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Feed -> r # gmapQ :: (forall d. Data d => d -> u) -> Feed -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Feed -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Feed -> m Feed # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Feed -> m Feed # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Feed -> m Feed # | |
Show Feed Source # | |
Generic Feed Source # | |
ToJSON Feed Source # | |
Defined in Network.Google.Classroom.Types.Product | |
FromJSON Feed Source # | |
type Rep Feed Source # | |
Defined in Network.Google.Classroom.Types.Product type Rep Feed = D1 (MetaData "Feed" "Network.Google.Classroom.Types.Product" "gogol-classroom-0.4.0-8aa8kYGMMJyCKn01TYMpOR" False) (C1 (MetaCons "Feed'" PrefixI True) (S1 (MetaSel (Just "_fCourseWorkChangesInfo") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe CourseWorkChangesInfo)) :*: (S1 (MetaSel (Just "_fFeedType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe FeedFeedType)) :*: S1 (MetaSel (Just "_fCourseRosterChangesInfo") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe CourseRosterChangesInfo))))) |
Creates a value of Feed
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
fCourseWorkChangesInfo :: Lens' Feed (Maybe CourseWorkChangesInfo) Source #
Information about a `Feed` with a `feed_type` of `COURSE_WORK_CHANGES`. This field must be specified if `feed_type` is `COURSE_WORK_CHANGES`.
fCourseRosterChangesInfo :: Lens' Feed (Maybe CourseRosterChangesInfo) Source #
Information about a `Feed` with a `feed_type` of `COURSE_ROSTER_CHANGES`. This field must be specified if `feed_type` is `COURSE_ROSTER_CHANGES`.
ModifyAnnouncementAssigneesRequest
data ModifyAnnouncementAssigneesRequest Source #
Request to modify assignee mode and options of an announcement.
See: modifyAnnouncementAssigneesRequest
smart constructor.
Instances
modifyAnnouncementAssigneesRequest :: ModifyAnnouncementAssigneesRequest Source #
Creates a value of ModifyAnnouncementAssigneesRequest
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
maarAssigneeMode :: Lens' ModifyAnnouncementAssigneesRequest (Maybe ModifyAnnouncementAssigneesRequestAssigneeMode) Source #
Mode of the announcement describing whether it will be accessible by all students or specified individual students.
maarModifyIndividualStudentsOptions :: Lens' ModifyAnnouncementAssigneesRequest (Maybe ModifyIndividualStudentsOptions) Source #
Set which students can view or cannot view the announcement. Must be specified only when `assigneeMode` is `INDIVIDUAL_STUDENTS`.
ReturnStudentSubmissionRequest
data ReturnStudentSubmissionRequest Source #
Request to return a student submission.
See: returnStudentSubmissionRequest
smart constructor.
Instances
returnStudentSubmissionRequest :: ReturnStudentSubmissionRequest Source #
Creates a value of ReturnStudentSubmissionRequest
with the minimum fields required to make a request.
StateHistoryState
data StateHistoryState Source #
The workflow pipeline stage.
StateUnspecified |
|
Created |
|
TurnedIn |
|
Returned |
|
ReclaimedByStudent |
|
StudentEditedAfterTurnIn |
|
Instances
ReclaimStudentSubmissionRequest
data ReclaimStudentSubmissionRequest Source #
Request to reclaim a student submission.
See: reclaimStudentSubmissionRequest
smart constructor.
Instances
reclaimStudentSubmissionRequest :: ReclaimStudentSubmissionRequest Source #
Creates a value of ReclaimStudentSubmissionRequest
with the minimum fields required to make a request.
CourseWorkWorkType
data CourseWorkWorkType Source #
Type of this course work. The type is set when the course work is created and cannot be changed.
CWWTCourseWorkTypeUnspecified |
|
CWWTAssignment |
|
CWWTShortAnswerQuestion |
|
CWWTMultipleChoiceQuestion |
|
Instances
ListCourseWorkResponse
data ListCourseWorkResponse Source #
Response when listing course work.
See: listCourseWorkResponse
smart constructor.
Instances
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.
Instances
Eq Empty Source # | |
Data Empty Source # | |
Defined in Network.Google.Classroom.Types.Product gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Empty -> c Empty # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Empty # dataTypeOf :: Empty -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Empty) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Empty) # gmapT :: (forall b. Data b => b -> b) -> Empty -> Empty # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Empty -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Empty -> r # gmapQ :: (forall d. Data d => d -> u) -> Empty -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Empty -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Empty -> m Empty # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Empty -> m Empty # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Empty -> m Empty # | |
Show Empty Source # | |
Generic Empty Source # | |
ToJSON Empty Source # | |
Defined in Network.Google.Classroom.Types.Product | |
FromJSON Empty Source # | |
type Rep Empty Source # | |
ModifyCourseWorkAssigneesRequestAssigneeMode
data ModifyCourseWorkAssigneesRequestAssigneeMode Source #
Mode of the coursework describing whether it will be assigned to all students or specified individual students.
AssigneeModeUnspecified |
|
AllStudents |
|
IndividualStudents |
|
Instances
GuardianInvitationState
data GuardianInvitationState Source #
The state that this invitation is in.
GuardianInvitationStateUnspecified |
|
Pending |
|
Complete |
|
Instances
SharedDriveFileShareMode
data SharedDriveFileShareMode Source #
Mechanism by which students access the Drive item.
UnknownShareMode |
|
View |
|
Edit |
|
StudentCopy |
|
GlobalPermission
data GlobalPermission Source #
Global user permission description.
See: globalPermission
smart constructor.
Instances
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 GlobalPermissionPermission) Source #
Permission value.
Link
URL item.
See: link
smart constructor.
Instances
Eq Link Source # | |
Data Link Source # | |
Defined in Network.Google.Classroom.Types.Product gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Link -> c Link # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Link # dataTypeOf :: Link -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Link) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Link) # gmapT :: (forall b. Data b => b -> b) -> Link -> Link # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Link -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Link -> r # gmapQ :: (forall d. Data d => d -> u) -> Link -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Link -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Link -> m Link # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Link -> m Link # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Link -> m Link # | |
Show Link Source # | |
Generic Link Source # | |
ToJSON Link Source # | |
Defined in Network.Google.Classroom.Types.Product | |
FromJSON Link Source # | |
type Rep Link Source # | |
Defined in Network.Google.Classroom.Types.Product type Rep Link = D1 (MetaData "Link" "Network.Google.Classroom.Types.Product" "gogol-classroom-0.4.0-8aa8kYGMMJyCKn01TYMpOR" False) (C1 (MetaCons "Link'" PrefixI True) (S1 (MetaSel (Just "_lThumbnailURL") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_lURL") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_lTitle") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) |
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.
ModifyAnnouncementAssigneesRequestAssigneeMode
data ModifyAnnouncementAssigneesRequestAssigneeMode Source #
Mode of the announcement describing whether it will be accessible by all students or specified individual students.
MAARAMAssigneeModeUnspecified |
|
MAARAMAllStudents |
|
MAARAMIndividualStudents |
|
Instances
IndividualStudentsOptions
data IndividualStudentsOptions Source #
Assignee details about a coursework/announcement. This field is set if and only if `assigneeMode` is `INDIVIDUAL_STUDENTS`.
See: individualStudentsOptions
smart constructor.
Instances
individualStudentsOptions :: IndividualStudentsOptions Source #
Creates a value of IndividualStudentsOptions
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
isoStudentIds :: Lens' IndividualStudentsOptions [Text] Source #
Identifiers for the students that have access to the coursework/announcement.
AssignmentSubmission
data AssignmentSubmission Source #
Student work for an assignment.
See: assignmentSubmission
smart constructor.
Instances
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 STUDENT_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 always 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.
Instances
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. A student submission may not have more than 20 attachments. Form attachments are not supported.
ListAnnouncementsResponse
data ListAnnouncementsResponse Source #
Response when listing course work.
See: listAnnouncementsResponse
smart constructor.
Instances
listAnnouncementsResponse :: ListAnnouncementsResponse Source #
Creates a value of ListAnnouncementsResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
larNextPageToken :: Lens' ListAnnouncementsResponse (Maybe Text) Source #
Token identifying the next page of results to return. If empty, no further results are available.
larAnnouncements :: Lens' ListAnnouncementsResponse [Announcement] Source #
Announcement items that match the request.
AnnouncementAssigneeMode
data AnnouncementAssigneeMode Source #
Assignee mode of the announcement. If unspecified, the default value is `ALL_STUDENTS`.
AAMAssigneeModeUnspecified |
|
AAMAllStudents |
|
AAMIndividualStudents |
|
Instances
CourseWorkState
data CourseWorkState Source #
Status of this course work. If unspecified, the default state is `DRAFT`.
CourseWorkStateUnspecified |
|
Published |
|
Draft |
|
Deleted |
|
Instances
ListStudentSubmissionsResponse
data ListStudentSubmissionsResponse Source #
Response when listing student submissions.
See: listStudentSubmissionsResponse
smart constructor.
Instances
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, setting the `form` field is not supported.
See: material
smart constructor.
Instances
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.
mLink :: Lens' Material (Maybe Link) Source #
Link material. On creation, will be upgraded to a more appropriate type if possible, and this will be reflected in the response.
mYouTubeVideo :: Lens' Material (Maybe YouTubeVideo) Source #
YouTube video material.
MultipleChoiceSubmission
data MultipleChoiceSubmission Source #
Student work for a multiple-choice question.
See: multipleChoiceSubmission
smart constructor.
Instances
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.
Instances
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.
Guardian
Association between a student and a guardian of that student. The guardian may receive information about the student's course work.
See: guardian
smart constructor.
Instances
Eq Guardian Source # | |
Data Guardian Source # | |
Defined in Network.Google.Classroom.Types.Product gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Guardian -> c Guardian # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Guardian # toConstr :: Guardian -> Constr # dataTypeOf :: Guardian -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Guardian) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Guardian) # gmapT :: (forall b. Data b => b -> b) -> Guardian -> Guardian # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Guardian -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Guardian -> r # gmapQ :: (forall d. Data d => d -> u) -> Guardian -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Guardian -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Guardian -> m Guardian # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Guardian -> m Guardian # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Guardian -> m Guardian # | |
Show Guardian Source # | |
Generic Guardian Source # | |
ToJSON Guardian Source # | |
Defined in Network.Google.Classroom.Types.Product | |
FromJSON Guardian Source # | |
type Rep Guardian Source # | |
Defined in Network.Google.Classroom.Types.Product type Rep Guardian = D1 (MetaData "Guardian" "Network.Google.Classroom.Types.Product" "gogol-classroom-0.4.0-8aa8kYGMMJyCKn01TYMpOR" False) (C1 (MetaCons "Guardian'" PrefixI True) ((S1 (MetaSel (Just "_gStudentId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_gGuardianId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_gInvitedEmailAddress") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_gGuardianProFile") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe UserProFile))))) |
Creates a value of Guardian
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
gStudentId :: Lens' Guardian (Maybe Text) Source #
Identifier for the student to whom the guardian relationship applies.
gInvitedEmailAddress :: Lens' Guardian (Maybe Text) Source #
The email address to which the initial guardian invitation was sent. This field is only visible to domain administrators.
gGuardianProFile :: Lens' Guardian (Maybe UserProFile) Source #
User profile for the guardian.
CourseMaterial
data CourseMaterial Source #
A material attached to a course as part of a material set.
See: courseMaterial
smart constructor.
Instances
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.
StudentSubmissionState
data StudentSubmissionState Source #
State of this submission. Read-only.
SSSSubmissionStateUnspecified |
|
SSSNew |
|
SSSCreated |
|
SSSTurnedIn |
|
SSSReturned |
|
SSSReclaimedByStudent |
|
Instances
ShortAnswerSubmission
data ShortAnswerSubmission Source #
Student work for a short answer question.
See: shortAnswerSubmission
smart constructor.
Instances
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.
AnnouncementState
data AnnouncementState Source #
Status of this announcement. If unspecified, the default state is `DRAFT`.
ASAnnouncementStateUnspecified |
|
ASPublished |
|
ASDraft |
|
ASDeleted |
|
Instances
Invitation
data Invitation Source #
An invitation to join a course.
See: invitation
smart constructor.
Instances
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 InvitationRole) 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, setting the `form` field is not supported.
See: attachment
smart constructor.
Instances
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.
Announcement
data Announcement Source #
Announcement created by a teacher for students of the course
See: announcement
smart constructor.
Instances
announcement :: Announcement Source #
Creates a value of Announcement
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
aCreationTime :: Lens' Announcement (Maybe UTCTime) Source #
Timestamp when this announcement was created. Read-only.
aScheduledTime :: Lens' Announcement (Maybe UTCTime) Source #
Optional timestamp when this announcement is scheduled to be published.
aState :: Lens' Announcement (Maybe AnnouncementState) Source #
Status of this announcement. If unspecified, the default state is `DRAFT`.
aAssigneeMode :: Lens' Announcement (Maybe AnnouncementAssigneeMode) Source #
Assignee mode of the announcement. If unspecified, the default value is `ALL_STUDENTS`.
aText :: Lens' Announcement (Maybe Text) Source #
Description of this announcement. The text must be a valid UTF-8 string containing no more than 30,000 characters.
aMaterials :: Lens' Announcement [Material] Source #
Additional materials. Announcements must have no more than 20 material items.
aIndividualStudentsOptions :: Lens' Announcement (Maybe IndividualStudentsOptions) Source #
Identifiers of students with access to the announcement. This field is set only if `assigneeMode` is `INDIVIDUAL_STUDENTS`. If the `assigneeMode` is `INDIVIDUAL_STUDENTS`, then only students specified in this field will be able to see the announcement.
aUpdateTime :: Lens' Announcement (Maybe UTCTime) Source #
Timestamp of the most recent change to this announcement. Read-only.
aId :: Lens' Announcement (Maybe Text) Source #
Classroom-assigned identifier of this announcement, unique per course. Read-only.
aCreatorUserId :: Lens' Announcement (Maybe Text) Source #
Identifier for the user that created the announcement. Read-only.
aAlternateLink :: Lens' Announcement (Maybe Text) Source #
Absolute link to this announcement in the Classroom web UI. This is only populated if `state` is `PUBLISHED`. Read-only.
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.
Instances
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 UTCTime) Source #
Creation time of this submission. This may be unset if the student has not accessed this item. Read-only.
ssState :: Lens' StudentSubmission (Maybe StudentSubmissionState) Source #
State of this submission. 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 MULTIPLE_CHOICE_QUESTION.
ssAssignmentSubmission :: Lens' StudentSubmission (Maybe AssignmentSubmission) Source #
Submission content when course_work_type is ASSIGNMENT. Students can modify this content using google.classroom.Work.ModifyAttachments.
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 UTCTime) 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 StudentSubmissionCourseWorkType) Source #
Type of course work this submission is for. Read-only.
ssSubmissionHistory :: Lens' StudentSubmission [SubmissionHistory] Source #
The history of the submission (includes state and grade histories). Read-only.
ssAssignedGrade :: Lens' StudentSubmission (Maybe Double) Source #
Optional grade. If unset, no grade was set. This value must be non-negative. Decimal (i.e. non-integer) values are allowed, but will be rounded to two decimal places. 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 value must be non-negative. Decimal (i.e. non-integer) values are allowed, but will be rounded to two decimal places. 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.
ListGuardiansResponse
data ListGuardiansResponse Source #
Response when listing guardians.
See: listGuardiansResponse
smart constructor.
Instances
listGuardiansResponse :: ListGuardiansResponse Source #
Creates a value of ListGuardiansResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lgrNextPageToken :: Lens' ListGuardiansResponse (Maybe Text) Source #
Token identifying the next page of results to return. If empty, no further results are available.
lgrGuardians :: Lens' ListGuardiansResponse [Guardian] Source #
Guardians on this page of results that met the criteria specified in the request.
Date
Represents a whole or partial calendar date, e.g. a birthday. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the Proleptic Gregorian Calendar. This can represent: * A full date, with non-zero year, month and day values * A month and day value, with a zero year, e.g. an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, e.g. a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.
See: date
smart constructor.
Instances
Eq Date Source # | |
Data Date Source # | |
Defined in Network.Google.Classroom.Types.Product gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Date -> c Date # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Date # dataTypeOf :: Date -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Date) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Date) # gmapT :: (forall b. Data b => b -> b) -> Date -> Date # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Date -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Date -> r # gmapQ :: (forall d. Data d => d -> u) -> Date -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Date -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Date -> m Date # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Date -> m Date # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Date -> m Date # | |
Show Date Source # | |
Generic Date Source # | |
ToJSON Date Source # | |
Defined in Network.Google.Classroom.Types.Product | |
FromJSON Date Source # | |
type Rep Date Source # | |
Defined in Network.Google.Classroom.Types.Product type Rep Date = D1 (MetaData "Date" "Network.Google.Classroom.Types.Product" "gogol-classroom-0.4.0-8aa8kYGMMJyCKn01TYMpOR" False) (C1 (MetaCons "Date'" PrefixI True) (S1 (MetaSel (Just "_dDay") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int32))) :*: (S1 (MetaSel (Just "_dYear") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int32))) :*: S1 (MetaSel (Just "_dMonth") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int32)))))) |
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 by itself or a year and 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.
dMonth :: Lens' Date (Maybe Int32) Source #
Month of year. Must be from 1 to 12, or 0 if specifying a year without a month and day.
YouTubeVideo
data YouTubeVideo Source #
YouTube video item.
See: youTubeVideo
smart constructor.
Instances
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.
Instances
Eq Teacher Source # | |
Data Teacher Source # | |
Defined in Network.Google.Classroom.Types.Product gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Teacher -> c Teacher # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Teacher # toConstr :: Teacher -> Constr # dataTypeOf :: Teacher -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Teacher) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Teacher) # gmapT :: (forall b. Data b => b -> b) -> Teacher -> Teacher # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Teacher -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Teacher -> r # gmapQ :: (forall d. Data d => d -> u) -> Teacher -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Teacher -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Teacher -> m Teacher # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Teacher -> m Teacher # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Teacher -> m Teacher # | |
Show Teacher Source # | |
Generic Teacher Source # | |
ToJSON Teacher Source # | |
Defined in Network.Google.Classroom.Types.Product | |
FromJSON Teacher Source # | |
type Rep Teacher Source # | |
Defined in Network.Google.Classroom.Types.Product type Rep Teacher = D1 (MetaData "Teacher" "Network.Google.Classroom.Types.Product" "gogol-classroom-0.4.0-8aa8kYGMMJyCKn01TYMpOR" False) (C1 (MetaCons "Teacher'" PrefixI True) (S1 (MetaSel (Just "_tCourseId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_tProFile") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe UserProFile)) :*: S1 (MetaSel (Just "_tUserId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) |
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.
Instances
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.
Instances
Eq Name Source # | |
Data Name Source # | |
Defined in Network.Google.Classroom.Types.Product gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Name -> c Name # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Name # dataTypeOf :: Name -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Name) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Name) # gmapT :: (forall b. Data b => b -> b) -> Name -> Name # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Name -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Name -> r # gmapQ :: (forall d. Data d => d -> u) -> Name -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Name -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Name -> m Name # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Name -> m Name # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Name -> m Name # | |
Show Name Source # | |
Generic Name Source # | |
ToJSON Name Source # | |
Defined in Network.Google.Classroom.Types.Product | |
FromJSON Name Source # | |
type Rep Name Source # | |
Defined in Network.Google.Classroom.Types.Product type Rep Name = D1 (MetaData "Name" "Network.Google.Classroom.Types.Product" "gogol-classroom-0.4.0-8aa8kYGMMJyCKn01TYMpOR" False) (C1 (MetaCons "Name'" PrefixI True) (S1 (MetaSel (Just "_nGivenName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_nFullName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_nFamilyName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) |
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.
Instances
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.
Instances
turnInStudentSubmissionRequest :: TurnInStudentSubmissionRequest Source #
Creates a value of TurnInStudentSubmissionRequest
with the minimum fields required to make a request.
Xgafv
V1 error format.
Instances
UserProFile
data UserProFile Source #
Global information for a user.
See: userProFile
smart constructor.
Instances
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.
upfVerifiedTeacher :: Lens' UserProFile (Maybe Bool) Source #
Represents whether a G Suite for Education user's domain administrator has explicitly verified them as being a teacher. If the user is not a member of a G Suite for Education domain, than this field will always be false. 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.
Instances
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.
SubmissionHistory
data SubmissionHistory Source #
The history of the submission. This currently includes state and grade histories.
See: submissionHistory
smart constructor.
Instances
submissionHistory :: SubmissionHistory Source #
Creates a value of SubmissionHistory
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
shGradeHistory :: Lens' SubmissionHistory (Maybe GradeHistory) Source #
The grade history information of the submission, if present.
shStateHistory :: Lens' SubmissionHistory (Maybe StateHistory) Source #
The state history information of the submission, if present.
StateHistory
data StateHistory Source #
The history of each state this submission has been in.
See: stateHistory
smart constructor.
Instances
stateHistory :: StateHistory Source #
Creates a value of StateHistory
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
shState :: Lens' StateHistory (Maybe StateHistoryState) Source #
The workflow pipeline stage.
shActorUserId :: Lens' StateHistory (Maybe Text) Source #
The teacher or student who made the change
shStateTimestamp :: Lens' StateHistory (Maybe UTCTime) Source #
When the submission entered this state.
MultipleChoiceQuestion
data MultipleChoiceQuestion Source #
Additional details for multiple-choice questions.
See: multipleChoiceQuestion
smart constructor.
Instances
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.
Instances
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:
couCreationTime :: Lens' Course (Maybe UTCTime) Source #
Creation time of the course. Specifying this field in a course update mask results in an error. Read-only.
couRoom :: 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.
couCourseMaterialSets :: Lens' Course [CourseMaterialSet] Source #
Sets of materials that appear on the "about" page of this course. Read-only.
couCalendarId :: Lens' Course (Maybe Text) Source #
The Calendar ID for a calendar that all course members can see, to which Classroom adds events for course work and announcements in the course. Read-only.
couTeacherGroupEmail :: 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.
couTeacherFolder :: 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.
couCourseState :: Lens' Course (Maybe CourseCourseState) Source #
State of the course. If unspecified, the default state is `PROVISIONED`.
couGuardiansEnabled :: Lens' Course (Maybe Bool) Source #
Whether or not guardian notifications are enabled for this course. Read-only.
couEnrollmentCode :: 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.
couUpdateTime :: Lens' Course (Maybe UTCTime) Source #
Time of the most recent update to this course. Specifying this field in a course update mask results in an error. Read-only.
couOwnerId :: 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. Admins can also specify this field in a patch course request to transfer ownership. In other contexts, it is read-only.
couName :: 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.
couId :: 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.
couAlternateLink :: Lens' Course (Maybe Text) Source #
Absolute link to this course in the Classroom web UI. Read-only.
couCourseGroupEmail :: 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.
couDescription :: 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.
couDescriptionHeading :: 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.
couSection :: 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.
InvitationRole
data InvitationRole Source #
Role to invite the user to have. Must not be `COURSE_ROLE_UNSPECIFIED`.
IRCourseRoleUnspecified |
|
IRStudent |
|
IRTeacher |
|
IROwner |
|
Instances
StudentSubmissionCourseWorkType
data StudentSubmissionCourseWorkType Source #
Type of course work this submission is for. Read-only.
SSCWTCourseWorkTypeUnspecified |
|
SSCWTAssignment |
|
SSCWTShortAnswerQuestion |
|
SSCWTMultipleChoiceQuestion |
|
Instances
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 choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`.
See: timeOfDay
smart constructor.
Instances
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.
FeedFeedType
data FeedFeedType Source #
The type of feed.
FeedTypeUnspecified |
|
DomainRosterChanges |
|
CourseRosterChanges |
|
CourseWorkChanges |
|
Instances
ListGuardianInvitationsResponse
data ListGuardianInvitationsResponse Source #
Response when listing guardian invitations.
See: listGuardianInvitationsResponse
smart constructor.
Instances
listGuardianInvitationsResponse :: ListGuardianInvitationsResponse Source #
Creates a value of ListGuardianInvitationsResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lgirNextPageToken :: Lens' ListGuardianInvitationsResponse (Maybe Text) Source #
Token identifying the next page of results to return. If empty, no further results are available.
lgirGuardianInvitations :: Lens' ListGuardianInvitationsResponse [GuardianInvitation] Source #
Guardian invitations that matched the list request.
Assignment
data Assignment Source #
Additional details for assignments.
See: assignment
smart constructor.
Instances
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 and administrators.
ListStudentsResponse
data ListStudentsResponse Source #
Response when listing students.
See: listStudentsResponse
smart constructor.
Instances
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 SharedDriveFileShareMode) 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.
Instances
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.
CourseRosterChangesInfo
data CourseRosterChangesInfo Source #
Information about a `Feed` with a `feed_type` of `COURSE_ROSTER_CHANGES`.
See: courseRosterChangesInfo
smart constructor.
Instances
courseRosterChangesInfo :: CourseRosterChangesInfo Source #
Creates a value of CourseRosterChangesInfo
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
crciCourseId :: Lens' CourseRosterChangesInfo (Maybe Text) Source #
The `course_id` of the course to subscribe to roster changes for.
ModifyIndividualStudentsOptions
data ModifyIndividualStudentsOptions Source #
Contains fields to add or remove students from a course work or announcement where the `assigneeMode` is set to `INDIVIDUAL_STUDENTS`.
See: modifyIndividualStudentsOptions
smart constructor.
Instances
modifyIndividualStudentsOptions :: ModifyIndividualStudentsOptions Source #
Creates a value of ModifyIndividualStudentsOptions
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
misoAddStudentIds :: Lens' ModifyIndividualStudentsOptions [Text] Source #
Ids of students to be added as having access to this coursework/announcement.
misoRemoveStudentIds :: Lens' ModifyIndividualStudentsOptions [Text] Source #
Ids of students to be removed from having access to this coursework/announcement.
CloudPubsubTopic
data CloudPubsubTopic Source #
A reference to a Cloud Pub/Sub topic. To register for notifications, the owner of the topic must grant `classroom-notifications'system.gserviceaccount.com` the `projects.topics.publish` permission.
See: cloudPubsubTopic
smart constructor.
Instances
cloudPubsubTopic :: CloudPubsubTopic Source #
Creates a value of CloudPubsubTopic
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
cptTopicName :: Lens' CloudPubsubTopic (Maybe Text) Source #
The `name` field of a Cloud Pub/Sub Topic.
GlobalPermissionPermission
data GlobalPermissionPermission Source #
Permission value.
PermissionUnspecified |
|
CreateCourse |
|
Instances
CourseWorkAssigneeMode
data CourseWorkAssigneeMode Source #
Assignee mode of the coursework. If unspecified, the default value is `ALL_STUDENTS`.
CWAMAssigneeModeUnspecified |
|
CWAMAllStudents |
|
CWAMIndividualStudents |
|
Instances
Form
Google Forms item.
See: form
smart constructor.
Instances
Eq Form Source # | |
Data Form Source # | |
Defined in Network.Google.Classroom.Types.Product gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Form -> c Form # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Form # dataTypeOf :: Form -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Form) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Form) # gmapT :: (forall b. Data b => b -> b) -> Form -> Form # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Form -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Form -> r # gmapQ :: (forall d. Data d => d -> u) -> Form -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Form -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Form -> m Form # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Form -> m Form # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Form -> m Form # | |
Show Form Source # | |
Generic Form Source # | |
ToJSON Form Source # | |
Defined in Network.Google.Classroom.Types.Product | |
FromJSON Form Source # | |
type Rep Form Source # | |
Defined in Network.Google.Classroom.Types.Product type Rep Form = D1 (MetaData "Form" "Network.Google.Classroom.Types.Product" "gogol-classroom-0.4.0-8aa8kYGMMJyCKn01TYMpOR" False) (C1 (MetaCons "Form'" PrefixI True) ((S1 (MetaSel (Just "_fThumbnailURL") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_fFormURL") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_fTitle") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_fResponseURL") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) |
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.
Instances
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.
Instances
Eq Student Source # | |
Data Student Source # | |
Defined in Network.Google.Classroom.Types.Product gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Student -> c Student # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Student # toConstr :: Student -> Constr # dataTypeOf :: Student -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Student) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Student) # gmapT :: (forall b. Data b => b -> b) -> Student -> Student # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Student -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Student -> r # gmapQ :: (forall d. Data d => d -> u) -> Student -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Student -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Student -> m Student # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Student -> m Student # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Student -> m Student # | |
Show Student Source # | |
Generic Student Source # | |
ToJSON Student Source # | |
Defined in Network.Google.Classroom.Types.Product | |
FromJSON Student Source # | |
type Rep Student Source # | |
Defined in Network.Google.Classroom.Types.Product type Rep Student = D1 (MetaData "Student" "Network.Google.Classroom.Types.Product" "gogol-classroom-0.4.0-8aa8kYGMMJyCKn01TYMpOR" False) (C1 (MetaCons "Student'" PrefixI True) ((S1 (MetaSel (Just "_sCourseId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_sProFile") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe UserProFile))) :*: (S1 (MetaSel (Just "_sStudentWorkFolder") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe DriveFolder)) :*: S1 (MetaSel (Just "_sUserId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) |
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.
sUserId :: Lens' Student (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
CourseWorkSubmissionModificationMode
data CourseWorkSubmissionModificationMode Source #
Setting to determine when students are allowed to modify submissions. If unspecified, the default value is `MODIFIABLE_UNTIL_TURNED_IN`.
SubmissionModificationModeUnspecified |
|
ModifiableUntilTurnedIn |
|
Modifiable |
|
Instances
Registration
data Registration Source #
An instruction to Classroom to send notifications from the `feed` to the provided destination.
See: registration
smart constructor.
Instances
registration :: Registration Source #
Creates a value of Registration
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rRegistrationId :: Lens' Registration (Maybe Text) Source #
A server-generated unique identifier for this `Registration`. Read-only.
rExpiryTime :: Lens' Registration (Maybe UTCTime) Source #
The time until which the `Registration` is effective. This is a read-only field assigned by the server.
rFeed :: Lens' Registration (Maybe Feed) Source #
Specification for the class of notifications that Classroom should deliver to the destination.
rCloudPubsubTopic :: Lens' Registration (Maybe CloudPubsubTopic) Source #
The Cloud Pub/Sub topic that notifications are to be sent to.