UVACanvasAccess.Structures.Courses.Course Class Reference

Represents a course. More...

Inheritance diagram for UVACanvasAccess.Structures.Courses.Course:

Collaboration diagram for UVACanvasAccess.Structures.Courses.Course:

Public Member Functions
Task< CourseSettings >	GetSettings ()
	Get this course's settings.
Task	UpdateSettings (CourseSettings cs)
	Update this course's settings.
IAsyncEnumerable< Enrollment >	StreamEnrollments (IEnumerable< Api.CourseEnrollmentRoleTypes > types=null, IEnumerable< Api.CourseEnrollmentState > states=null, Api.CourseEnrollmentIncludes? includes=null)
	Streams all enrollments for this course.
string	ToPrettyString ()
	Returns a pretty, formatted string representation of the object. Returns The formatted string.

Properties
ulong	Id [get]
	The course id.
string	SisCourseId [get]
	The SIS course id.
string	Uuid [get]
	The course UUID.
string	IntegrationId [get]
	The integration id.
ulong?	SisImportId [get]
	The SIS import id.
string	Name [get]
	The name of the course.
string	OriginalName [get]
	The original name of the course, if the current user has a nickname set for this course.
string	CourseCode [get]
	The course code.
string	WorkflowState [get]
	The course's workflow state. One of: {unpublished, available, completed, deleted}.
ulong	AccountId [get]
	The id of the account the course is under.
ulong	RootAccountId [get]
	The id of the root account the course is under.
ulong	EnrollmentTermId [get]
	The id of the enrollment term the course is under.
ulong?	GradingStandardId [get]
	The id of the grading standard associated with the course.
DateTime	CreatedAt [get]
	When the course was created.
DateTime?	StartAt [get]
	The start date of the course.
DateTime?	EndAt [get]
	The end date of the course.
string	Locale [get]
	The course's locale.
IEnumerable< Enrollment >	Enrollments [get]
	Any enrollments for this course which are associated with the current user.
ulong?	TotalStudents [get]
	The total amount of students in the course.
string	CalendarLink [get]
	The course calendar link.
string	DefaultView [get]
	The view type which users will first be shown when visiting the course page.
string	SyllabusBody [get]
	The content of the course syllabus.
uint?	NeedsGradingCount [get]
	The amount of submissions which need to be graded.
Term	Term [get]
	The enrollment term this course is under.
CourseProgress	CourseProgress [get]
	Course progress information.
bool?	ApplyAssignmentGroupWeights [get]
	Whether the course applies assignment group weights.
Dictionary< string, bool >	Permissions [get]
	The set of permissions the current user has in this course.
bool?	IsPublic [get]
	Whether the course is public.
bool?	IsPublicToAuthUsers [get]
	Whether the course is visible to certain authorized users.
bool?	PublicSyllabus [get]
	Whether the course has a public syllabus.
bool?	PublicSyllabusToAuth [get]
	Whether the course has a syllabus visible to certain authorized users.
string	PublicDescription [get]
	The public course description, if any.
ulong	StorageQuotaMb [get]
	The course's storage quota, in MiB.
ulong	StorageQuotaUsedMb [get]
	How many MiB of the storage quota have been used.
bool?	HideFinalGrades [get]
	Whether the course hides final grades.
string	License [get]
	The course's license string.
bool?	AllowStudentAssignmentEdits [get]
	Whether the course allows assignment edits by students.
bool?	AllowWikiComments [get]
	Whether the course allows wiki comments.
bool?	AllowStudentForumAttachments [get]
	Whether the course allows forum attachments by students.
bool?	OpenEnrollment [get]
	Whether the course allows open enrollment.
bool?	SelfEnrollment [get]
	Whether the course allows self enrollment.
bool?	RestrictEnrollmentsToCourseDates [get]
	Whether enrollments are restricted to the dates during which a course is active.
string	CourseFormat [get]
	The course's format string.
bool?	AccessRestrictedByDate [get]
	Whether the current user has been prevented from viewing the course due to date restrictions.
string	TimeZone [get]
	The course's IANA time zone.
bool?	Blueprint [get]
	Whether this course is a blueprint course.
Dictionary< string, bool >	BlueprintRestrictions [get]
	Set of blueprint restrictions.
Dictionary< string, Dictionary< string, bool > >	BlueprintRestrictionsByObjectType [get]
	Object-differentiated blueprint restrictions.

Detailed Description

Represents a course.

Member Function Documentation

GetSettings()

Task< CourseSettings > UVACanvasAccess.Structures.Courses.Course.GetSettings ( )

inline

Get this course's settings.

Returns

This course's settings.

StreamEnrollments()

IAsyncEnumerable< Enrollment > UVACanvasAccess.Structures.Courses.Course.StreamEnrollments ( IEnumerable< Api::CourseEnrollmentRoleTypes >  types = null, IEnumerable< Api::CourseEnrollmentState >  states = null, Api::CourseEnrollmentIncludes?  includes = null  )

inline

Streams all enrollments for this course.

Parameters

types	(Optional) The set of enrollment types to filter by.
states	(Optional) The set of enrollment states to filter by.
includes	(Optional) Data to include in the result.

Returns

The stream of enrollments.

ToPrettyString()

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

inline

Returns a pretty, formatted string representation of the object.

Returns

The formatted string.

Implements UVACanvasAccess.Util.IPrettyPrint.

UpdateSettings()

Task UVACanvasAccess.Structures.Courses.Course.UpdateSettings ( CourseSettings  cs )

inline

Update this course's settings.

Parameters

cs	The new settings to apply.

Returns

A Task which will complete when the operation finishes.

Property Documentation

Name

string UVACanvasAccess.Structures.Courses.Course.Name

get

The name of the course.

If the current user has a nickname set for this course, the nickname will be reflected here. OriginalName will contain the original name.

---

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

• UVACanvasAccess/Structures/Courses/Course.cs