Represents a certain subset of settings for a course. More...

Inheritance diagram for UVACanvasAccess.Structures.Courses.CourseSettings:

Collaboration diagram for UVACanvasAccess.Structures.Courses.CourseSettings:

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.

string	ToPrettyString ()
	Returns a pretty, formatted string representation of the object. Returns The formatted string.

Properties
bool?	AllowFinalGradeOverride `[get]`

bool?	AllowStudentDiscussionTopics `[get]`
	Allow students to create discussion topics.

bool?	AllowStudentForumAttachments `[get]`
	Allow students to upload attachments to discussions.

bool?	AllowStudentDiscussionEditing `[get]`
	Allow students to edit their own replies to discussions.

bool?	GradingStandardEnabled `[get]`

ulong?	GradingStandardId `[get]`

bool?	AllowStudentOrganizedGroups `[get]`
	Allow students to organize groups.

bool?	HideFinalGrades `[get]`
	Hide final grades in student views, showing only current grades.

bool?	HideDistributionGraphs `[get]`
	Hide grade distribution graphs in student views.

bool?	LockAllAnnouncements `[get]`
	Disable comments on all announcements.

bool?	RestrictStudentPastView `[get]`
	Forbid students from viewing the course after their enrollment end date.

bool?	RestrictStudentFutureView `[get]`
	Forbid students from viewing the course before their enrollment start date.

bool?	ShowAnnouncementsOnHomePage `[get]`
	Show announcements from this course on its homepage.

long?	HomePageAnnouncementLimit `[get]`
	How many announcements are shown via ShowAnnouncementsOnHomePage.

bool?	AllowStudentDiscussionReporting `[get]`
	Allow students to report discussion topics and replies.

bool?	AllowStudentAnonymousDiscussionTopics `[get]`
	Allow students to create anonymous discussion topics.

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.

bool?	UsageRightsRequired `[get]`
	Require course files to be accompanied by licensing information.

bool?	SyllabusCourseSummary `[get]`
	Show the course summary on the syllabus page.

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.

bool?	ConditionalRelease `[get]`
	Enable conditional release of learning pathways for individual students.

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.

Member Function Documentation

◆ ToPrettyString()

string UVACanvasAccess.Structures.Courses.CourseSettings.ToPrettyString ( )

inline

Returns a pretty, formatted string representation of the object.

Returns: The formatted string.

Implements UVACanvasAccess.Util.IPrettyPrint.

The documentation for this class was generated from the following file:

UVACanvasAccess/Structures/Courses/CourseSettings.cs

Public Member Functions

Properties

Detailed Description

Member Function Documentation

◆ ToPrettyString()