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. More... | |
| Task | UpdateSettings (CourseSettings cs) |
| Update this course's settings. More... | |
| IAsyncEnumerable< Enrollment > | StreamEnrollments (IEnumerable< Api.CourseEnrollmentRoleTypes > types=null, IEnumerable< Api.CourseEnrollmentState > states=null, Api.CourseEnrollmentIncludes? includes=null) |
| Streams all enrollments for this course. More... | |
| string | ToPrettyString () |
| Returns a pretty, formatted string representation of the object. | |
Properties | |
| ulong | Id [get] |
| The course id. More... | |
| string | SisCourseId [get] |
| The SIS course id. More... | |
| string | Uuid [get] |
| The course UUID. More... | |
| string | IntegrationId [get] |
| The integration id. More... | |
| ulong? | SisImportId [get] |
| The SIS import id. More... | |
| string | Name [get] |
| The name of the course. More... | |
| string | OriginalName [get] |
| The original name of the course, if the current user has a nickname set for this course. More... | |
| string | CourseCode [get] |
| The course code. More... | |
| string | WorkflowState [get] |
| The course's workflow state. One of: {unpublished, available, completed, deleted} More... | |
| ulong | AccountId [get] |
| The id of the account the course is under. More... | |
| ulong | RootAccountId [get] |
| The id of the root account the course is under. More... | |
| ulong | EnrollmentTermId [get] |
| The id of the enrollment term the course is under. More... | |
| ulong? | GradingStandardId [get] |
| The id of the grading standard associated with the course. More... | |
| DateTime | CreatedAt [get] |
| When the course was created. More... | |
| DateTime? | StartAt [get] |
| The start date of the course. More... | |
| DateTime? | EndAt [get] |
| The end date of the course. More... | |
| string | Locale [get] |
| The course's locale. More... | |
| IEnumerable< Enrollment > | Enrollments [get] |
| Any enrollments for this course which are associated with the current user. More... | |
| ulong? | TotalStudents [get] |
| The total amount of students in the course. More... | |
| string | CalendarLink [get] |
| The course calendar link. More... | |
| string | DefaultView [get] |
| The view type which users will first be shown when visiting the course page. More... | |
| string | SyllabusBody [get] |
| The content of the course syllabus. More... | |
| uint? | NeedsGradingCount [get] |
| The amount of submissions which need to be graded. More... | |
| Term | Term [get] |
| The enrollment term this course is under. More... | |
| CourseProgress | CourseProgress [get] |
| Course progress information. More... | |
| bool? | ApplyAssignmentGroupWeights [get] |
| Whether the course applies assignment group weights. More... | |
| Dictionary< string, bool > | Permissions [get] |
| The set of permissions the current user has in this course. More... | |
| bool? | IsPublic [get] |
| Whether the course is public More... | |
| bool? | IsPublicToAuthUsers [get] |
| Whether the course is visible to certain authorized users. More... | |
| bool? | PublicSyllabus [get] |
| Whether the course has a public syllabus. More... | |
| bool? | PublicSyllabusToAuth [get] |
| Whether the course has a syllabus visible to certain authorized users. More... | |
| string | PublicDescription [get] |
| The public course description, if any. More... | |
| ulong | StorageQuotaMb [get] |
| The course's storage quota, in MiB. More... | |
| ulong | StorageQuotaUsedMb [get] |
| How many MiB of the storage quota have been used. More... | |
| bool? | HideFinalGrades [get] |
| Whether the course hides final grades. More... | |
| string | License [get] |
| The course's license string. More... | |
| bool? | AllowStudentAssignmentEdits [get] |
| Whether the course allows assignment edits by students. More... | |
| bool? | AllowWikiComments [get] |
| Whether the course allows wiki comments. More... | |
| bool? | AllowStudentForumAttachments [get] |
| Whether the course allows forum attachments by students. More... | |
| bool? | OpenEnrollment [get] |
| Whether the course allows open enrollment. More... | |
| bool? | SelfEnrollment [get] |
| Whether the course allows self enrollment. More... | |
| bool? | RestrictEnrollmentsToCourseDates [get] |
| Whether enrollments are restricted to the dates during which a course is active. More... | |
| string | CourseFormat [get] |
| The course's format string. More... | |
| bool? | AccessRestrictedByDate [get] |
| Whether the current user has been prevented from viewing the course due to date restrictions. More... | |
| string | TimeZone [get] |
| The course's IANA time zone. More... | |
| bool? | Blueprint [get] |
| Whether this course is a blueprint course. More... | |
| Dictionary< string, bool > | BlueprintRestrictions [get] |
| Set of blueprint restrictions. More... | |
| Dictionary< string, Dictionary< string, bool > > | BlueprintRestrictionsByObjectType [get] |
| Object-differentiated blueprint restrictions. More... | |
Detailed Description
Represents a course.
Member Function Documentation
◆ GetSettings()
|
inline |
Get this course's settings.
- Returns
- This course's settings.
◆ StreamEnrollments()
|
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.
◆ UpdateSettings()
|
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
◆ AccessRestrictedByDate
|
get |
Whether the current user has been prevented from viewing the course due to date restrictions.
◆ AccountId
|
get |
The id of the account the course is under.
◆ AllowStudentAssignmentEdits
|
get |
Whether the course allows assignment edits by students.
◆ AllowStudentForumAttachments
|
get |
Whether the course allows forum attachments by students.
◆ AllowWikiComments
|
get |
Whether the course allows wiki comments.
◆ ApplyAssignmentGroupWeights
|
get |
Whether the course applies assignment group weights.
◆ Blueprint
|
get |
Whether this course is a blueprint course.
◆ BlueprintRestrictions
|
get |
Set of blueprint restrictions.
◆ BlueprintRestrictionsByObjectType
|
get |
Object-differentiated blueprint restrictions.
◆ CalendarLink
|
get |
The course calendar link.
◆ CourseCode
|
get |
The course code.
◆ CourseFormat
|
get |
The course's format string.
◆ CourseProgress
|
get |
Course progress information.
◆ CreatedAt
|
get |
When the course was created.
◆ DefaultView
|
get |
The view type which users will first be shown when visiting the course page.
◆ EndAt
|
get |
The end date of the course.
◆ Enrollments
|
get |
Any enrollments for this course which are associated with the current user.
◆ EnrollmentTermId
|
get |
The id of the enrollment term the course is under.
◆ GradingStandardId
|
get |
The id of the grading standard associated with the course.
◆ HideFinalGrades
|
get |
Whether the course hides final grades.
◆ Id
|
get |
The course id.
◆ IntegrationId
|
get |
The integration id.
◆ IsPublic
|
get |
Whether the course is public
◆ IsPublicToAuthUsers
|
get |
Whether the course is visible to certain authorized users.
◆ License
|
get |
The course's license string.
◆ Locale
|
get |
The course's locale.
◆ 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.
◆ NeedsGradingCount
|
get |
The amount of submissions which need to be graded.
◆ OpenEnrollment
|
get |
Whether the course allows open enrollment.
◆ OriginalName
|
get |
The original name of the course, if the current user has a nickname set for this course.
◆ Permissions
|
get |
The set of permissions the current user has in this course.
◆ PublicDescription
|
get |
The public course description, if any.
◆ PublicSyllabus
|
get |
Whether the course has a public syllabus.
◆ PublicSyllabusToAuth
|
get |
Whether the course has a syllabus visible to certain authorized users.
◆ RestrictEnrollmentsToCourseDates
|
get |
Whether enrollments are restricted to the dates during which a course is active.
◆ RootAccountId
|
get |
The id of the root account the course is under.
◆ SelfEnrollment
|
get |
Whether the course allows self enrollment.
◆ SisCourseId
|
get |
The SIS course id.
◆ SisImportId
|
get |
The SIS import id.
◆ StartAt
|
get |
The start date of the course.
◆ StorageQuotaMb
|
get |
The course's storage quota, in MiB.
◆ StorageQuotaUsedMb
|
get |
How many MiB of the storage quota have been used.
◆ SyllabusBody
|
get |
The content of the course syllabus.
◆ Term
|
get |
The enrollment term this course is under.
◆ TimeZone
|
get |
The course's IANA time zone.
◆ TotalStudents
|
get |
The total amount of students in the course.
◆ Uuid
|
get |
The course UUID.
◆ WorkflowState
|
get |
The course's workflow state. One of: {unpublished, available, completed, deleted}
The documentation for this class was generated from the following file:
- UVACanvasAccess/Structures/Courses/Course.cs
