UVACanvasAccess
Public Member Functions | Properties | List of all members
UVACanvasAccess.Structures.Assignments.Assignment Class Reference

Represents an assignment. More...

Inheritance diagram for UVACanvasAccess.Structures.Assignments.Assignment:
Inheritance graph
[legend]
Collaboration diagram for UVACanvasAccess.Structures.Assignments.Assignment:
Collaboration graph
[legend]

Public Member Functions

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

Properties

ulong Id [get]
 The id. More...
 
string Name [get]
 The name. More...
 
string Description [get]
 The HTML-formatted description. More...
 
DateTime CreatedAt [get]
 When this assignment was created. More...
 
DateTime? UpdatedAt [get]
 When this assignment was last updated. More...
 
DateTime? DueAt [get]
 The due date for this assignment, if present. More...
 
DateTime? LockAt [get]
 When this assignment will lock itself, if applicable. More...
 
DateTime? UnlockAt [get]
 When this assignment will unlock itself, if applicable. More...
 
bool HasOverrides [get]
 Whether or not this assignment has any overrides. More...
 
IEnumerable< AssignmentDateAllDates [get]
 All relevant assignment dates. More...
 
ulong CourseId [get]
 The course this assignment belongs to. More...
 
string HtmlUrl [get]
 The URL to this assignment's web page. More...
 
string SubmissionsDownloadUrl [get]
 The URL to all of this assignment's submissions as a zip. More...
 
ulong AssignmentGroupId [get]
 The assignment's group. More...
 
bool DueDateRequired [get]
 Whether or not a due date must be present for this assignment, reflecting the account-level setting. More...
 
IEnumerable< string > AllowedExtensions [get]
 If this assignment allows online submission, the list of allowed file extensions for submission. More...
 
uint MaxNameLength [get]
 The maximum length this assignment's name may be. More...
 
bool? TurnitinEnabled [get]
 If the Turnitin plugin is available to the account, whether or not Turnitin is enabled for this assignment. More...
 
bool? VeriCiteEnabled [get]
 If the VeriCite plugin is available to the account, whether or not VeriCite is enabled for this assignment. More...
 
TurnitinSettings TurnitinSettings [get]
 If Turnitin is enabled, the relevant settings. More...
 
bool? GradeGroupStudentsIndividually [get]
 If this is a group assignment, whether or not students will be graded individually. More...
 
ExternalToolTagAttributes ExternalToolTagAttributes [get]
 If this assignment support external tools, the relevant attributes. More...
 
bool PeerReviews [get]
 Whether or not this assignment requires peer reviews. More...
 
bool AutomaticPeerReviews [get]
 Whether or not peer reviews are assigned automatically. More...
 
uint? PeerReviewCount [get]
 The amount of reviews each user is assigned. More...
 
DateTime? PeerReviewsAssignAt [get]
 The date when peer reviews are due. Defaults to the assignment's due date if absent. More...
 
bool? IntraGroupPeerReviews [get]
 Whether or not students are allowed to peer review work from fellow group members. More...
 
ulong? GroupCategoryId [get]
 If this is a group assignment, the assignment's group set. More...
 
uint? NeedsGradingCount [get]
 The amount of submissions that need grading. More...
 
IEnumerable< NeedsGradingCountNeedsGradingCountBySection [get]
 The amount of submissions that need grading, organized by section. More...
 
ulong Position [get]
 The position of this assignment relative to others in the group. More...
 
bool? PostToSis [get]
 Whether this assignment is posted to SIS. More...
 
string IntegrationId [get]
 The integration id. More...
 
object IntegrationData [get]
 The integration data, if any. More...
 
bool? Muted [get]
 For courses using Old Gradebook, indicates whether the assignment is muted. For courses using New Gradebook, true if the assignment has any unposted submissions, otherwise false. More...
 
uint? PointsPossible [get]
 The maximum amount of points possible for this assignment. More...
 
IEnumerable< string > SubmissionTypes [get]
 The submission types supported for this assignment. More...
 
bool? HasSubmittedSubmissions [get]
 Whether or not any submissions have been made yet. More...
 
string GradingType [get]
 The type of grading used by this assignment. More...
 
ulong? GradingStandardId [get]
 The id of the grading standard. More...
 
bool Published [get]
 Whether or not this assignment is published. More...
 
bool Unpublishable [get]
 Whether or not this assignment can be unpublished. More...
 
bool OnlyVisibleToOverrides [get]
 Whether or not this assignment is only visible to overrides. More...
 
bool LockedForUser [get]
 Whether or not this assignment is locked for the current user. More...
 
LockInfo LockInfo [get]
 If this assignment is locked for the current user, the relevant info. More...
 
string LockExplanation [get]
 If this assignment is locked for the current user, the explanation. More...
 
ulong? QuizId [get]
 If this assignment is an online quiz, the quiz id associated with it. More...
 
bool? AnonymousSubmissions [get]
 If this assignment is an online quiz, whether or not anonymous submissions are allowed. More...
 
DiscussionTopic DiscussionTopic [get]
 The associated DiscussionTopic, if applicable. More...
 
bool? FreezeOnCopy [get]
 Whether or not this assignment will be frozen when copied. More...
 
bool? Frozen [get]
 Whether or not this assignment is frozen for the current user. More...
 
IEnumerable< string > FrozenAttributes [get]
 Attributes of the assignment which are frozen. More...
 
Submission Submission [get]
 The current user's submission to this assignment, if present. More...
 
bool? UseRubricForGrading [get]
 Whether the included rubric is used for grading, or only advisory. More...
 
object RubricSettings [get]
 The rubric settings. More...
 
IEnumerable< RubricCriteriaRubric [get]
 The list of rubric criteria that comprise the rubric. More...
 
IEnumerable< ulong > AssignmentVisibility [get]
 The list of users who can see this assignment. More...
 
IEnumerable< AssignmentOverrideOverrides [get]
 The list of overrides, if present. More...
 
bool? OmitFromFinalGrade [get]
 Whether or not this assignment will be omitted from the final grade. More...
 
bool ModeratedGrading [get]
 Whether or not this assignment is moderated. More...
 
uint GraderCount [get]
 If this assignment is moderated, the maximum amount of provisional graders. More...
 
ulong? FinalGraderId [get]
 If this assignment is moderated, the user responsible for choosing the final grade. More...
 
bool? GraderCommentsVisibleToGraders [get]
 If this assignment is moderated, whether or not graders' comments are visible to other graders. More...
 
bool? GradersAnonymousToGraders [get]
 If this assignment is moderated, whether or not graders are anonymous to other graders. More...
 
bool? GraderNamesVisibleToFinalGrader [get]
 If this assignment is moderated, whether or not grader names are visible to the final grader. More...
 
bool? AnonymousGrading [get]
 Whether or not students are anonymous to graders. More...
 
int AllowedAttempts [get]
 The maximum amount of submission attempts allowed. -1 indicates unlimited attempts. More...
 

Detailed Description

Represents an assignment.

Property Documentation

◆ AllDates

IEnumerable<AssignmentDate> UVACanvasAccess.Structures.Assignments.Assignment.AllDates
get

All relevant assignment dates.

◆ AllowedAttempts

int UVACanvasAccess.Structures.Assignments.Assignment.AllowedAttempts
get

The maximum amount of submission attempts allowed. -1 indicates unlimited attempts.

◆ AllowedExtensions

IEnumerable<string> UVACanvasAccess.Structures.Assignments.Assignment.AllowedExtensions
get

If this assignment allows online submission, the list of allowed file extensions for submission.

◆ AnonymousGrading

bool? UVACanvasAccess.Structures.Assignments.Assignment.AnonymousGrading
get

Whether or not students are anonymous to graders.

◆ AnonymousSubmissions

bool? UVACanvasAccess.Structures.Assignments.Assignment.AnonymousSubmissions
get

If this assignment is an online quiz, whether or not anonymous submissions are allowed.

◆ AssignmentGroupId

ulong UVACanvasAccess.Structures.Assignments.Assignment.AssignmentGroupId
get

The assignment's group.

◆ AssignmentVisibility

IEnumerable<ulong> UVACanvasAccess.Structures.Assignments.Assignment.AssignmentVisibility
get

The list of users who can see this assignment.

◆ AutomaticPeerReviews

bool UVACanvasAccess.Structures.Assignments.Assignment.AutomaticPeerReviews
get

Whether or not peer reviews are assigned automatically.

◆ CourseId

ulong UVACanvasAccess.Structures.Assignments.Assignment.CourseId
get

The course this assignment belongs to.

◆ CreatedAt

DateTime UVACanvasAccess.Structures.Assignments.Assignment.CreatedAt
get

When this assignment was created.

◆ Description

string UVACanvasAccess.Structures.Assignments.Assignment.Description
get

The HTML-formatted description.

◆ DiscussionTopic

DiscussionTopic UVACanvasAccess.Structures.Assignments.Assignment.DiscussionTopic
get

The associated DiscussionTopic, if applicable.

◆ DueAt

DateTime? UVACanvasAccess.Structures.Assignments.Assignment.DueAt
get

The due date for this assignment, if present.

When an assignment override that affects the current user is present, this field will reflect the override as it affects the current user.

◆ DueDateRequired

bool UVACanvasAccess.Structures.Assignments.Assignment.DueDateRequired
get

Whether or not a due date must be present for this assignment, reflecting the account-level setting.

◆ ExternalToolTagAttributes

ExternalToolTagAttributes UVACanvasAccess.Structures.Assignments.Assignment.ExternalToolTagAttributes
get

If this assignment support external tools, the relevant attributes.

◆ FinalGraderId

ulong? UVACanvasAccess.Structures.Assignments.Assignment.FinalGraderId
get

If this assignment is moderated, the user responsible for choosing the final grade.

◆ FreezeOnCopy

bool? UVACanvasAccess.Structures.Assignments.Assignment.FreezeOnCopy
get

Whether or not this assignment will be frozen when copied.

◆ Frozen

bool? UVACanvasAccess.Structures.Assignments.Assignment.Frozen
get

Whether or not this assignment is frozen for the current user.

◆ FrozenAttributes

IEnumerable<string> UVACanvasAccess.Structures.Assignments.Assignment.FrozenAttributes
get

Attributes of the assignment which are frozen.

◆ GradeGroupStudentsIndividually

bool? UVACanvasAccess.Structures.Assignments.Assignment.GradeGroupStudentsIndividually
get

If this is a group assignment, whether or not students will be graded individually.

◆ GraderCommentsVisibleToGraders

bool? UVACanvasAccess.Structures.Assignments.Assignment.GraderCommentsVisibleToGraders
get

If this assignment is moderated, whether or not graders' comments are visible to other graders.

◆ GraderCount

uint UVACanvasAccess.Structures.Assignments.Assignment.GraderCount
get

If this assignment is moderated, the maximum amount of provisional graders.

◆ GraderNamesVisibleToFinalGrader

bool? UVACanvasAccess.Structures.Assignments.Assignment.GraderNamesVisibleToFinalGrader
get

If this assignment is moderated, whether or not grader names are visible to the final grader.

◆ GradersAnonymousToGraders

bool? UVACanvasAccess.Structures.Assignments.Assignment.GradersAnonymousToGraders
get

If this assignment is moderated, whether or not graders are anonymous to other graders.

◆ GradingStandardId

ulong? UVACanvasAccess.Structures.Assignments.Assignment.GradingStandardId
get

The id of the grading standard.

◆ GradingType

string UVACanvasAccess.Structures.Assignments.Assignment.GradingType
get

The type of grading used by this assignment.

◆ GroupCategoryId

ulong? UVACanvasAccess.Structures.Assignments.Assignment.GroupCategoryId
get

If this is a group assignment, the assignment's group set.

◆ HasOverrides

bool UVACanvasAccess.Structures.Assignments.Assignment.HasOverrides
get

Whether or not this assignment has any overrides.

◆ HasSubmittedSubmissions

bool? UVACanvasAccess.Structures.Assignments.Assignment.HasSubmittedSubmissions
get

Whether or not any submissions have been made yet.

◆ HtmlUrl

string UVACanvasAccess.Structures.Assignments.Assignment.HtmlUrl
get

The URL to this assignment's web page.

◆ Id

ulong UVACanvasAccess.Structures.Assignments.Assignment.Id
get

The id.

◆ IntegrationData

object UVACanvasAccess.Structures.Assignments.Assignment.IntegrationData
get

The integration data, if any.

◆ IntegrationId

string UVACanvasAccess.Structures.Assignments.Assignment.IntegrationId
get

The integration id.

◆ IntraGroupPeerReviews

bool? UVACanvasAccess.Structures.Assignments.Assignment.IntraGroupPeerReviews
get

Whether or not students are allowed to peer review work from fellow group members.

◆ LockAt

DateTime? UVACanvasAccess.Structures.Assignments.Assignment.LockAt
get

When this assignment will lock itself, if applicable.

When an assignment override that affects the current user is present, this field will reflect the override as it affects the current user.

◆ LockedForUser

bool UVACanvasAccess.Structures.Assignments.Assignment.LockedForUser
get

Whether or not this assignment is locked for the current user.

◆ LockExplanation

string UVACanvasAccess.Structures.Assignments.Assignment.LockExplanation
get

If this assignment is locked for the current user, the explanation.

◆ LockInfo

LockInfo UVACanvasAccess.Structures.Assignments.Assignment.LockInfo
get

If this assignment is locked for the current user, the relevant info.

◆ MaxNameLength

uint UVACanvasAccess.Structures.Assignments.Assignment.MaxNameLength
get

The maximum length this assignment's name may be.

◆ ModeratedGrading

bool UVACanvasAccess.Structures.Assignments.Assignment.ModeratedGrading
get

Whether or not this assignment is moderated.

◆ Muted

bool? UVACanvasAccess.Structures.Assignments.Assignment.Muted
get

For courses using Old Gradebook, indicates whether the assignment is muted. For courses using New Gradebook, true if the assignment has any unposted submissions, otherwise false.

◆ Name

string UVACanvasAccess.Structures.Assignments.Assignment.Name
get

The name.

◆ NeedsGradingCount

uint? UVACanvasAccess.Structures.Assignments.Assignment.NeedsGradingCount
get

The amount of submissions that need grading.

◆ NeedsGradingCountBySection

IEnumerable<NeedsGradingCount> UVACanvasAccess.Structures.Assignments.Assignment.NeedsGradingCountBySection
get

The amount of submissions that need grading, organized by section.

◆ OmitFromFinalGrade

bool? UVACanvasAccess.Structures.Assignments.Assignment.OmitFromFinalGrade
get

Whether or not this assignment will be omitted from the final grade.

◆ OnlyVisibleToOverrides

bool UVACanvasAccess.Structures.Assignments.Assignment.OnlyVisibleToOverrides
get

Whether or not this assignment is only visible to overrides.

◆ Overrides

IEnumerable<AssignmentOverride> UVACanvasAccess.Structures.Assignments.Assignment.Overrides
get

The list of overrides, if present.

◆ PeerReviewCount

uint? UVACanvasAccess.Structures.Assignments.Assignment.PeerReviewCount
get

The amount of reviews each user is assigned.

◆ PeerReviews

bool UVACanvasAccess.Structures.Assignments.Assignment.PeerReviews
get

Whether or not this assignment requires peer reviews.

◆ PeerReviewsAssignAt

DateTime? UVACanvasAccess.Structures.Assignments.Assignment.PeerReviewsAssignAt
get

The date when peer reviews are due. Defaults to the assignment's due date if absent.

◆ PointsPossible

uint? UVACanvasAccess.Structures.Assignments.Assignment.PointsPossible
get

The maximum amount of points possible for this assignment.

◆ Position

ulong UVACanvasAccess.Structures.Assignments.Assignment.Position
get

The position of this assignment relative to others in the group.

◆ PostToSis

bool? UVACanvasAccess.Structures.Assignments.Assignment.PostToSis
get

Whether this assignment is posted to SIS.

◆ Published

bool UVACanvasAccess.Structures.Assignments.Assignment.Published
get

Whether or not this assignment is published.

◆ QuizId

ulong? UVACanvasAccess.Structures.Assignments.Assignment.QuizId
get

If this assignment is an online quiz, the quiz id associated with it.

◆ Rubric

IEnumerable<RubricCriteria> UVACanvasAccess.Structures.Assignments.Assignment.Rubric
get

The list of rubric criteria that comprise the rubric.

◆ RubricSettings

object UVACanvasAccess.Structures.Assignments.Assignment.RubricSettings
get

The rubric settings.

◆ Submission

Submission UVACanvasAccess.Structures.Assignments.Assignment.Submission
get

The current user's submission to this assignment, if present.

◆ SubmissionsDownloadUrl

string UVACanvasAccess.Structures.Assignments.Assignment.SubmissionsDownloadUrl
get

The URL to all of this assignment's submissions as a zip.

◆ SubmissionTypes

IEnumerable<string> UVACanvasAccess.Structures.Assignments.Assignment.SubmissionTypes
get

The submission types supported for this assignment.

◆ TurnitinEnabled

bool? UVACanvasAccess.Structures.Assignments.Assignment.TurnitinEnabled
get

If the Turnitin plugin is available to the account, whether or not Turnitin is enabled for this assignment.

◆ TurnitinSettings

TurnitinSettings UVACanvasAccess.Structures.Assignments.Assignment.TurnitinSettings
get

If Turnitin is enabled, the relevant settings.

◆ UnlockAt

DateTime? UVACanvasAccess.Structures.Assignments.Assignment.UnlockAt
get

When this assignment will unlock itself, if applicable.

When an assignment override that affects the current user is present, this field will reflect the override as it affects the current user.

◆ Unpublishable

bool UVACanvasAccess.Structures.Assignments.Assignment.Unpublishable
get

Whether or not this assignment can be unpublished.

◆ UpdatedAt

DateTime? UVACanvasAccess.Structures.Assignments.Assignment.UpdatedAt
get

When this assignment was last updated.

◆ UseRubricForGrading

bool? UVACanvasAccess.Structures.Assignments.Assignment.UseRubricForGrading
get

Whether the included rubric is used for grading, or only advisory.

◆ VeriCiteEnabled

bool? UVACanvasAccess.Structures.Assignments.Assignment.VeriCiteEnabled
get

If the VeriCite plugin is available to the account, whether or not VeriCite is enabled for this assignment.


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