import { type CreateAnAssignmentParams } from "https://deno.land/x/gesso@v0.1.2/types/params.ts";
Properties
The position of this assignment in the group when displaying assignment lists.
Allowed values: online_quiz, none, on_paper, discussion_topic, external_tool, online_upload, online_text_entry, online_url, media_recording, student_annotation
Allowed extensions if submission_types includes “online_upload” Example: allowed_extensions: ["docx","ppt"]
Only applies when the Turnitin plugin is enabled for a course and the submission_types array includes “online_upload”. Toggles Turnitin submissions for the assignment. Will be ignored if Turnitin is not available for the course.
Only applies when the VeriCite plugin is enabled for a course and the submission_types array includes “online_upload”. Toggles VeriCite submissions for the assignment. Will be ignored if VeriCite is not available for the course.
Settings to send along to turnitin. See Assignment object definition for format.
Data used for SIS integrations. Requires admin-level token with the “Manage SIS” permission. JSON string required.
If submission_types does not include external_tool,discussion_topic, online_quiz, or on_paper, determines whether or not peer reviews will be turned on for the assignment.
Whether peer reviews will be assigned automatically by Canvas or if teachers must manually assign peer reviews. Does not apply if peer reviews are not enabled.
If true, Canvas will send a notification to students in the class notifying them that the content has changed.
If present, the assignment will become a group assignment assigned to the group.
If this is a group assignment, teachers have the options to grade students individually. If false, Canvas will apply the assignment's score to each member of the group. If true, the teacher can manually assign scores to each member of the group.
Hash of external tool parameters if submission_types is [“external_tool”]. See Assignment object definition for format.
Allowed values: pass_fail, percent, letter_grade, gpa_scale, points, not_graded
The day/time the assignment is due. Must be between the lock dates if there are lock dates. Accepts times in ISO 8601 format, e.g. 2014-10-21T18:48:00Z.
The day/time the assignment is locked after. Must be after the due date if there is a due date. Accepts times in ISO 8601 format, e.g. 2014-10-21T18:48:00Z.
The day/time the assignment is unlocked. Must be before the due date if there is a due date. Accepts times in ISO 8601 format, e.g. 2014-10-21T18:48:00Z.
The assignment group id to put the assignment in. Defaults to the top assignment group in the course.
List of overrides for the assignment.
Whether this assignment is only visible to overrides (Only useful if 'differentiated assignments' account setting is on)
Whether this assignment is published. (Only useful if 'draft state' account setting is on) Unpublished assignments are not visible to students.
The grading standard id to set for the course. If no value is provided for this argument the current grading_standard will be un-set from this course. This will update the grading_type for the course to 'letter_grade' unless it is already 'gpa_scale'.
Whether this assignment is counted towards a student's final grade.
Whether this assignment should use the Quizzes 2 LTI tool. Sets the submission type to 'external_tool' and configures the external tool attributes to use the Quizzes 2 LTI tool configured for this course. Has no effect if no Quizzes 2 LTI tool is configured.
The maximum number of provisional graders who may issue grades for this assignment. Only relevant for moderated assignments. Must be a positive value, and must be set to 1 if the course has fewer than two active instructors. Otherwise, the maximum value is the number of active instructors in the course minus one, or 10 if the course has more than 11 active instructors.
The user ID of the grader responsible for choosing final grades for this assignment. Only relevant for moderated assignments.
Boolean indicating if provisional graders' comments are visible to other provisional graders. Only relevant for moderated assignments.
Boolean indicating if provisional graders' identities are hidden from other provisional graders. Only relevant for moderated assignments.
Boolean indicating if provisional grader identities are visible to the the final grader. Only relevant for moderated assignments.
Boolean indicating if the assignment is graded anonymously. If true, graders cannot see student identities.
The number of submission attempts allowed for this assignment. Set to -1 for unlimited attempts.