Class StudentDiscussion

Constructors

constructor

new StudentDiscussion(client, data, discussionsOverview): StudentDiscussion
Parameters
- client: Pronote
- data: (() => {
      N: string;
      avecModifObjet?: boolean;
      avecReponse?: boolean;
      dernierPossessionMessage?: {
          V: {
              N: string;
          };
          _T: number;
      };
      estNonPossede: boolean;
      estUneDiscussion?: boolean;
      fermable?: boolean;
      ferme?: boolean;
      indicePere?: number;
      initiateur?: string;
      libelleDate?: string;
      listeEtiquettes?: PronoteValue<24, {
          N: string;
      }[]>;
      listePossessionsMessages: {
          V: {
              N: string;
          }[];
          _T: number;
      };
      lu?: boolean;
      messageFenetre?: {
          V: {
              G: number;
              N: string;
          };
          _T: number;
      };
      messagePourParticipants?: {
          V: {
              N: string;
          };
          _T: number;
      };
      nbBrouillons?: number;
      nbNonLus?: number;
      nbPublic?: number;
      nombreMessages?: number;
      objet?: string;
      profondeur: number;
      public?: string;
  })
  - - (): {
          N: string;
          avecModifObjet?: boolean;
          avecReponse?: boolean;
          dernierPossessionMessage?: {
              V: {
                  N: string;
              };
              _T: number;
          };
          estNonPossede: boolean;
          estUneDiscussion?: boolean;
          fermable?: boolean;
          ferme?: boolean;
          indicePere?: number;
          initiateur?: string;
          libelleDate?: string;
          listeEtiquettes?: PronoteValue<24, {
              N: string;
          }[]>;
          listePossessionsMessages: {
              V: {
                  N: string;
              }[];
              _T: number;
          };
          lu?: boolean;
          messageFenetre?: {
              V: {
                  G: number;
                  N: string;
              };
              _T: number;
          };
          messagePourParticipants?: {
              V: {
                  N: string;
              };
              _T: number;
          };
          nbBrouillons?: number;
          nbNonLus?: number;
          nbPublic?: number;
          nombreMessages?: number;
          objet?: string;
          profondeur: number;
          public?: string;
      }
    - Returns {
          N: string;
          avecModifObjet?: boolean;
          avecReponse?: boolean;
          dernierPossessionMessage?: {
              V: {
                  N: string;
              };
              _T: number;
          };
          estNonPossede: boolean;
          estUneDiscussion?: boolean;
          fermable?: boolean;
          ferme?: boolean;
          indicePere?: number;
          initiateur?: string;
          libelleDate?: string;
          listeEtiquettes?: PronoteValue<24, {
              N: string;
          }[]>;
          listePossessionsMessages: {
              V: {
                  N: string;
              }[];
              _T: number;
          };
          lu?: boolean;
          messageFenetre?: {
              V: {
                  G: number;
                  N: string;
              };
              _T: number;
          };
          messagePourParticipants?: {
              V: {
                  N: string;
              };
              _T: number;
          };
          nbBrouillons?: number;
          nbNonLus?: number;
          nbPublic?: number;
          nombreMessages?: number;
          objet?: string;
          profondeur: number;
          public?: string;
      }
      N: string
      Optional avecModifObjet?: boolean
      Optional avecReponse?: boolean
      Optional dernierPossessionMessage?: {
          V: {
              N: string;
          };
          _T: number;
      }
      V: {
          N: string;
      }
      N: string
      _T: number
      estNonPossede: boolean
      Optional estUneDiscussion?: boolean
      Optional fermable?: boolean
      Optional ferme?: boolean
      Optional indicePere?: number
      Optional initiateur?: string
      Optional libelleDate?: string
      Optional listeEtiquettes?: PronoteValue<24, {
          N: string;
      }[]>
      Only available if the item has been moved to another folder(s), see listeEtiquettes.
      
      listePossessionsMessages: {
          V: {
              N: string;
          }[];
          _T: number;
      }
      V: {
          N: string;
      }[]
      _T: number
      Optional lu?: boolean
      Optional messageFenetre?: {
          V: {
              G: number;
              N: string;
          };
          _T: number;
      }
      V: {
          G: number;
          N: string;
      }
      G: number
      N: string
      _T: number
      Optional messagePourParticipants?: {
          V: {
              N: string;
          };
          _T: number;
      }
      V: {
          N: string;
      }
      N: string
      _T: number
      Optional nbBrouillons?: number
      Optional nbNonLus?: number
      Optional nbPublic?: number
      Optional nombreMessages?: number
      Optional objet?: string
      profondeur: number
      Optional public?: string
- discussionsOverview: StudentDiscussionsOverview
Returns StudentDiscussion
- Defined in parser/discussion.ts:138

Properties

`Private` `Readonly` #client

#client: Pronote

`Private` `Readonly` #creator

#creator: string

`Private` `Readonly` #dateAsFrenchText

#dateAsFrenchText: string

`Private` `Readonly` #discussionsOverview

#discussionsOverview: StudentDiscussionsOverview

`Private` `Readonly` #participantsMessageID

#participantsMessageID: string

`Private` #permanentlyDeleted

#permanentlyDeleted: boolean = false

`Private` `Readonly` #readData

#readData: (() => {
    N: string;
    avecModifObjet?: boolean;
    avecReponse?: boolean;
    dernierPossessionMessage?: {
        V: {
            N: string;
        };
        _T: number;
    };
    estNonPossede: boolean;
    estUneDiscussion?: boolean;
    fermable?: boolean;
    ferme?: boolean;
    indicePere?: number;
    initiateur?: string;
    libelleDate?: string;
    listeEtiquettes?: PronoteValue<24, {
        N: string;
    }[]>;
    listePossessionsMessages: {
        V: {
            N: string;
        }[];
        _T: number;
    };
    lu?: boolean;
    messageFenetre?: {
        V: {
            G: number;
            N: string;
        };
        _T: number;
    };
    messagePourParticipants?: {
        V: {
            N: string;
        };
        _T: number;
    };
    nbBrouillons?: number;
    nbNonLus?: number;
    nbPublic?: number;
    nombreMessages?: number;
    objet?: string;
    profondeur: number;
    public?: string;
})

Type declaration

- (): {
      N: string;
      avecModifObjet?: boolean;
      avecReponse?: boolean;
      dernierPossessionMessage?: {
          V: {
              N: string;
          };
          _T: number;
      };
      estNonPossede: boolean;
      estUneDiscussion?: boolean;
      fermable?: boolean;
      ferme?: boolean;
      indicePere?: number;
      initiateur?: string;
      libelleDate?: string;
      listeEtiquettes?: PronoteValue<24, {
          N: string;
      }[]>;
      listePossessionsMessages: {
          V: {
              N: string;
          }[];
          _T: number;
      };
      lu?: boolean;
      messageFenetre?: {
          V: {
              G: number;
              N: string;
          };
          _T: number;
      };
      messagePourParticipants?: {
          V: {
              N: string;
          };
          _T: number;
      };
      nbBrouillons?: number;
      nbNonLus?: number;
      nbPublic?: number;
      nombreMessages?: number;
      objet?: string;
      profondeur: number;
      public?: string;
  }
- Returns {
      N: string;
      avecModifObjet?: boolean;
      avecReponse?: boolean;
      dernierPossessionMessage?: {
          V: {
              N: string;
          };
          _T: number;
      };
      estNonPossede: boolean;
      estUneDiscussion?: boolean;
      fermable?: boolean;
      ferme?: boolean;
      indicePere?: number;
      initiateur?: string;
      libelleDate?: string;
      listeEtiquettes?: PronoteValue<24, {
          N: string;
      }[]>;
      listePossessionsMessages: {
          V: {
              N: string;
          }[];
          _T: number;
      };
      lu?: boolean;
      messageFenetre?: {
          V: {
              G: number;
              N: string;
          };
          _T: number;
      };
      messagePourParticipants?: {
          V: {
              N: string;
          };
          _T: number;
      };
      nbBrouillons?: number;
      nbNonLus?: number;
      nbPublic?: number;
      nombreMessages?: number;
      objet?: string;
      profondeur: number;
      public?: string;
  }
  - N: string
  - Optional avecModifObjet?: boolean
  - Optional avecReponse?: boolean
  - Optional dernierPossessionMessage?: {
        V: {
            N: string;
        };
        _T: number;
    }
    - V: {
      N: string;
      }
      - N: string
    - _T: number
  - estNonPossede: boolean
  - Optional estUneDiscussion?: boolean
  - Optional fermable?: boolean
  - Optional ferme?: boolean
  - Optional indicePere?: number
  - Optional initiateur?: string
  - Optional libelleDate?: string
  - Optional listeEtiquettes?: PronoteValue<24, {
    N: string;
    }[]>
    Only available if the item has been moved to another folder(s), see listeEtiquettes.
  - listePossessionsMessages: {
        V: {
            N: string;
        }[];
        _T: number;
    }
    - V: {
      N: string;
      }[]
    - _T: number
  - Optional lu?: boolean
  - Optional messageFenetre?: {
        V: {
            G: number;
            N: string;
        };
        _T: number;
    }
    - V: {
      G: number;
      N: string;
      }
      - G: number
      - N: string
    - _T: number
  - Optional messagePourParticipants?: {
        V: {
            N: string;
        };
        _T: number;
    }
    - V: {
      N: string;
      }
      - N: string
    - _T: number
  - Optional nbBrouillons?: number
  - Optional nbNonLus?: number
  - Optional nbPublic?: number
  - Optional nombreMessages?: number
  - Optional objet?: string
  - profondeur: number
  - Optional public?: string

`Private` `Optional` `Readonly` #recipientName

#recipientName?: string

Accessors

closed

get closed(): boolean
Returns boolean
- Defined in parser/discussion.ts:289

creator

get creator(): string
Returns string
- Defined in parser/discussion.ts:284

dateAsFrenchText

get dateAsFrenchText(): string
Output is very variable, see example below. Because of this behavior, we can't transform this into a date. Maybe, we could parse this manually, but it's not a priority. TODO: Parse this manually.

Returns string
Example
```
"lundi 08h53"
// or can just be the hour
"07h26"
```
- Defined in parser/discussion.ts:259

deleted

get deleted(): boolean
When true, you won't be able to access any other property (except participantsMessageID) of this instance anymore.

Returns boolean
- Defined in parser/discussion.ts:232

folders

get folders(): StudentDiscussionFolder[]
Returns StudentDiscussionFolder[]
- Defined in parser/discussion.ts:293

numberOfDrafts

get numberOfDrafts(): number
Returns number
- Defined in parser/discussion.ts:244

numberOfMessages

get numberOfMessages(): number
Returns number
- Defined in parser/discussion.ts:276

numberOfMessagesUnread

get numberOfMessagesUnread(): number
Returns number
- Defined in parser/discussion.ts:280

participantsMessageID

get participantsMessageID(): string
Internal string containing the ID of the message needed to fetch the participants of the discussion.

Returns string
- Defined in parser/discussion.ts:301

possessions

get possessions(): {
N: string;
}[]
Property used internally to make the messages in discussion request.

Returns {
N: string;
}[]
- Defined in parser/discussion.ts:240

recipientName

get recipientName(): undefined | string
Returns undefined | string
- Defined in parser/discussion.ts:271

subject

get subject(): string
Title of the discussion.

Returns string
- Defined in parser/discussion.ts:267

Methods

`Private` #assertNotDeleted

#assertNotDeleted(): void
Returns void
- Defined in parser/discussion.ts:127

deletePermanently

deletePermanently(): Promise<void>
Returns Promise<void>
- Defined in parser/discussion.ts:216

fetchMessagesOverview

fetchMessagesOverview(markAsRead?, limit?): Promise<MessagesOverview>
Fetches the messages from the discussion. By default it won't mark the messages as read even after fetching them.

You can change this behavior by setting markAsRead to true. There's no other way to mark the messages as read.
Parameters
- markAsRead: boolean = false
  Whether to mark the messages as read after fetching them.
- limit: number = 0
  0 = no limit, fetch all messages.
Returns Promise<MessagesOverview>
- Defined in parser/discussion.ts:172

fetchRecipients

fetchRecipients(): Promise<FetchedMessageRecipient[]>
Fetches the recipients of the discussion. A recipient is someone who is part of the discussion. They don't have to send a message to be considered as a recipient.

Returns Promise<FetchedMessageRecipient[]>
- Defined in parser/discussion.ts:189

markAsRead

markAsRead(): Promise<void>
Marks the discussion as read.

Returns Promise<void>
Remark
This function is a shortcut to fetchMessages(true) but here we don't return anything.
- Defined in parser/discussion.ts:180

moveToTrash

moveToTrash(): Promise<void>
Returns Promise<void>
- Defined in parser/discussion.ts:194

refetch

refetch(): Promise<void>
Returns Promise<void>
- Defined in parser/discussion.ts:133

restoreFromTrash

restoreFromTrash(): Promise<void>
Returns Promise<void>
- Defined in parser/discussion.ts:205

Class StudentDiscussion

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

N: string

Optional avecModifObjet?: boolean

Optional avecReponse?: boolean

Optional dernierPossessionMessage?: { V: { N: string; }; _T: number; }

V: { N: string; }

N: string

_T: number

estNonPossede: boolean

Optional estUneDiscussion?: boolean

Optional fermable?: boolean

Optional ferme?: boolean

Optional indicePere?: number

Optional initiateur?: string

Optional libelleDate?: string

Optional listeEtiquettes?: PronoteValue<24, { N: string; }[]>

listePossessionsMessages: { V: { N: string; }[]; _T: number; }

V: { N: string; }[]

_T: number

Optional lu?: boolean

Optional messageFenetre?: { V: { G: number; N: string; }; _T: number; }

V: { G: number; N: string; }

G: number

N: string

_T: number

Optional messagePourParticipants?: { V: { N: string; }; _T: number; }

V: { N: string; }

N: string

_T: number

Optional nbBrouillons?: number

Optional nbNonLus?: number

Optional nbPublic?: number

Optional nombreMessages?: number

Optional objet?: string

profondeur: number

Optional public?: string

Returns StudentDiscussion

Properties

Private Readonly #client

Private Readonly #creator

Private Readonly #dateAsFrenchText

Private Readonly #discussionsOverview

Private Readonly #participantsMessageID

Private #permanentlyDeleted

Private Readonly #readData

Type declaration

N: string

Optional avecModifObjet?: boolean

Optional avecReponse?: boolean

Optional dernierPossessionMessage?: { V: { N: string; }; _T: number; }

V: { N: string; }

N: string

_T: number

estNonPossede: boolean

Optional estUneDiscussion?: boolean

Optional fermable?: boolean

Optional ferme?: boolean

Optional indicePere?: number

Optional initiateur?: string

Optional libelleDate?: string

Optional listeEtiquettes?: PronoteValue<24, { N: string; }[]>

listePossessionsMessages: { V: { N: string; }[]; _T: number; }

V: { N: string; }[]

_T: number

Optional lu?: boolean

Optional messageFenetre?: { V: { G: number; N: string; }; _T: number; }

V: { G: number; N: string; }

G: number

N: string

_T: number

Optional messagePourParticipants?: { V: { N: string; }; _T: number; }

V: { N: string; }

`Optional` avecModifObjet?: boolean

`Optional` avecReponse?: boolean

`Optional` dernierPossessionMessage?: {
V: {
N: string;
};
_T: number;
}

V: {
N: string;
}

`Optional` estUneDiscussion?: boolean

`Optional` fermable?: boolean

`Optional` ferme?: boolean

`Optional` indicePere?: number

`Optional` initiateur?: string

`Optional` libelleDate?: string

`Optional` listeEtiquettes?: PronoteValue<24, {
N: string;
}[]>

listePossessionsMessages: {
V: {
N: string;
}[];
_T: number;
}

V: {
N: string;
}[]

`Optional` lu?: boolean

`Optional` messageFenetre?: {
V: {
G: number;
N: string;
};
_T: number;
}

V: {
G: number;
N: string;
}

`Optional` messagePourParticipants?: {
V: {
N: string;
};
_T: number;
}

V: {
N: string;
}

`Optional` nbBrouillons?: number

`Optional` nbNonLus?: number

`Optional` nbPublic?: number

`Optional` nombreMessages?: number

`Optional` objet?: string

`Optional` public?: string

`Private` `Readonly` #client

`Private` `Readonly` #creator

`Private` `Readonly` #dateAsFrenchText

`Private` `Readonly` #discussionsOverview

`Private` `Readonly` #participantsMessageID

`Private` #permanentlyDeleted

`Private` `Readonly` #readData

`Optional` avecModifObjet?: boolean

`Optional` avecReponse?: boolean

`Optional` dernierPossessionMessage?: {
V: {
N: string;
};
_T: number;
}

V: {
N: string;
}

`Optional` estUneDiscussion?: boolean

`Optional` fermable?: boolean

`Optional` ferme?: boolean

`Optional` indicePere?: number

`Optional` initiateur?: string

`Optional` libelleDate?: string

`Optional` listeEtiquettes?: PronoteValue<24, {
N: string;
}[]>

listePossessionsMessages: {
V: {
N: string;
}[];
_T: number;
}

V: {
N: string;
}[]

`Optional` lu?: boolean

`Optional` messageFenetre?: {
V: {
G: number;
N: string;
};
_T: number;
}

V: {
G: number;
N: string;
}

`Optional` messagePourParticipants?: {
V: {
N: string;
};
_T: number;
}

V: {
N: string;
}

`Optional` nbBrouillons?: number

`Optional` nbNonLus?: number

`Optional` nbPublic?: number

`Optional` nombreMessages?: number

`Optional` objet?: string

`Optional` public?: string

`Private` `Optional` `Readonly` #recipientName

Returns {
N: string;
}[]

`Private` #assertNotDeleted