Class TimetableLesson

Hierarchy

TimetableItem
- TimetableLesson

Constructors

constructor

new TimetableLesson(client, lesson): TimetableLesson
Parameters
- client: Pronote
- lesson: {
      AvecCdT?: boolean;
      AvecTafPublie: boolean;
      CouleurFond?: string;
      DateDuCours: PronoteValue<DateTime, string>;
      DateDuCoursFin?: PronoteValue<DateTime, string>;
      G: PronoteApiLessonStatusType;
      ListeContenus: {
          V: ({
              L: string;
          } & ({
              G: Subject;
              N: string;
              estServiceGroupe?: boolean;
          } | {
              G: Room;
              N: string;
          } | {
              G: Group;
          } | {
              G: Teacher;
          } | {
              G: Personal;
          }))[];
          _T: 24;
      };
      N: string;
      P: number;
      Statut?: string;
      cahierDeTextes?: PronoteValue<24, {
          N: string;
          estDevoir?: boolean;
      }>;
      dispenseEleve?: boolean;
      duree: number;
      estAnnule?: boolean;
      estPermanence?: boolean;
      estRetenue?: undefined;
      estSortiePedagogique?: false;
      listeVisios?: {
          V: {
              url: string;
          }[];
      };
      memo?: string;
      place: number;
  } | {
      CouleurFond: string;
      DateDuCours: PronoteValue<DateTime, string>;
      N: string;
      accompagnateurs: string[];
      duree: number;
      dureeReelle: number;
      estRetenue?: undefined;
      estSortiePedagogique: true;
      memo?: string;
      motif: string;
      numeroSemaine: number;
      place: number;
      placeReelle: number;
      pourAcc?: boolean;
      strDateDebut: string;
      strDateFin?: string;
      strGenreRess: string;
      strRess: string;
  } | {
      DateDuCours: PronoteValue<DateTime, string>;
      ListeContenus: PronoteValue<Element, ({
          L: string;
      } & ({
          estHoraire: boolean;
      } | {
          G: Room;
      } | {
          G: Teacher;
      } | {
          G: Personal;
      }))[]>;
      N: string;
      duree: number;
      estRetenue: "eleve";
      estSortiePedagogique?: false;
      hintRealise: "Programmée";
      imgRealise: "RealiseProgramme";
      numeroSemaine: number;
      place: number;
  }
Returns TimetableLesson
Overrides TimetableItem.constructor
- Defined in parser/timetableLesson.ts:208

Properties

`Private` `Optional` `Readonly` #backgroundColor

#backgroundColor?: string

`Private` `Readonly` #blockLength

#blockLength: number

`Private` `Readonly` #blockPosition

#blockPosition: number

`Private` `Readonly` #canceled

#canceled: boolean

`Private` `Readonly` #classrooms

#classrooms: string[] = []

`Private` `Readonly` #client

#client: Pronote

`Private` `Readonly` #endDate

#endDate: Date

`Private` `Readonly` #exempted

#exempted: boolean

`Private` `Readonly` #genre

#genre: PronoteApiLessonStatusType

`Private` `Readonly` #groupNames

#groupNames: string[] = []

`Private` `Readonly` #id

#id: string

`Private` `Readonly` #item

#item: {
    AvecCdT?: boolean;
    AvecTafPublie: boolean;
    CouleurFond?: string;
    DateDuCours: PronoteValue<DateTime, string>;
    DateDuCoursFin?: PronoteValue<DateTime, string>;
    G: PronoteApiLessonStatusType;
    ListeContenus: {
        V: ({
            L: string;
        } & ({
            G: Subject;
            N: string;
            estServiceGroupe?: boolean;
        } | {
            G: Room;
            N: string;
        } | {
            G: Group;
        } | {
            G: Teacher;
        } | {
            G: Personal;
        }))[];
        _T: 24;
    };
    N: string;
    P: number;
    Statut?: string;
    cahierDeTextes?: PronoteValue<24, {
        N: string;
        estDevoir?: boolean;
    }>;
    dispenseEleve?: boolean;
    duree: number;
    estAnnule?: boolean;
    estPermanence?: boolean;
    estRetenue?: undefined;
    estSortiePedagogique?: false;
    listeVisios?: {
        V: {
            url: string;
        }[];
    };
    memo?: string;
    place: number;
} | {
    CouleurFond: string;
    DateDuCours: PronoteValue<DateTime, string>;
    N: string;
    accompagnateurs: string[];
    duree: number;
    dureeReelle: number;
    estRetenue?: undefined;
    estSortiePedagogique: true;
    memo?: string;
    motif: string;
    numeroSemaine: number;
    place: number;
    placeReelle: number;
    pourAcc?: boolean;
    strDateDebut: string;
    strDateFin?: string;
    strGenreRess: string;
    strRess: string;
} | {
    DateDuCours: PronoteValue<DateTime, string>;
    ListeContenus: PronoteValue<Element, ({
        L: string;
    } & ({
        estHoraire: boolean;
    } | {
        G: Room;
    } | {
        G: Teacher;
    } | {
        G: Personal;
    }))[]>;
    N: string;
    duree: number;
    estRetenue: "eleve";
    estSortiePedagogique?: false;
    hintRealise: "Programmée";
    imgRealise: "RealiseProgramme";
    numeroSemaine: number;
    place: number;
}

Type declaration

Optional AvecCdT?: boolean
Defined and true when something has been written on this lesson in the "content and resources" page.

AvecCdT means Avec Cahier de Textes, which is the same naming used in responses inside PronoteApiUserResources: ListeCahierDeTextes
AvecTafPublie: boolean
Optional CouleurFond?: string
DateDuCours: PronoteValue<DateTime, string>
Optional DateDuCoursFin?: PronoteValue<DateTime, string>
G: PronoteApiLessonStatusType
ListeContenus: {
    V: ({
        L: string;
    } & ({
        G: Subject;
        N: string;
        estServiceGroupe?: boolean;
    } | {
        G: Room;
        N: string;
    } | {
        G: Group;
    } | {
        G: Teacher;
    } | {
        G: Personal;
    }))[];
    _T: 24;
}
- V: ({
      L: string;
  } & ({
      G: Subject;
      N: string;
      estServiceGroupe?: boolean;
  } | {
      G: Room;
      N: string;
  } | {
      G: Group;
  } | {
      G: Teacher;
  } | {
      G: Personal;
  }))[]
- _T: 24
N: string
P: number
Optional Statut?: string
Optional cahierDeTextes?: PronoteValue<24, {
N: string;
estDevoir?: boolean;
}>
Defined if AvecCdT is true. Contains the ID of the item in the PronoteApiUserResources.ListeCahierDeTextes array.
Optional dispenseEleve?: boolean
duree: number
Optional estAnnule?: boolean
Whether the lesson is canceled or not.
Optional estPermanence?: boolean
Optional estRetenue?: undefined
Optional estSortiePedagogique?: false
Optional listeVisios?: {
    V: {
        url: string;
    }[];
}
- V: {
  url: string;
  }[]
Optional memo?: string
place: number

Type declaration

CouleurFond: string
Background color for the subject, in HEX format.
Example
```
"#ffffff"
```
DateDuCours: PronoteValue<DateTime, string>
N: string
accompagnateurs: string[]
Array of the names of the teachers who are going to the outing.
Example
```
["LACAZE H.", "FAVIER É."]
```
duree: number
dureeReelle: number
Optional estRetenue?: undefined
estSortiePedagogique: true
Optional memo?: string
motif: string
Educational activity title, name or description.
Example
```
"Sortie pédagogique"
```
numeroSemaine: number
place: number
placeReelle: number
Optional pourAcc?: boolean
strDateDebut: string
Optional strDateFin?: string
strGenreRess: string
Type of the ressource given in strRess.
Example
```
"Classe"
```

strRess: string

Resource.

Example

"5D" // where `5D` is a ressource from type "Classe".

Type declaration

DateDuCours: PronoteValue<DateTime, string>
ListeContenus: PronoteValue<Element, ({
    L: string;
} & ({
    estHoraire: boolean;
} | {
    G: Room;
} | {
    G: Teacher;
} | {
    G: Personal;
}))[]>
N: string
duree: number
estRetenue: "eleve"
Optional estSortiePedagogique?: false
hintRealise: "Programmée"
imgRealise: "RealiseProgramme"
numeroSemaine: number
place: number

`Private` `Optional` `Readonly` #lessonResourceID

#lessonResourceID?: string

`Private` `Optional` `Readonly` #notes

#notes?: string

`Private` `Readonly` #personalNames

#personalNames: string[] = []

`Private` `Readonly` #startDate

#startDate: Date

`Private` `Optional` `Readonly` #status

#status?: string

`Private` `Optional` `Readonly` #subject

#subject?: StudentSubject

`Private` `Readonly` #teacherNames

#teacherNames: string[] = []

`Private` `Readonly` #test

#test: boolean

`Private` `Readonly` #virtualClassrooms

#virtualClassrooms: string[] = []

Accessors

backgroundColor

get backgroundColor(): undefined | string
Returns undefined | string
Inherited from TimetableItem.backgroundColor
- Defined in parser/timetableLesson.ts:22

blockLength

get blockLength(): number
Returns number
Inherited from TimetableItem.blockLength
- Defined in parser/timetableLesson.ts:37

blockPosition

get blockPosition(): number
Returns number
Inherited from TimetableItem.blockPosition
- Defined in parser/timetableLesson.ts:42

canceled

get canceled(): boolean
Whether this lesson has been canceled or not.

Returns boolean
- Defined in parser/timetableLesson.ts:278

classrooms

get classrooms(): string[]
List of classrooms.

Returns string[]
- Defined in parser/timetableLesson.ts:318

endDate

get endDate(): Date
Returns Date
Inherited from TimetableItem.endDate
- Defined in parser/timetableLesson.ts:32

exempted

get exempted(): boolean
Whether the user is exempted from this lesson or not.

Returns boolean
- Defined in parser/timetableLesson.ts:285

genre

get genre(): PronoteApiLessonStatusType
Returns PronoteApiLessonStatusType
- Defined in parser/timetableLesson.ts:264

groupNames

get groupNames(): string[]
List of group names.

Returns string[]
- Defined in parser/timetableLesson.ts:325

id

get id(): string
Returns string
Inherited from TimetableItem.id
- Defined in parser/timetableLesson.ts:17

lessonResourceID

get lessonResourceID(): undefined | string
Returns undefined when there's no resource attached to this lesson. Otherwise, it'll return an ID that can be used in Pronote#getLessonResource method.

A shortcut for this is to use the getResource method in this class.

Returns undefined | string
- Defined in parser/timetableLesson.ts:342

notes

get notes(): undefined | string
Returns undefined | string
Inherited from TimetableItem.notes
- Defined in parser/timetableLesson.ts:47

personalNames

get personalNames(): string[]
List of personal names.

Returns string[]
- Defined in parser/timetableLesson.ts:304

startDate

get startDate(): Date
Returns Date
Inherited from TimetableItem.startDate
- Defined in parser/timetableLesson.ts:27

status

get status(): undefined | string
Returns undefined | string
Example
```
"Classe absente"
```
- Defined in parser/timetableLesson.ts:271

subject

get subject(): undefined | StudentSubject
Subject of the lesson.

Returns undefined | StudentSubject
- Defined in parser/timetableLesson.ts:332

teacherNames

get teacherNames(): string[]
List of teacher names.

Returns string[]
- Defined in parser/timetableLesson.ts:311

test

get test(): boolean
If there will be a test in the lesson.

Returns boolean
- Defined in parser/timetableLesson.ts:290

virtualClassrooms

get virtualClassrooms(): string[]
List of URLs for virtual classrooms.

Returns string[]
- Defined in parser/timetableLesson.ts:297

Methods

getResource

getResource(): Promise<undefined | StudentLessonResource>
Returns Promise<undefined | StudentLessonResource>
- Defined in parser/timetableLesson.ts:259

isActivity

isActivity(): this is TimetableActivity
Returns this is TimetableActivity
Inherited from TimetableItem.isActivity
- Defined in parser/timetableLesson.ts:81

isDetention

isDetention(): this is TimetableDetention
Returns this is TimetableDetention
Inherited from TimetableItem.isDetention
- Defined in parser/timetableLesson.ts:85

isLesson

isLesson(): this is TimetableLesson
Returns this is TimetableLesson
Inherited from TimetableItem.isLesson
- Defined in parser/timetableLesson.ts:89

Class TimetableLesson

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns TimetableLesson

Properties

Private Optional Readonly #backgroundColor

Private Readonly #blockLength

Private Readonly #blockPosition

Private Readonly #canceled

Private Readonly #classrooms

Private Readonly #client

Private Readonly #endDate

Private Readonly #exempted

Private Readonly #genre

Private Readonly #groupNames

Private Readonly #id

Private Readonly #item

Type declaration

Optional AvecCdT?: boolean

AvecTafPublie: boolean

Optional CouleurFond?: string

DateDuCours: PronoteValue<DateTime, string>

Optional DateDuCoursFin?: PronoteValue<DateTime, string>

G: PronoteApiLessonStatusType

ListeContenus: { V: ({ L: string; } & ({ G: Subject; N: string; estServiceGroupe?: boolean; } | { G: Room; N: string; } | { G: Group; } | { G: Teacher; } | { G: Personal; }))[]; _T: 24; }

V: ({ L: string; } & ({ G: Subject; N: string; estServiceGroupe?: boolean; } | { G: Room; N: string; } | { G: Group; } | { G: Teacher; } | { G: Personal; }))[]

_T: 24

N: string

P: number

Optional Statut?: string

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

Optional dispenseEleve?: boolean

duree: number

Optional estAnnule?: boolean

Optional estPermanence?: boolean

Optional estRetenue?: undefined

Optional estSortiePedagogique?: false

Optional listeVisios?: { V: { url: string; }[]; }

V: { url: string; }[]

Optional memo?: string

place: number

Type declaration

CouleurFond: string

Example

DateDuCours: PronoteValue<DateTime, string>

N: string

accompagnateurs: string[]

Example

duree: number

dureeReelle: number

Optional estRetenue?: undefined

estSortiePedagogique: true

Optional memo?: string

motif: string

Example

numeroSemaine: number

place: number

placeReelle: number

Optional pourAcc?: boolean

strDateDebut: string

Optional strDateFin?: string

strGenreRess: string

Example

strRess: string

Example

Type declaration

DateDuCours: PronoteValue<DateTime, string>

ListeContenus: PronoteValue<Element, ({ L: string; } & ({ estHoraire: boolean; } | { G: Room; } | { G: Teacher; } | { G: Personal; }))[]>

N: string

duree: number

estRetenue: "eleve"

Optional estSortiePedagogique?: false

hintRealise: "Programmée"

`Private` `Optional` `Readonly` #backgroundColor

`Private` `Readonly` #blockLength

`Private` `Readonly` #blockPosition

`Private` `Readonly` #canceled

`Private` `Readonly` #classrooms

`Private` `Readonly` #client

`Private` `Readonly` #endDate

`Private` `Readonly` #exempted

`Private` `Readonly` #genre

`Private` `Readonly` #groupNames

`Private` `Readonly` #id

`Private` `Readonly` #item

`Optional` AvecCdT?: boolean

`Optional` CouleurFond?: string

`Optional` DateDuCoursFin?: PronoteValue<DateTime, string>

ListeContenus: {
V: ({
L: string;
} & ({
G: Subject;
N: string;
estServiceGroupe?: boolean;
} | {
G: Room;
N: string;
} | {
G: Group;
} | {
G: Teacher;
} | {
G: Personal;
}))[];
_T: 24;
}

V: ({
L: string;
} & ({
G: Subject;
N: string;
estServiceGroupe?: boolean;
} | {
G: Room;
N: string;
} | {
G: Group;
} | {
G: Teacher;
} | {
G: Personal;
}))[]

`Optional` Statut?: string

`Optional` cahierDeTextes?: PronoteValue<24, {
N: string;
estDevoir?: boolean;
}>

`Optional` dispenseEleve?: boolean

`Optional` estAnnule?: boolean

`Optional` estPermanence?: boolean

`Optional` estRetenue?: undefined

`Optional` estSortiePedagogique?: false

`Optional` listeVisios?: {
V: {
url: string;
}[];
}

V: {
url: string;
}[]

`Optional` memo?: string

`Optional` estRetenue?: undefined

`Optional` memo?: string

`Optional` pourAcc?: boolean

`Optional` strDateFin?: string

ListeContenus: PronoteValue<Element, ({
L: string;
} & ({
estHoraire: boolean;
} | {
G: Room;
} | {
G: Teacher;
} | {
G: Personal;
}))[]>

`Optional` estSortiePedagogique?: false

`Private` `Optional` `Readonly` #lessonResourceID

`Private` `Optional` `Readonly` #notes

`Private` `Readonly` #personalNames

`Private` `Readonly` #startDate

`Private` `Optional` `Readonly` #status

`Private` `Optional` `Readonly` #subject

`Private` `Readonly` #teacherNames

`Private` `Readonly` #test

`Private` `Readonly` #virtualClassrooms