Class StudentHomework

constructor

• new StudentHomework(client, homework): StudentHomework

• Parameters

  • client: Pronote
  • homework: {
        CouleurFond: string;
        DonneLe: PronoteValue<7, string>;
        ListePieceJointe: PronoteValue<24, PronoteApiAttachment[]>;
        ListeThemes: PronoteApiThemesList;
        Matiere: PronoteValue<24, {
            L: string;
            N: string;
        }>;
        N: string;
        PourLe: PronoteValue<7, string>;
        TAFFait: boolean;
        avecMiseEnForme: boolean;
        avecRendu?: boolean;
        cahierDeTextes?: PronoteValue<24, {
            N: string;
        }>;
        cours: PronoteValue<24, {
            N: string;
        }>;
        descriptif: PronoteValue<21, string>;
        documentRendu?: PronoteValue<24, {
            G: number;
            L: string;
            N: string;
        }>;
        duree: number;
        genreRendu?: PronoteApiHomeworkReturnType;
        libelleCBTheme: string;
        niveauDifficulte: PronoteApiHomeworkDifficulty;
        nomPublic: string;
        peuRendre?: boolean;
    }

    • CouleurFond: string

      Subject color given by Pronote.

    • DonneLe: PronoteValue<7, string>

      When the homework has been given.

      Example

      "22/01/2024"
      Copy

    • ListePieceJointe: PronoteValue<24, PronoteApiAttachment[]>

      Attachments.

    • ListeThemes: PronoteApiThemesList

      Themes associated with the homework.

    • Matiere: PronoteValue<24, {
          L: string;
          N: string;
      }>

      Subject from where this homework is from.

    • N: string

      ID of the homework.

    • PourLe: PronoteValue<7, string>

      Due date for the homework.

      Example

      "24/01/2024"
      Copy

    • TAFFait: boolean

      true when the homework has been done.

    • avecMiseEnForme: boolean

    • Optional avecRendu?: boolean

      Whether the homework should be returned or not.

    • Optional cahierDeTextes?: PronoteValue<24, {
          N: string;
      }>

    • cours: PronoteValue<24, {
          N: string;
      }>

    • descriptif: PronoteValue<21, string>

      Content of the homework. This is an HTML string, you can use whatever you want to parse/display it.

    • Optional documentRendu?: PronoteValue<24, {
          G: number;
          L: string;
          N: string;
      }>

    • duree: number

      Time in minutes to do the exercice.

      Example

      30 // For 30 minutes.
      Copy

    • Optional genreRendu?: PronoteApiHomeworkReturnType

      Type of return the teacher asks.

    • libelleCBTheme: string

      Example

      "Uniquement les thèmes associés aux matières du travail à faire"
      Copy

    • niveauDifficulte: PronoteApiHomeworkDifficulty

      Difficulty of the given work.

    • nomPublic: string

    • Optional peuRendre?: boolean

      Whether you can upload or reupload a file.

  Returns StudentHomework

attachments

backgroundColor

deadline

description

difficulty

done

id

Optional lengthInMinutes

Optional lessonResourceID

Optional return

subject

themes

getResource

• getResource(): Promise<undefined | StudentLessonResource>

• Returns Promise<undefined | StudentLessonResource>

removeUploadedFile

• removeUploadedFile(): Promise<void>

• Returns Promise<void>

setDone

• setDone(done): Promise<void>

• Parameters

  • done: boolean

  Returns Promise<void>

uploadFile

• uploadFile(file, fileName): Promise<void>

• Parameters

  • file: PawnoteSupportedFormDataFile
  • fileName: string

  Returns Promise<void>