Represents an enrollment of a user in a course. More...

Inheritance diagram for UVACanvasAccess.Structures.Enrollments.Enrollment:

Collaboration diagram for UVACanvasAccess.Structures.Enrollments.Enrollment:

Public Member Functions
Task< Enrollment >	Conclude ()
	Concludes this enrollment without deleting it. This is the same action that occurs automatically when the user reaches the end of their time in the course, such as at the end of the school year. More...

Task< Enrollment >	Delete ()
	Irrecoverably deletes this enrollment. More...

Task< Enrollment >	Deactivate ()
	Sets an enrollment to Api.CourseEnrollmentState.Inactive. More...

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

Properties
ulong	Id `[get]`
	The enrollment id. More...

ulong	CourseId `[get]`
	The id of the course which the user is enrolled in. More...

string	SisCourseId `[get]`
	The SIS id of the course which the user is enrolled in. More...

string	CourseIntegrationId `[get]`
	The course integration id. More...

ulong?	CourseSectionId `[get]`
	The id of the section within the course which the user is enrolled in. More...

string	SectionIntegrationId `[get]`
	The section integration id. More...

string	SisAccountId `[get]`
	The SIS id of the account the enrollment is under. More...

string	SisSectionId `[get]`
	The SIS id of the section within the course which the user is enrolled in. More...

string	SisUserId `[get]`
	The SIS id of the user involved in the enrollment. More...

Api.? CourseEnrollmentState	EnrollmentState `[get]`
	The state of the enrollment. More...

bool?	LimitPrivilegesToCourseSection `[get]`
	Whether the user is limited to their own section within the course. More...

ulong?	SisImportId `[get]`
	The SIS import id. More...

ulong?	RootAccountId `[get]`
	The root account id of the account the enrollment is under. More...

Api.? CourseEnrollmentRoleTypes	Type `[get]`
	The type of enrollment. More...

ulong	UserId `[get]`
	The id of the user involved in the enrollment. More...

ulong?	AssociatedUserId `[get]`
	If the Type is Api.CourseEnrollmentRoleTypes.ObserverEnrollment, the id of the observed user. More...

string	Role `[get]`
	The enrollment role in the course. May match Type, but individual courses may also customize these roles. More...

ulong	RoleId `[get]`
	The id of the enrollment role. More...

DateTime?	CreatedAt `[get]`
	When the enrollment was created. More...

DateTime?	UpdatedAt `[get]`
	When the enrollment was last updated. More...

DateTime?	StartAt `[get]`
	When the enrollment begins. More...

DateTime?	EndAt `[get]`
	When the enrollment concludes. More...

DateTime?	LastActivityAt `[get]`
	The last activity time for the user in the context of the enrollment. More...

DateTime?	LastAttendedAt `[get]`
	The last attendance time for the user in the context of the enrollment. More...

ulong?	TotalActivityTime `[get]`
	The activity total time, in seconds, for the user in the context of the enrollment. More...

string	HtmlUrl `[get]`
	The URL to the Canvas webpage displaying this enrollment. More...

Grade	Grades `[get]`
	The user's grade summary in this enrollment. More...

UserDisplay	User `[get]`
	A UserDisplay for the user involved in the enrollment. More...

string	OverrideGrade `[get]`
	The override grade. More...

decimal?	OverrideScore `[get]`
	The override score. More...

string	UnpostedCurrentGrade `[get]`
	The user's current grade in the course, including unposted assignments. More...

string	UnpostedFinalGrade `[get]`
	The user's final grade in the course, including unposted assignments. More...

string	UnpostedCurrentScore `[get]`
	The user's current score in the course, including unposted assignments. More...

string	UnpostedFinalScore `[get]`
	The user's final score in the course, including unposted assignments. More...

bool?	HasGradingPeriods `[get]`
	Whether the course has grading periods. More...

bool?	TotalsForAllGradingPeriodsOption `[get]`
	Whether the course has the 'Display Totals for All Grading Periods' option enabled. More...

string	CurrentGradingPeriodTitle `[get]`
	The title of the current grading period, if the course has grading periods. More...

ulong?	CurrentGradingPeriodId `[get]`
	The id of the current grading period, if the course has grading periods. More...

string	CurrentPeriodOverrideGrade `[get]`
	The override grade for the current grading period, if the course has grading periods. More...

decimal?	CurrentPeriodOverrideScore `[get]`
	The override score for the current grading period, if the course has grading periods. More...

decimal?	CurrentPeriodUnpostedFinalScore `[get]`
	The user's final score in the course for the current grading period, including unposted assignments, if the course has grading periods. More...

string	CurrentPeriodUnpostedCurrentGrade `[get]`
	The user's current grade in the course for the current grading period, including unposted assignments, if the course has grading periods. More...

string	CurrentPeriodUnpostedFinalGrade `[get]`
	The user's final grade in the course for the current grading period, including unposted assignments, if the course has grading periods. More...

Detailed Description

Represents an enrollment of a user in a course.

Member Function Documentation

◆ Conclude()

Task<Enrollment> UVACanvasAccess.Structures.Enrollments.Enrollment.Conclude ( )

inline

Concludes this enrollment without deleting it.
This is the same action that occurs automatically when the user reaches the end of their time in the course, such as at the end of the school year.

Returns: The concluded enrollment.

This object will be outdated once the operation completes. Use the returned object instead.

◆ Deactivate()

Task<Enrollment> UVACanvasAccess.Structures.Enrollments.Enrollment.Deactivate ( )

inline

Sets an enrollment to Api.CourseEnrollmentState.Inactive.

Returns: The inactivated enrollment.

This object will be outdated once the operation completes. Use the returned object instead.

◆ Delete()

Task<Enrollment> UVACanvasAccess.Structures.Enrollments.Enrollment.Delete ( )

inline

Irrecoverably deletes this enrollment.

Returns: The deleted enrollment.

This object will be outdated once the operation completes. Use the returned object instead.

Property Documentation

◆ AssociatedUserId

ulong? UVACanvasAccess.Structures.Enrollments.Enrollment.AssociatedUserId

get

If the Type is Api.CourseEnrollmentRoleTypes.ObserverEnrollment, the id of the observed user.

◆ CourseId

ulong UVACanvasAccess.Structures.Enrollments.Enrollment.CourseId

get

The id of the course which the user is enrolled in.

◆ CourseIntegrationId

string UVACanvasAccess.Structures.Enrollments.Enrollment.CourseIntegrationId

get

The course integration id.

◆ CourseSectionId

ulong? UVACanvasAccess.Structures.Enrollments.Enrollment.CourseSectionId

get

The id of the section within the course which the user is enrolled in.

◆ CreatedAt

DateTime? UVACanvasAccess.Structures.Enrollments.Enrollment.CreatedAt

get

When the enrollment was created.

◆ CurrentGradingPeriodId

ulong? UVACanvasAccess.Structures.Enrollments.Enrollment.CurrentGradingPeriodId

get

The id of the current grading period, if the course has grading periods.

◆ CurrentGradingPeriodTitle

string UVACanvasAccess.Structures.Enrollments.Enrollment.CurrentGradingPeriodTitle

get

The title of the current grading period, if the course has grading periods.

◆ CurrentPeriodOverrideGrade

string UVACanvasAccess.Structures.Enrollments.Enrollment.CurrentPeriodOverrideGrade

get

The override grade for the current grading period, if the course has grading periods.

◆ CurrentPeriodOverrideScore

decimal? UVACanvasAccess.Structures.Enrollments.Enrollment.CurrentPeriodOverrideScore

get

The override score for the current grading period, if the course has grading periods.

◆ CurrentPeriodUnpostedCurrentGrade

string UVACanvasAccess.Structures.Enrollments.Enrollment.CurrentPeriodUnpostedCurrentGrade

get

The user's current grade in the course for the current grading period, including unposted assignments, if the course has grading periods.

◆ CurrentPeriodUnpostedFinalGrade

string UVACanvasAccess.Structures.Enrollments.Enrollment.CurrentPeriodUnpostedFinalGrade

get

The user's final grade in the course for the current grading period, including unposted assignments, if the course has grading periods.

◆ CurrentPeriodUnpostedFinalScore

decimal? UVACanvasAccess.Structures.Enrollments.Enrollment.CurrentPeriodUnpostedFinalScore

get

The user's final score in the course for the current grading period, including unposted assignments, if the course has grading periods.

◆ EndAt

DateTime? UVACanvasAccess.Structures.Enrollments.Enrollment.EndAt

get

When the enrollment concludes.

◆ EnrollmentState

Api.? CourseEnrollmentState UVACanvasAccess.Structures.Enrollments.Enrollment.EnrollmentState

get

The state of the enrollment.

◆ Grades

Grade UVACanvasAccess.Structures.Enrollments.Enrollment.Grades

get

The user's grade summary in this enrollment.

◆ HasGradingPeriods

bool? UVACanvasAccess.Structures.Enrollments.Enrollment.HasGradingPeriods

get

Whether the course has grading periods.

◆ HtmlUrl

string UVACanvasAccess.Structures.Enrollments.Enrollment.HtmlUrl

get

The URL to the Canvas webpage displaying this enrollment.

◆ Id

ulong UVACanvasAccess.Structures.Enrollments.Enrollment.Id

get

The enrollment id.

This is unrelated to the course id.

◆ LastActivityAt

DateTime? UVACanvasAccess.Structures.Enrollments.Enrollment.LastActivityAt

get

The last activity time for the user in the context of the enrollment.

◆ LastAttendedAt

DateTime? UVACanvasAccess.Structures.Enrollments.Enrollment.LastAttendedAt

get

The last attendance time for the user in the context of the enrollment.

◆ LimitPrivilegesToCourseSection

bool? UVACanvasAccess.Structures.Enrollments.Enrollment.LimitPrivilegesToCourseSection

get

Whether the user is limited to their own section within the course.

◆ OverrideGrade

string UVACanvasAccess.Structures.Enrollments.Enrollment.OverrideGrade

get

The override grade.

◆ OverrideScore

decimal? UVACanvasAccess.Structures.Enrollments.Enrollment.OverrideScore

get

The override score.

◆ Role

string UVACanvasAccess.Structures.Enrollments.Enrollment.Role

get

The enrollment role in the course. May match Type, but individual courses may also customize these roles.

◆ RoleId

ulong UVACanvasAccess.Structures.Enrollments.Enrollment.RoleId

get

The id of the enrollment role.

◆ RootAccountId

ulong? UVACanvasAccess.Structures.Enrollments.Enrollment.RootAccountId

get

The root account id of the account the enrollment is under.

◆ SectionIntegrationId

string UVACanvasAccess.Structures.Enrollments.Enrollment.SectionIntegrationId

get

The section integration id.

◆ SisAccountId

string UVACanvasAccess.Structures.Enrollments.Enrollment.SisAccountId

get

The SIS id of the account the enrollment is under.

◆ SisCourseId

string UVACanvasAccess.Structures.Enrollments.Enrollment.SisCourseId

get

The SIS id of the course which the user is enrolled in.

◆ SisImportId

ulong? UVACanvasAccess.Structures.Enrollments.Enrollment.SisImportId

get

The SIS import id.

◆ SisSectionId

string UVACanvasAccess.Structures.Enrollments.Enrollment.SisSectionId

get

The SIS id of the section within the course which the user is enrolled in.

◆ SisUserId

string UVACanvasAccess.Structures.Enrollments.Enrollment.SisUserId

get

The SIS id of the user involved in the enrollment.

◆ StartAt

DateTime? UVACanvasAccess.Structures.Enrollments.Enrollment.StartAt

get

When the enrollment begins.

◆ TotalActivityTime

ulong? UVACanvasAccess.Structures.Enrollments.Enrollment.TotalActivityTime

get

The activity total time, in seconds, for the user in the context of the enrollment.

◆ TotalsForAllGradingPeriodsOption

bool? UVACanvasAccess.Structures.Enrollments.Enrollment.TotalsForAllGradingPeriodsOption

get

Whether the course has the 'Display Totals for All Grading Periods' option enabled.

◆ Type

Api.? CourseEnrollmentRoleTypes UVACanvasAccess.Structures.Enrollments.Enrollment.Type

get

The type of enrollment.

◆ UnpostedCurrentGrade

string UVACanvasAccess.Structures.Enrollments.Enrollment.UnpostedCurrentGrade

get

The user's current grade in the course, including unposted assignments.

◆ UnpostedCurrentScore

string UVACanvasAccess.Structures.Enrollments.Enrollment.UnpostedCurrentScore

get

The user's current score in the course, including unposted assignments.

◆ UnpostedFinalGrade

string UVACanvasAccess.Structures.Enrollments.Enrollment.UnpostedFinalGrade

get

The user's final grade in the course, including unposted assignments.

◆ UnpostedFinalScore

string UVACanvasAccess.Structures.Enrollments.Enrollment.UnpostedFinalScore

get

The user's final score in the course, including unposted assignments.

◆ UpdatedAt

DateTime? UVACanvasAccess.Structures.Enrollments.Enrollment.UpdatedAt

get

When the enrollment was last updated.

◆ User

UserDisplay UVACanvasAccess.Structures.Enrollments.Enrollment.User

get

A UserDisplay for the user involved in the enrollment.

◆ UserId

ulong UVACanvasAccess.Structures.Enrollments.Enrollment.UserId

get

The id of the user involved in the enrollment.

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

UVACanvasAccess/Structures/Enrollments/Enrollment.cs

Public Member Functions

Properties

Detailed Description

Member Function Documentation

◆ Conclude()

◆ Deactivate()

◆ Delete()

Property Documentation

◆ AssociatedUserId

◆ CourseId

◆ CourseIntegrationId

◆ CourseSectionId

◆ CreatedAt

◆ CurrentGradingPeriodId

◆ CurrentGradingPeriodTitle

◆ CurrentPeriodOverrideGrade

◆ CurrentPeriodOverrideScore

◆ CurrentPeriodUnpostedCurrentGrade

◆ CurrentPeriodUnpostedFinalGrade

◆ CurrentPeriodUnpostedFinalScore

◆ EndAt

◆ EnrollmentState

◆ Grades

◆ HasGradingPeriods

◆ HtmlUrl

◆ Id

◆ LastActivityAt

◆ LastAttendedAt

◆ LimitPrivilegesToCourseSection

◆ OverrideGrade

◆ OverrideScore

◆ Role

◆ RoleId

◆ RootAccountId

◆ SectionIntegrationId

◆ SisAccountId

◆ SisCourseId

◆ SisImportId

◆ SisSectionId

◆ SisUserId

◆ StartAt

◆ TotalActivityTime

◆ TotalsForAllGradingPeriodsOption

◆ Type

◆ UnpostedCurrentGrade

◆ UnpostedCurrentScore

◆ UnpostedFinalGrade

◆ UnpostedFinalScore

◆ UpdatedAt

◆ User

◆ UserId