Represents a certain subset of settings for a course. More...
Public Member Functions | |
| CourseSettings (bool? allowFinalGradeOverride=null, bool? allowStudentDiscussionTopics=null, bool? allowStudentForumAttachments=null, bool? allowStudentDiscussionEditing=null, bool? gradingStandardEnabled=null, ulong? gradingStandardId=null, bool? allowStudentOrganizedGroups=null, bool? hideFinalGrades=null, bool? hideDistributionGraphs=null, bool? lockAllAnnouncements=null, bool? restrictStudentPastView=null, bool? restrictStudentFutureView=null, bool? showAnnouncementsOnHomePage=null, long? homePageAnnouncementLimit=null, bool? allowStudentDiscussionReporting=null, bool? allowStudentAnonymousDiscussionTopics=null, bool? filterSpeedGraderByStudentGroup=null, bool? hideSectionsOnCourseUsersPage=null, bool? usageRightsRequired=null, bool? syllabusCourseSummary=null, [CanBeNull] string defaultDueTime=null, bool? conditionalRelease=null) | |
| Creates a new CourseSettings instance, used to update course settings. Each optional argument corresponds to a property of this class. Set the property to update the value, or leave it unset to leave the value alone. More... | |
| string | ToPrettyString () |
| Returns a pretty, formatted string representation of the object. | |
Properties | |
| bool? | AllowFinalGradeOverride [get] |
| bool? | AllowStudentDiscussionTopics [get] |
| Allow students to create discussion topics. More... | |
| bool? | AllowStudentForumAttachments [get] |
| Allow students to upload attachments to discussions. More... | |
| bool? | AllowStudentDiscussionEditing [get] |
| Allow students to edit their own replies to discussions. More... | |
| bool? | GradingStandardEnabled [get] |
| ulong? | GradingStandardId [get] |
| bool? | AllowStudentOrganizedGroups [get] |
| Allow students to organize groups. More... | |
| bool? | HideFinalGrades [get] |
| Hide final grades in student views, showing only current grades. More... | |
| bool? | HideDistributionGraphs [get] |
| Hide grade distribution graphs in student views. More... | |
| bool? | LockAllAnnouncements [get] |
| Disable comments on all announcements. More... | |
| bool? | RestrictStudentPastView [get] |
| Forbid students from viewing the course after their enrollment end date. More... | |
| bool? | RestrictStudentFutureView [get] |
| Forbid students from viewing the course before their enrollment start date. More... | |
| bool? | ShowAnnouncementsOnHomePage [get] |
| Show announcements from this course on its homepage. More... | |
| long? | HomePageAnnouncementLimit [get] |
| How many announcements are shown via ShowAnnouncementsOnHomePage. More... | |
| bool? | AllowStudentDiscussionReporting [get] |
| Allow students to report discussion topics and replies. More... | |
| bool? | AllowStudentAnonymousDiscussionTopics [get] |
| Allow students to create anonymous discussion topics. More... | |
| bool? | FilterSpeedGraderByStudentGroup [get] |
| object | GradePassbackSetting [get] |
| bool? | HideSectionsOnCourseUsersPage [get] |
| In student views, hide users from sections besides the one which the current user belongs to. More... | |
| bool? | UsageRightsRequired [get] |
| Require course files to be accompanied by licensing information. More... | |
| bool? | SyllabusCourseSummary [get] |
| Show the course summary on the syllabus page. More... | |
| bool? | HomeroomCourse [get] |
| string | FriendlyName [get] |
| string | DefaultDueTime [get] |
| The default time shown in the interface when selecting an assignment due date. Can be 'inherit', which will inherit the global account setting. More... | |
| bool? | ConditionalRelease [get] |
| Enable conditional release of learning pathways for individual students. More... | |
Detailed Description
Represents a certain subset of settings for a course.
All of these settings are reflected through Api.GetCourseSettings, but some of them are only documented in other endpoints.
It is presumed that the undocumented settings cannot be updated through Api.UpdateCourseSettings, and must instead be updated through Api.EditCourse.
Constructor & Destructor Documentation
◆ CourseSettings()
|
inline |
Creates a new CourseSettings instance, used to update course settings. Each optional argument corresponds to a property of this class. Set the property to update the value, or leave it unset to leave the value alone.
Property Documentation
◆ AllowStudentAnonymousDiscussionTopics
|
get |
Allow students to create anonymous discussion topics.
◆ AllowStudentDiscussionEditing
|
get |
Allow students to edit their own replies to discussions.
◆ AllowStudentDiscussionReporting
|
get |
Allow students to report discussion topics and replies.
◆ AllowStudentDiscussionTopics
|
get |
Allow students to create discussion topics.
◆ AllowStudentForumAttachments
|
get |
Allow students to upload attachments to discussions.
◆ AllowStudentOrganizedGroups
|
get |
Allow students to organize groups.
◆ ConditionalRelease
|
get |
Enable conditional release of learning pathways for individual students.
◆ DefaultDueTime
|
get |
The default time shown in the interface when selecting an assignment due date.
Can be 'inherit', which will inherit the global account setting.
◆ FilterSpeedGraderByStudentGroup
|
get |
◆ HideDistributionGraphs
|
get |
Hide grade distribution graphs in student views.
◆ HideFinalGrades
|
get |
Hide final grades in student views, showing only current grades.
◆ HideSectionsOnCourseUsersPage
|
get |
In student views, hide users from sections besides the one which the current user belongs to.
◆ HomePageAnnouncementLimit
|
get |
How many announcements are shown via ShowAnnouncementsOnHomePage.
◆ LockAllAnnouncements
|
get |
Disable comments on all announcements.
◆ RestrictStudentFutureView
|
get |
Forbid students from viewing the course before their enrollment start date.
◆ RestrictStudentPastView
|
get |
Forbid students from viewing the course after their enrollment end date.
◆ ShowAnnouncementsOnHomePage
|
get |
Show announcements from this course on its homepage.
◆ SyllabusCourseSummary
|
get |
Show the course summary on the syllabus page.
◆ UsageRightsRequired
|
get |
Require course files to be accompanied by licensing information.
The documentation for this class was generated from the following file:
- UVACanvasAccess/Structures/Courses/CourseSettings.cs
