Skip to content

ClassAssignmentUpdate.md

Latest commit

聽

History

History
76 lines (70 loc) 路 7.09 KB

ClassAssignmentUpdate.md

File metadata and controls

76 lines (70 loc) 路 7.09 KB
Raw

FlatApi::ClassAssignmentUpdate

Properties

Name Type Description Notes
type AssignmentType [optional]
title String Title of the assignment [optional]
description String Student instructions and content of the assignment (plain text) [optional]
description_html String HTML version of student instructions. Pasted images may be sent as inline base64 `data:` URIs; they are uploaded to storage and rewritten to hosted URLs on save. The final HTML is limited to 100000 characters. When provided, the plain text version will be automatically extracted for compatibility. [optional]
teacher_instructions String Teacher-only instructions (plain text) [optional]
teacher_instructions_html String HTML version of teacher-only instructions. Pasted images may be sent as inline base64 `data:` URIs; they are uploaded to storage and rewritten to hosted URLs on save. The final HTML is limited to 100000 characters. When provided, the plain text version will be automatically extracted for compatibility. [optional]
attachments Array<ClassAttachmentCreation> The complete attachment list. Omitting this property on an update leaves the existing attachments alone; sending it replaces them. Dropping a dedicated score from the list deletes the students' copies of it, so send the full set you want to keep rather than only the additions. Duplicates, judged by `url`, `score`, `worksheet` or `googleDriveFileId`, are discarded silently, and exceeding the per-assignment limit fails with `ASSIGNMENT_ATTACHMENTS_LIMIT`. [optional]
nb_playback_authorized Float The number of playbacks authorized on the scores of the assignment. [optional]
restrict_play_note Boolean Restrict the ability to get an audio feedback every time a student adds or selects a note. [optional]
restrict_to_audio_tracks Boolean Restrict the audio source to provided audio tracks on a score. Students won't be able to use the editor playback. [optional]
toolset String The id of the toolset to apply to this assignment. The toolset will be copied to the assignment as a dedicated object to prevent unexpected changes when making modifications to the template toolset. This property can be set to null to delete the linked toolset and switch back to all the tools available for this assignment. [optional]
cover_file String The id of the cover to display [optional]
cover String The URL of the cover to display [optional]
max_points Float If set, the grading will be enabled for the assignment with this value as the maximum of points [optional]
release_grades String For worksheets, how grading will work for the assignment: - If set to `auto`, the grades will be automatically released when the student submits the submissions - If set to `manual`, the grades will only be set as `draftGrade` and will be released when the teacher returns the submissions [optional]
shuffle_exercises Boolean Shuffle the worksheet exercises for each student [optional]
submission_students_mode AssignmentSubmissionStudentsMode [optional]
recording_type String For performance assignments: recording type that will be either 'audio' or 'video'. * `audio`: Only audio will be required during the recording. * `video`: Camera will be required during the recording. Only set when type is 'performance'. [optional]
allow_metronome Boolean For performance assignments: Enable students to use the metronome while they are recording, helping them stay in time. Only set when type is 'performance'. [optional]
allow_backing_track Boolean For performance assignments: Enable students to listen to the accompaniment without their instrument part while they are playing. Only set when type is 'performance'. [optional]
allow_speed_change Boolean For performance assignments: whether students can adjust the playback speed of the score during recording. * `true`: Students can change the tempo/speed during practice and recording * `false`: Tempo is fixed to the original score tempo Only set when type is 'performance'. [optional]
free_record Boolean For performance assignments: &quot;Free Record&quot; mode. When `true`, no score is attached to the assignment. Students freely record a varied repertoire or an ensemble performance without being constrained by a single score's structure or duration, and all score-dependent options (playback, metronome, backtracking, speed control) are hidden. Only set when type is 'performance'. [optional]
state String State of the assignment [optional]
due_date Time The due date of this assignment, late submissions will be marked as past due. If not set, the assignment won't have a due date. [optional]
scheduled_date Time The publication (scheduled) date of the assignment. If this one is specified, the assignment will only be listed to the teachers of the class. [optional]
google_classroom ClassAssignmentUpdateAllOfGoogleClassroom [optional]
microsoft_graph ClassAssignmentUpdateAllOfMicrosoftGraph [optional]
assignee_mode String Possible modes of assigning assignments [optional]
assigned_students Array<String> Identifiers for the students that have access to the assignment [optional]
class_group_ids Array<String> Optional list of specific class group IDs to apply to the assignment. When transitioning to active state with group submission mode: - If provided: Only these specific groups will be applied - If not provided: All class groups will be applied, or randomized groups created if none exist [optional]

Example

require 'flat_api'

instance = FlatApi::ClassAssignmentUpdate.new(
  type: null,
  title: null,
  description: null,
  description_html: null,
  teacher_instructions: null,
  teacher_instructions_html: null,
  attachments: null,
  nb_playback_authorized: null,
  restrict_play_note: null,
  restrict_to_audio_tracks: null,
  toolset: null,
  cover_file: null,
  cover: null,
  max_points: null,
  release_grades: null,
  shuffle_exercises: null,
  submission_students_mode: null,
  recording_type: null,
  allow_metronome: null,
  allow_backing_track: null,
  allow_speed_change: null,
  free_record: null,
  state: null,
  due_date: null,
  scheduled_date: null,
  google_classroom: null,
  microsoft_graph: null,
  assignee_mode: null,
  assigned_students: null,
  class_group_ids: null
)